Category: Guides Page 2 | Categories

The Guides category provides practical, step-by-step instructions for accomplishing specific tasks with Geode graph database. From basic operations to advanced workflows, these guides help you implement solutions efficiently and correctly. <h3 id="introduction-to-geode-guides" class="position-relative d-flex align-items-center group"> Introduction to Geode Guides <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="introduction-to-geode-guides" aria-haspopup="dialog" aria-label="Share link: Introduction to Geode Guides"> Share link </button> </h3><div id="headingShareModal" class="heading-share-modal" role="dialog" aria-modal="true" aria-labelledby="headingShareTitle" hidden> <div class="hsm-dialog" role="document"> <div class="hsm-header"> <h2 id="headingShareTitle" class="h6 mb-0 fw-bold">Share this section</h2> <button type="button" class="hsm-close" aria-label="Close"> </button> </div> <div class="hsm-body"> <label for="headingShareInput" class="form-label small text-muted mb-1 text-uppercase fw-bold" style="font-size: 0.7rem; letter-spacing: 0.5px;">Permalink</label> <div class="input-group mb-4 hsm-url-group"> <input id="headingShareInput" type="text" class="form-control font-monospace" readonly aria-readonly="true" style="font-size: 0.85rem;" /> <button class="btn btn-primary hsm-copy" type="button" aria-label="Copy" title="Copy"> </button> </div> <div class="small fw-bold mb-2 text-muted text-uppercase" style="font-size: 0.7rem; letter-spacing: 0.5px;">Share via</div> <div class="hsm-share-grid"> <a id="share-twitter" class="btn btn-outline-secondary w-100" target="_blank" rel="noopener noreferrer"> Twitter </a> <a id="share-linkedin" class="btn btn-outline-secondary w-100" target="_blank" rel="noopener noreferrer"> LinkedIn </a> <a id="share-facebook" class="btn btn-outline-secondary w-100" target="_blank" rel="noopener noreferrer"> Facebook </a> </div> </div> </div> </div> <style> .heading-share-modal { position: fixed; inset: 0; display: flex; justify-content: center; align-items: center; background: rgba(0, 0, 0, 0.6); z-index: 1050; padding: 1rem; backdrop-filter: blur(4px); -webkit-backdrop-filter: blur(4px); } .heading-share-modal[hidden] { display: none !important; } .hsm-dialog { max-width: 420px; width: 100%; background: var(--bs-body-bg, #fff); color: var(--bs-body-color, #212529); border: 1px solid var(--bs-border-color, rgba(0,0,0,0.1)); border-radius: 1rem; box-shadow: 0 25px 50px -12px rgba(0, 0, 0, 0.25); overflow: hidden; animation: hsm-fade-in 0.2s ease-out; } @keyframes hsm-fade-in { from { opacity: 0; transform: scale(0.95); } to { opacity: 1; transform: scale(1); } } [data-bs-theme="dark"] .hsm-dialog { background: #1e293b; border-color: rgba(255,255,255,0.1); color: #f8f9fa; } .hsm-header { display: flex; justify-content: space-between; align-items: center; padding: 1rem 1.5rem; border-bottom: 1px solid var(--bs-border-color, rgba(0,0,0,0.1)); background: rgba(0,0,0,0.02); } [data-bs-theme="dark"] .hsm-header { background: rgba(255,255,255,0.02); border-color: rgba(255,255,255,0.1); } .hsm-close { background: transparent; border: none; color: inherit; opacity: 0.5; padding: 0.25rem 0.5rem; border-radius: 0.25rem; font-size: 1.2rem; line-height: 1; transition: opacity 0.2s; } .hsm-close:hover { opacity: 1; } .hsm-body { padding: 1.5rem; } .hsm-url-group { display: flex !important; align-items: stretch; } .hsm-url-group .form-control { flex: 1; min-width: 0; margin: 0; background: var(--bs-secondary-bg, #f8f9fa); border-color: var(--bs-border-color, #dee2e6); border-top-right-radius: 0; border-bottom-right-radius: 0; height: 42px; } .hsm-url-group .btn { flex: 0 0 auto; margin: 0; margin-left: -1px; border-top-left-radius: 0; border-bottom-left-radius: 0; height: 42px; display: flex; align-items: center; justify-content: center; padding: 0 1.25rem; z-index: 2; } [data-bs-theme="dark"] .hsm-url-group .form-control { background: #0f172a; border-color: #334155; color: #e2e8f0; } .hsm-share-grid { display: flex; flex-direction: column; gap: 0.5rem; } .hsm-share-grid .btn { display: flex; align-items: center; justify-content: center; font-size: 0.9rem; padding: 0.6rem; border-color: var(--bs-border-color); width: 100%; } [data-bs-theme="dark"] .hsm-share-grid .btn { color: #e2e8f0; border-color: #475569; } [data-bs-theme="dark"] .hsm-share-grid .btn:hover { background: #334155; border-color: #cbd5e1; } </style> <script> (function(){ const modal = document.getElementById('headingShareModal'); if(!modal) return; const input = modal.querySelector('#headingShareInput'); const copyBtn = modal.querySelector('.hsm-copy'); const twitter = modal.querySelector('#share-twitter'); const linkedin = modal.querySelector('#share-linkedin'); const facebook = modal.querySelector('#share-facebook'); const closeBtn = modal.querySelector('.hsm-close'); let lastFocus=null; let trapBound=false; function buildUrl(id){ return window.location.origin + window.location.pathname + '#' + id; } function isOpen(){ return !modal.hasAttribute('hidden'); } function hydrate(id){ const url=buildUrl(id); input.value=url; const enc=encodeURIComponent(url); const text=encodeURIComponent(document.title); if(twitter) twitter.href=`https://twitter.com/intent/tweet?url=${enc}&text=${text}`; if(linkedin) linkedin.href=`https://www.linkedin.com/sharing/share-offsite/?url=${enc}`; if(facebook) facebook.href=`https://www.facebook.com/sharer/sharer.php?u=${enc}`; } function openModal(id){ lastFocus=document.activeElement; hydrate(id); if(!isOpen()){ modal.removeAttribute('hidden'); } requestAnimationFrame(()=>{ input.focus(); }); trapFocus(); } function closeModal(){ if(!isOpen()) return; modal.setAttribute('hidden',''); if(lastFocus && typeof lastFocus.focus==='function') lastFocus.focus(); } function copyCurrent(){ try{ navigator.clipboard.writeText(input.value).then(()=>feedback(true),()=>fallback()); } catch(e){ fallback(); } } function fallback(){ input.select(); try{ document.execCommand('copy'); feedback(true);}catch(e){ feedback(false);} } function feedback(ok){ if(!copyBtn) return; const icon=copyBtn.querySelector('i'); if(!icon) return; const prev=copyBtn.getAttribute('data-prev')||icon.className; if(!copyBtn.getAttribute('data-prev')) copyBtn.setAttribute('data-prev',prev); icon.className= ok ? 'fa-duotone fa-clipboard-check':'fa-duotone fa-circle-exclamation'; setTimeout(()=>{ icon.className=prev; },1800); } function handleShareClick(e){ e.preventDefault(); const btn=e.currentTarget; const id=btn.getAttribute('data-share-target'); if(id) openModal(id); } function bindShareButtons(){ document.querySelectorAll('.h-share').forEach(btn=>{ if(!btn.dataset.hShareBound){ btn.addEventListener('click', handleShareClick); btn.dataset.hShareBound='1'; } }); } bindShareButtons(); if(document.readyState==='loading'){ document.addEventListener('DOMContentLoaded', bindShareButtons); } else { requestAnimationFrame(bindShareButtons); } document.addEventListener('click', function(e){ const shareBtn=e.target.closest && e.target.closest('.h-share'); if(shareBtn && !shareBtn.dataset.hShareBound){ handleShareClick.call(shareBtn, e); } }, true); document.addEventListener('click', e=>{ if(e.target===modal) closeModal(); if(e.target.closest && e.target.closest('.hsm-close')){ e.preventDefault(); closeModal(); } if(copyBtn && (e.target===copyBtn || (e.target.closest && e.target.closest('.hsm-copy')))) { e.preventDefault(); copyCurrent(); } }); document.addEventListener('keydown', e=>{ if(e.key==='Escape' && isOpen()) closeModal(); }); function trapFocus(){ if(trapBound) return; trapBound=true; modal.addEventListener('keydown', f=>{ if(f.key==='Tab' && isOpen()){ const focusable=[...modal.querySelectorAll('a[href],button,input,textarea,select,[tabindex]:not([tabindex="-1"])')].filter(el=>!el.hasAttribute('disabled')); if(!focusable.length) return; const first=focusable[0]; const last=focusable[focusable.length-1]; if(f.shiftKey && document.activeElement===first){ f.preventDefault(); last.focus(); } else if(!f.shiftKey && document.activeElement===last){ f.preventDefault(); first.focus(); } } }); } if(closeBtn) closeBtn.addEventListener('click', e=>{ e.preventDefault(); closeModal(); }); })(); </script>Guides bridge the gap between reference documentation and hands-on tutorials. While reference docs explain what features exist and tutorials teach concepts, guides show you exactly how to accomplish specific tasks. Each guide provides clear steps, code examples, and explanations to help you implement solutions confidently. The Geode guides cover installation, configuration, data modeling, query development, performance optimization, security implementation, deployment, and operational tasks. Whether you’re setting up your first instance or optimizing a production system, these guides provide actionable instructions. <h3 id="installation-and-setup-guides" class="position-relative d-flex align-items-center group"> Installation and Setup Guides <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="installation-and-setup-guides" aria-haspopup="dialog" aria-label="Share link: Installation and Setup Guides"> Share link </button> </h3> <h4 id="installing-geode" class="position-relative d-flex align-items-center group"> Installing Geode <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="installing-geode" aria-haspopup="dialog" aria-label="Share link: Installing Geode"> Share link </button> </h4>Using Docker (recommended for development): <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash"># Pull latest image docker pull codepros/geode:latest # Run with persistent data docker run -d \ --name geode \ -p 3141:3141 \ -v geode-data:/var/lib/geode/data \ -v geode-wal:/var/lib/geode/wal \ codepros/geode:latest # Verify installation docker exec geode geode ping </code></pre></div>Building from Source (Zig 0.1.0+): <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash"># Install Zig curl -L https://ziglang.org/download/0.1.0/zig-linux-x86_64-0.1.0.tar.xz | tar xJ export PATH=$PATH:$(pwd)/zig-linux-x86_64-0.1.0 # Clone and build git clone https://github.com/codeprosorg/geode cd geode make build # Run ./zig-out/bin/geode serve </code></pre></div> <h4 id="configuring-geode" class="position-relative d-flex align-items-center group"> Configuring Geode <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="configuring-geode" aria-haspopup="dialog" aria-label="Share link: Configuring Geode"> Share link </button> </h4>Basic Configuration (<code>geode.toml</code>): <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-toml" data-lang="toml">[server] listen = "0.0.0.0:3141" max_connections = 1000 log_level = "info" [storage] data_dir = "/var/lib/geode/data" wal_dir = "/var/lib/geode/wal" cache_size = "4GB" page_size = 8192 [security] auth_enabled = true tls_cert = "/etc/geode/certs/server.crt" tls_key = "/etc/geode/certs/server.key" [performance] query_cache_size = 10000 connection_pool_size = 500 parallel_workers = 8 </code></pre></div>Start with configuration: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash">geode serve --config /etc/geode/geode.toml </code></pre></div> <h4 id="setting-up-tls" class="position-relative d-flex align-items-center group"> Setting Up TLS <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="setting-up-tls" aria-haspopup="dialog" aria-label="Share link: Setting Up TLS"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash"># Generate self-signed certificate (development only) openssl req -x509 -newkey rsa:4096 \ -keyout server.key -out server.crt \ -days 365 -nodes \ -subj "/CN=localhost" # Or use Let's Encrypt (production) certbot certonly --standalone -d geode.example.com # Configure in geode.toml [security] tls_cert = "/etc/letsencrypt/live/geode.example.com/fullchain.pem" tls_key = "/etc/letsencrypt/live/geode.example.com/privkey.pem" </code></pre></div> <h3 id="data-modeling-guides" class="position-relative d-flex align-items-center group"> Data Modeling Guides <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="data-modeling-guides" aria-haspopup="dialog" aria-label="Share link: Data Modeling Guides"> Share link </button> </h3> <h4 id="designing-your-first-schema" class="position-relative d-flex align-items-center group"> Designing Your First Schema <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="designing-your-first-schema" aria-haspopup="dialog" aria-label="Share link: Designing Your First Schema"> Share link </button> </h4>Step 1: Identify Entities <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">-- In a social network, entities are: -- Users, Posts, Comments, Groups CREATE (alice:User { id: 'user_001', name: 'Alice Anderson', email: 'alice@example.com', joined: datetime('2024-01-15T09:00:00') }); CREATE (post:Post { id: 'post_001', content: 'Hello, Geode!', timestamp: datetime('2024-03-15T10:30:00'), likes: 0 }); </code></pre></div>Step 2: Define Relationships <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">-- Users post content MATCH (u:User {id: 'user_001'}), (p:Post {id: 'post_001'}) CREATE (u)-[:POSTED]->(p); -- Users follow users MATCH (alice:User {id: 'user_001'}), (bob:User {id: 'user_002'}) CREATE (alice)-[:FOLLOWS]->(bob); -- Users like posts MATCH (u:User {id: 'user_002'}), (p:Post {id: 'post_001'}) CREATE (u)-[:LIKED {timestamp: datetime()}]->(p) SET p.likes = p.likes + 1; </code></pre></div>Step 3: Add Indexes <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">-- Unique constraints CREATE CONSTRAINT unique_user_id ON :User(id); CREATE CONSTRAINT unique_user_email ON :User(email); CREATE CONSTRAINT unique_post_id ON :Post(id); -- Performance indexes CREATE INDEX user_name ON :User(name); CREATE INDEX post_timestamp ON :Post(timestamp); </code></pre></div> <h4 id="migrating-from-sql-to-graph" class="position-relative d-flex align-items-center group"> Migrating from SQL to Graph <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="migrating-from-sql-to-graph" aria-haspopup="dialog" aria-label="Share link: Migrating from SQL to Graph"> Share link </button> </h4>SQL Schema: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-sql" data-lang="sql">CREATE TABLE users ( id INT PRIMARY KEY, name VARCHAR(100), email VARCHAR(100) UNIQUE ); CREATE TABLE friendships ( user1_id INT REFERENCES users(id), user2_id INT REFERENCES users(id), since DATE, PRIMARY KEY (user1_id, user2_id) ); </code></pre></div>Equivalent Graph Model: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">-- Users as nodes CREATE (alice:User { id: 1, name: 'Alice', email: 'alice@example.com' }); CREATE (bob:User { id: 2, name: 'Bob', email: 'bob@example.com' }); -- Friendships as relationships MATCH (alice:User {id: 1}), (bob:User {id: 2}) CREATE (alice)-[:FRIENDS_WITH {since: date('2024-01-15')}]->(bob); CREATE (bob)-[:FRIENDS_WITH {since: date('2024-01-15')}]->(alice); </code></pre></div>Advantages: <ul> <li>No junction table needed</li> <li>Bidirectional queries without self-joins</li> <li>Relationship properties directly on edges</li> <li>Variable-depth traversals (friends of friends) are simple</li> </ul> <h3 id="query-development-guides" class="position-relative d-flex align-items-center group"> Query Development Guides <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="query-development-guides" aria-haspopup="dialog" aria-label="Share link: Query Development Guides"> Share link </button> </h3> <h4 id="writing-efficient-queries" class="position-relative d-flex align-items-center group"> Writing Efficient Queries <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="writing-efficient-queries" aria-haspopup="dialog" aria-label="Share link: Writing Efficient Queries"> Share link </button> </h4>Pattern Matching Basics: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">-- Simple pattern MATCH (p:Person {name: 'Alice'}) RETURN p; -- Relationship pattern MATCH (p:Person)-[:KNOWS]->(friend) WHERE p.name = 'Alice' RETURN friend.name; -- Multi-hop pattern MATCH (p:Person {name: 'Alice'})-[:KNOWS*1..3]->(connection) RETURN DISTINCT connection.name; </code></pre></div>Using Indexes Effectively: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">-- Bad: Full scan without index MATCH (p:Person) WHERE p.email = 'alice@example.com' RETURN p; -- Good: Create index first CREATE INDEX person_email ON :Person(email); -- Now query uses index MATCH (p:Person {email: 'alice@example.com'}) RETURN p; -- Verify with EXPLAIN EXPLAIN MATCH (p:Person {email: 'alice@example.com'}) RETURN p; </code></pre></div>Optimizing Aggregations: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">-- Efficient: Push filtering before aggregation MATCH (c:Company)<-[:WORKS_AT]-(e:Employee) WHERE c.industry = 'Technology' RETURN c.name, count(e) as employees ORDER BY employees DESC; -- Inefficient: Aggregate then filter MATCH (c:Company)<-[:WORKS_AT]-(e:Employee) WITH c, count(e) as employees WHERE employees > 100 RETURN c.name, employees; </code></pre></div> <h4 id="implementing-common-patterns" class="position-relative d-flex align-items-center group"> Implementing Common Patterns <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="implementing-common-patterns" aria-haspopup="dialog" aria-label="Share link: Implementing Common Patterns"> Share link </button> </h4>Pagination: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">-- Skip and limit for pagination MATCH (p:Post) RETURN p ORDER BY p.timestamp DESC SKIP 20 LIMIT 10; -- Page 3 (items 21-30) </code></pre></div>Aggregation with Grouping: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">-- Count employees by department MATCH (e:Employee) RETURN e.department, count(e) as count ORDER BY count DESC; -- Average salary by department MATCH (e:Employee) RETURN e.department, avg(e.salary) as avg_salary ORDER BY avg_salary DESC; </code></pre></div>Conditional Logic: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">-- CASE expressions MATCH (e:Employee) RETURN e.name, e.salary, CASE WHEN e.salary > 100000 THEN 'High' WHEN e.salary > 60000 THEN 'Medium' ELSE 'Entry' END as salary_band; </code></pre></div> <h3 id="performance-optimization-guides" class="position-relative d-flex align-items-center group"> Performance Optimization Guides <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="performance-optimization-guides" aria-haspopup="dialog" aria-label="Share link: Performance Optimization Guides"> Share link </button> </h3> <h4 id="profiling-queries" class="position-relative d-flex align-items-center group"> Profiling Queries <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="profiling-queries" aria-haspopup="dialog" aria-label="Share link: Profiling Queries"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">-- Use PROFILE to see actual execution PROFILE MATCH (p:Person)-[:KNOWS*1..3]->(connection) WHERE p.name = 'Alice' RETURN DISTINCT connection.name; -- Analyze output: -- - Rows processed -- - Time spent per operator -- - Index usage -- - Memory consumption </code></pre></div> <h4 id="creating-indexes" class="position-relative d-flex align-items-center group"> Creating Indexes <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="creating-indexes" aria-haspopup="dialog" aria-label="Share link: Creating Indexes"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">-- Single-property index CREATE INDEX person_email ON :Person(email); -- Composite index CREATE INDEX person_location ON :Person(city, state); -- Unique constraint (creates index) CREATE CONSTRAINT unique_user_id ON :User(id); -- Full-text index CREATE FULLTEXT INDEX article_content ON :Article(title, content); -- Vector index for embeddings CREATE VECTOR INDEX doc_embeddings ON :Document(embedding) WITH (dimension: 384, metric: 'cosine'); -- List all indexes SHOW INDEXES; -- Drop index DROP INDEX person_email; </code></pre></div> <h4 id="query-optimization-checklist" class="position-relative d-flex align-items-center group"> Query Optimization Checklist <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="query-optimization-checklist" aria-haspopup="dialog" aria-label="Share link: Query Optimization Checklist"> Share link </button> </h4><ol> <li>Use specific labels: <code>MATCH (p:Person)</code> not <code>MATCH (p)</code></li> <li>Create indexes on frequently queried properties</li> <li>Use parameters instead of string concatenation</li> <li>Limit early with WHERE clauses before aggregation</li> <li>Avoid Cartesian products (multiple MATCH without relationships)</li> <li>Use EXPLAIN/PROFILE to verify query plans</li> </ol> <h3 id="security-implementation-guides" class="position-relative d-flex align-items-center group"> Security Implementation Guides <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="security-implementation-guides" aria-haspopup="dialog" aria-label="Share link: Security Implementation Guides"> Share link </button> </h3> <h4 id="setting-up-authentication" class="position-relative d-flex align-items-center group"> Setting Up Authentication <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="setting-up-authentication" aria-haspopup="dialog" aria-label="Share link: Setting Up Authentication"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash"># Enable authentication in config [security] auth_enabled = true # Create admin user geode user create admin --password 'SecurePassword123' --admin # Create regular users geode user create analyst --password 'UserPass456' </code></pre></div>Connect with authentication: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-python" data-lang="python">from geode_client import Client client = Client( "localhost:3141", username="analyst", password="UserPass456" ) </code></pre></div> <h4 id="implementing-row-level-security" class="position-relative d-flex align-items-center group"> Implementing Row-Level Security <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="implementing-row-level-security" aria-haspopup="dialog" aria-label="Share link: Implementing Row-Level Security"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">-- Create policy: users can only see their own department CREATE POLICY department_access ON :Employee USING (department = current_user_department()); -- Create policy: managers see their reports CREATE POLICY manager_access ON :Employee USING ( id = current_user_id() OR EXISTS ((current_user)-[:MANAGES*]->(this)) ); -- Enable policies ENABLE POLICY department_access ON :Employee; ENABLE POLICY manager_access ON :Employee; -- Now queries automatically filter MATCH (e:Employee) RETURN e; -- Only returns employees user can see </code></pre></div> <h4 id="configuring-encryption" class="position-relative d-flex align-items-center group"> Configuring Encryption <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="configuring-encryption" aria-haspopup="dialog" aria-label="Share link: Configuring Encryption"> Share link </button> </h4>TLS in Transit: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-toml" data-lang="toml">[security] tls_cert = "/etc/geode/certs/server.crt" tls_key = "/etc/geode/certs/server.key" tls_client_auth = false # Set true for mutual TLS </code></pre></div>Encryption at Rest: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-toml" data-lang="toml">[security] encryption_at_rest = true encryption_key_file = "/etc/geode/keys/master.key" </code></pre></div> <h3 id="deployment-guides" class="position-relative d-flex align-items-center group"> Deployment Guides <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="deployment-guides" aria-haspopup="dialog" aria-label="Share link: Deployment Guides"> Share link </button> </h3> <h4 id="docker-deployment" class="position-relative d-flex align-items-center group"> Docker Deployment <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="docker-deployment" aria-haspopup="dialog" aria-label="Share link: Docker Deployment"> Share link </button> </h4>Docker Compose (<code>docker-compose.yml</code>): <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-yaml" data-lang="yaml">version: '3.8' services: geode: image: codepros/geode:latest ports: - "3141:3141" volumes: - geode-data:/var/lib/geode/data - geode-wal:/var/lib/geode/wal - ./config:/etc/geode environment: - GEODE_LOG_LEVEL=info restart: unless-stopped volumes: geode-data: geode-wal: </code></pre></div>Deploy: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash">docker-compose up -d docker-compose logs -f geode </code></pre></div> <h4 id="kubernetes-deployment" class="position-relative d-flex align-items-center group"> Kubernetes Deployment <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="kubernetes-deployment" aria-haspopup="dialog" aria-label="Share link: Kubernetes Deployment"> Share link </button> </h4>StatefulSet (<code>geode-statefulset.yaml</code>): <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-yaml" data-lang="yaml">apiVersion: apps/v1 kind: StatefulSet metadata: name: geode spec: serviceName: geode replicas: 3 selector: matchLabels: app: geode template: metadata: labels: app: geode spec: containers: - name: geode image: codepros/geode:latest ports: - containerPort: 3141 name: client volumeMounts: - name: data mountPath: /var/lib/geode/data - name: wal mountPath: /var/lib/geode/wal volumeClaimTemplates: - metadata: name: data spec: accessModes: ["ReadWriteOnce"] resources: requests: storage: 100Gi - metadata: name: wal spec: accessModes: ["ReadWriteOnce"] resources: requests: storage: 50Gi </code></pre></div>Service (<code>geode-service.yaml</code>): <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-yaml" data-lang="yaml">apiVersion: v1 kind: Service metadata: name: geode spec: selector: app: geode ports: - port: 3141 targetPort: 3141 type: LoadBalancer </code></pre></div>Deploy: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash">kubectl apply -f geode-statefulset.yaml kubectl apply -f geode-service.yaml kubectl get pods -l app=geode </code></pre></div> <h3 id="operational-guides" class="position-relative d-flex align-items-center group"> Operational Guides <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="operational-guides" aria-haspopup="dialog" aria-label="Share link: Operational Guides"> Share link </button> </h3> <h4 id="backup-and-restore" class="position-relative d-flex align-items-center group"> Backup and Restore <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="backup-and-restore" aria-haspopup="dialog" aria-label="Share link: Backup and Restore"> Share link </button> </h4>Create Backup: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash"># Stop writes (optional, for consistency) geode maintenance lock # Backup data directory tar czf geode-backup-$(date +%Y%m%d).tar.gz \ /var/lib/geode/data \ /var/lib/geode/wal # Resume writes geode maintenance unlock # Upload to S3 aws s3 cp geode-backup-$(date +%Y%m%d).tar.gz \ s3://my-backups/geode/ </code></pre></div>Restore from Backup: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash"># Stop Geode systemctl stop geode # Restore data cd /var/lib/geode tar xzf /path/to/geode-backup-20240315.tar.gz # Start Geode systemctl start geode </code></pre></div> <h4 id="monitoring-setup" class="position-relative d-flex align-items-center group"> Monitoring Setup <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="monitoring-setup" aria-haspopup="dialog" aria-label="Share link: Monitoring Setup"> Share link </button> </h4>Prometheus Integration: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-toml" data-lang="toml"># geode.toml [telemetry] prometheus_enabled = true prometheus_port = 9090 </code></pre></div>Prometheus Configuration (<code>prometheus.yml</code>): <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-yaml" data-lang="yaml">scrape_configs: - job_name: 'geode' static_configs: - targets: ['localhost:9090'] </code></pre></div>Key Metrics to Monitor: <ul> <li><code>geode_query_duration_seconds</code> - Query latency</li> <li><code>geode_active_connections</code> - Connection count</li> <li><code>geode_cache_hit_ratio</code> - Cache effectiveness</li> <li><code>geode_transaction_commits_total</code> - Transaction throughput</li> <li><code>geode_storage_bytes_used</code> - Disk usage</li> </ul> <h4 id="performance-tuning" class="position-relative d-flex align-items-center group"> Performance Tuning <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="performance-tuning" aria-haspopup="dialog" aria-label="Share link: Performance Tuning"> Share link </button> </h4>Memory Configuration: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-toml" data-lang="toml">[storage] cache_size = "8GB" # Increase for larger datasets page_size = 8192 # Default, rarely needs changing [performance] query_cache_size = 50000 # Cache more compiled queries connection_pool_size = 2000 # More concurrent connections </code></pre></div>Query Optimization: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash"># Enable query logging [logging] query_logging = true slow_query_threshold = "1s" # Review slow queries tail -f /var/log/geode/slow-queries.log </code></pre></div> <h3 id="integration-guides" class="position-relative d-flex align-items-center group"> Integration Guides <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="integration-guides" aria-haspopup="dialog" aria-label="Share link: Integration Guides"> Share link </button> </h3> <h4 id="connecting-from-python" class="position-relative d-flex align-items-center group"> Connecting from Python <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="connecting-from-python" aria-haspopup="dialog" aria-label="Share link: Connecting from Python"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-python" data-lang="python">import asyncio from geode_client import Client async def main(): client = Client(host="localhost", port=3141) async with client.connection() as conn: # Execute query result, _ = await conn.query(""" MATCH (p:Person {name: $name}) RETURN p.email """, {"name": "Alice"}) # Process results for row in result.rows: print(f"Email: {row['p.email']}") asyncio.run(main()) </code></pre></div> <h4 id="connecting-from-go" class="position-relative d-flex align-items-center group"> Connecting from Go <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="connecting-from-go" aria-haspopup="dialog" aria-label="Share link: Connecting from Go"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go">package main import ( "context" "database/sql" "log" _ "geodedb.com/geode/driver" ) func main() { db, err := sql.Open("geode", "quic://localhost:3141") if err != nil { log.Fatal(err) } defer db.Close() rows, err := db.QueryContext(context.Background(), "MATCH (p:Person {name: $1}) RETURN p.email", "Alice") if err != nil { log.Fatal(err) } defer rows.Close() for rows.Next() { var email string if err := rows.Scan(&email); err != nil { log.Fatal(err) } log.Printf("Email: %s", email) } } </code></pre></div> <h4 id="rest-api-integration" class="position-relative d-flex align-items-center group"> REST API Integration <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="rest-api-integration" aria-haspopup="dialog" aria-label="Share link: REST API Integration"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-python" data-lang="python">from fastapi import FastAPI from geode_client import Client app = FastAPI() client = Client("localhost:3141") @app.get("/users/{user_id}") async def get_user(user_id: str): result, _ = await client.query(""" MATCH (u:User {id: $user_id}) RETURN u """, {"user_id": user_id}) user = await result.single() return user if user else {"error": "Not found"} @app.post("/users/{user_id}/follow/{target_id}") async def follow_user(user_id: str, target_id: str): await client.execute(""" MATCH (u:User {id: $user_id}), (t:User {id: $target_id}) CREATE (u)-[:FOLLOWS {timestamp: datetime()}]->(t) """, {"user_id": user_id, "target_id": target_id}) return {"status": "success"} </code></pre></div> <h3 id="troubleshooting-guides" class="position-relative d-flex align-items-center group"> Troubleshooting Guides <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="troubleshooting-guides" aria-haspopup="dialog" aria-label="Share link: Troubleshooting Guides"> Share link </button> </h3> <h4 id="common-issues" class="position-relative d-flex align-items-center group"> Common Issues <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="common-issues" aria-haspopup="dialog" aria-label="Share link: Common Issues"> Share link </button> </h4>Connection Refused: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash"># Check if server is running geode ping # Check port is listening netstat -tln | grep 3141 # Check firewall sudo ufw allow 3141/tcp </code></pre></div>Slow Queries: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">-- Use PROFILE to identify bottlenecks PROFILE MATCH (p:Person)-[:KNOWS*1..5]->(connection) RETURN connection.name; -- Create missing indexes CREATE INDEX person_name ON :Person(name); </code></pre></div>Out of Memory: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-toml" data-lang="toml"># Increase cache size [storage] cache_size = "16GB" # Reduce connection pool [performance] connection_pool_size = 500 </code></pre></div> <h3 id="related-topics" class="position-relative d-flex align-items-center group"> Related Topics <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="related-topics" aria-haspopup="dialog" aria-label="Share link: Related Topics"> Share link </button> </h3><ul> <li>Getting Started: Initial setup and first steps</li> <li>Examples: Practical code samples and applications</li> <li>Reference: Complete API and syntax documentation</li> <li>Best Practices: Production deployment recommendations</li> <li>Architecture: Understanding Geode internals</li> </ul> <h3 id="further-reading" class="position-relative d-flex align-items-center group"> Further Reading <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="further-reading" aria-haspopup="dialog" aria-label="Share link: Further Reading"> Share link </button> </h3><ul> <li>Query Optimization: Advanced performance tuning</li> <li>Security: Comprehensive security hardening</li> <li>Deployment: Production deployment patterns</li> <li>Monitoring: Observability and alerting</li> <li>Client Libraries: Language-specific integration guides</li> </ul> <hr> Geode guides provide practical, actionable instructions for every aspect of working with the database. From installation to optimization, these step-by-step guides help you implement solutions efficiently and correctly, whether you’re building your first application or scaling to production.

Popular

Category: Guides

Related Articles

Data Export Guide

Backup and Restore Guide

Testing Strategies Guide

Error Handling Guide

Transaction Management Guide

Guides

Production Deployment Guide

High Availability Guide

Monitoring Guide

Social Network Guide

Recommendation Engine Guide

Knowledge Graph Guide