Best Practices & Design Patterns

<h2 id="best-practices--design-patterns" class="position-relative d-flex align-items-center group"> Best Practices &amp; Design 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="best-practices--design-patterns" aria-haspopup="dialog" aria-label="Share link: Best Practices &amp; Design Patterns"> Share link </button> </h2><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>Building production-ready graph applications with Geode requires understanding not just the technology, but proven patterns and practices that ensure performance, maintainability, and scalability. This comprehensive guide covers schema design, query optimization, security, and operational best practices for Geode deployments. <h3 id="schema-design-best-practices" class="position-relative d-flex align-items-center group"> Schema Design Best Practices <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="schema-design-best-practices" aria-haspopup="dialog" aria-label="Share link: Schema Design Best Practices"> Share link </button> </h3> <h4 id="1-model-for-your-queries" class="position-relative d-flex align-items-center group"> 1. Model for Your 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="1-model-for-your-queries" aria-haspopup="dialog" aria-label="Share link: 1. Model for Your Queries"> Share link </button> </h4>Design your graph schema based on how you’ll query it, not just the domain structure. Good Practice: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">-- If you frequently query "products a user might like" -- Model supports this pattern: MATCH (u:User {id: $user_id})-[:LIKES]->(cat:Category) MATCH (p:Product)-[:IN_CATEGORY]->(cat) WHERE NOT EXISTS { MATCH (u)-[:PURCHASED]->(p) } RETURN p.name, count(cat) AS relevance ORDER BY relevance DESC; </code></pre></div>Poor Practice: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">-- Model that doesn't support common queries efficiently -- Requires complex traversals or multiple queries </code></pre></div> <h4 id="2-choose-appropriate-granularity" class="position-relative d-flex align-items-center group"> 2. Choose Appropriate Granularity <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="2-choose-appropriate-granularity" aria-haspopup="dialog" aria-label="Share link: 2. Choose Appropriate Granularity"> Share link </button> </h4>When to Use Nodes: <ul> <li>Entity referenced by multiple others</li> <li>Has its own relationships</li> <li>Queried independently</li> <li>Complex structure</li> </ul> When to Use Properties: <ul> <li>Simple attribute values</li> <li>Unique to parent entity</li> <li>Not queried independently</li> <li>No relationships</li> </ul> <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">-- GOOD: Shared address as node INSERT (addr:Address {street: '123 Main St', city: 'Austin'}); INSERT (alice:Person)-[:LIVES_AT]->(addr); INSERT (bob:Person)-[:LIVES_AT]->(addr); -- GOOD: Unique email as property INSERT (charlie:Person {email: 'charlie@example.com'}); -- BAD: Address as string property (can't be shared/queried) INSERT (dave:Person {address: '456 Oak St, Dallas, TX'}); </code></pre></div> <h4 id="3-use-meaningful-relationship-types" class="position-relative d-flex align-items-center group"> 3. Use Meaningful Relationship Types <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="3-use-meaningful-relationship-types" aria-haspopup="dialog" aria-label="Share link: 3. Use Meaningful Relationship Types"> Share link </button> </h4>Choose specific, action-oriented relationship types: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">-- GOOD: Clear, specific relationships (person:Person)-[:WORKS_AT]->(company:Company) (user:User)-[:PURCHASED]->(product:Product) (employee:Employee)-[:REPORTS_TO]->(manager:Manager) -- BAD: Generic, unclear relationships (entity1)-[:RELATED_TO]->(entity2) (node1)-[:CONNECTS]->(node2) </code></pre></div> <h4 id="4-avoid-super-nodes" class="position-relative d-flex align-items-center group"> 4. Avoid Super Nodes <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="4-avoid-super-nodes" aria-haspopup="dialog" aria-label="Share link: 4. Avoid Super Nodes"> Share link </button> </h4>Nodes with millions of relationships degrade performance. Problem: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">-- Country node with millions of users INSERT (user)-[:LIVES_IN]->(usa:Country); -- Repeated millions of times </code></pre></div>Solutions: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">-- Solution 1: Use property + index INSERT (user:User {country: 'USA'}); CREATE INDEX user_country ON User(country); -- Solution 2: Add intermediate nodes INSERT (user)-[:LIVES_IN]->(state:State); INSERT (state)-[:IN_COUNTRY]->(country:Country); </code></pre></div> <h4 id="5-normalize-appropriately" class="position-relative d-flex align-items-center group"> 5. Normalize Appropriately <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="5-normalize-appropriately" aria-haspopup="dialog" aria-label="Share link: 5. Normalize Appropriately"> Share link </button> </h4>Unlike relational databases, some denormalization improves performance: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">-- Acceptable denormalization for performance INSERT (order:Order { id: 'o123', customer_id: 'c456', customer_name: 'Alice', -- Denormalized customer_email: 'alice@example.com', -- Denormalized total: 299.99 }); -- Also maintain relationship INSERT (order)-[:PLACED_BY]->(customer:Customer {id: 'c456'}); </code></pre></div> <h3 id="query-optimization" class="position-relative d-flex align-items-center group"> Query Optimization <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" aria-haspopup="dialog" aria-label="Share link: Query Optimization"> Share link </button> </h3> <h4 id="1-use-parameterized-queries" class="position-relative d-flex align-items-center group"> 1. Use Parameterized 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="1-use-parameterized-queries" aria-haspopup="dialog" aria-label="Share link: 1. Use Parameterized Queries"> Share link </button> </h4>Always use parameters for reusable, cacheable query plans: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">-- GOOD: Parameterized MATCH (p:Person {name: $person_name}) RETURN p.age, p.city; -- BAD: Literal values (prevents plan caching) MATCH (p:Person {name: 'Alice'}) RETURN p.age, p.city; </code></pre></div>From client code: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-python" data-lang="python"># Python result, _ = await client.query( "MATCH (p:Person {name: $name}) RETURN p.age", parameters={"name": user_input} ) </code></pre></div> <h4 id="2-profile-slow-queries" class="position-relative d-flex align-items-center group"> 2. Profile Slow 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="2-profile-slow-queries" aria-haspopup="dialog" aria-label="Share link: 2. Profile Slow Queries"> Share link </button> </h4>Use PROFILE to understand execution: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">PROFILE MATCH (p:Person)-[:KNOWS*2..4]->(friend) WHERE p.city = 'San Francisco' RETURN friend.name; </code></pre></div>Analyze: <ul> <li>Execution plan</li> <li>Operator costs</li> <li>Index usage</li> <li>Estimated vs actual rows</li> </ul> <h4 id="3-create-strategic-indexes" class="position-relative d-flex align-items-center group"> 3. Create Strategic 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="3-create-strategic-indexes" aria-haspopup="dialog" aria-label="Share link: 3. Create Strategic Indexes"> Share link </button> </h4>Index properties used for lookups and filtering: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">-- Single-column indexes CREATE INDEX user_email ON User(email); CREATE INDEX product_sku ON Product(sku); -- Composite indexes for multi-property queries CREATE INDEX product_category_price ON Product(category, price); -- Full-text search CREATE FULLTEXT INDEX product_search ON Product(name, description); </code></pre></div> <h4 id="4-limit-result-sets" class="position-relative d-flex align-items-center group"> 4. Limit Result Sets <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="4-limit-result-sets" aria-haspopup="dialog" aria-label="Share link: 4. Limit Result Sets"> Share link </button> </h4>Always use LIMIT for unbounded queries: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">-- GOOD: Limited results MATCH (p:Person) RETURN p.name ORDER BY p.created DESC LIMIT 100; -- BAD: Unbounded (could return millions) MATCH (p:Person) RETURN p.name; </code></pre></div> <h4 id="5-avoid-cartesian-products" class="position-relative d-flex align-items-center group"> 5. Avoid Cartesian Products <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="5-avoid-cartesian-products" aria-haspopup="dialog" aria-label="Share link: 5. Avoid Cartesian Products"> Share link </button> </h4>Be careful with multiple MATCH clauses: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">-- BAD: Creates cartesian product MATCH (p:Person) MATCH (c:Company) RETURN p.name, c.name; -- Returns p_count * c_count rows -- GOOD: Use relationships MATCH (p:Person)-[:WORKS_AT]->(c:Company) RETURN p.name, c.name; </code></pre></div> <h3 id="indexing-strategies" class="position-relative d-flex align-items-center group"> Indexing Strategies <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="indexing-strategies" aria-haspopup="dialog" aria-label="Share link: Indexing Strategies"> Share link </button> </h3> <h4 id="1-index-high-selectivity-properties" class="position-relative d-flex align-items-center group"> 1. Index High-Selectivity Properties <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="1-index-high-selectivity-properties" aria-haspopup="dialog" aria-label="Share link: 1. Index High-Selectivity Properties"> Share link </button> </h4>Index properties that narrow down results significantly: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">-- High selectivity (good for indexing) CREATE INDEX user_email ON User(email); -- Unique or near-unique CREATE INDEX product_sku ON Product(sku); -- Low selectivity (poor candidate) -- CREATE INDEX user_active ON User(active); -- Only true/false </code></pre></div> <h4 id="2-composite-indexes-for-multi-property-queries" class="position-relative d-flex align-items-center group"> 2. Composite Indexes for Multi-Property 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="2-composite-indexes-for-multi-property-queries" aria-haspopup="dialog" aria-label="Share link: 2. Composite Indexes for Multi-Property Queries"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">-- Create composite index CREATE INDEX order_customer_date ON Order(customer_id, order_date); -- Efficiently supports this query MATCH (o:Order) WHERE o.customer_id = $cust_id AND o.order_date >= DATE '2024-01-01' RETURN o; </code></pre></div> <h4 id="3-monitor-index-usage" class="position-relative d-flex align-items-center group"> 3. Monitor Index Usage <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="3-monitor-index-usage" aria-haspopup="dialog" aria-label="Share link: 3. Monitor Index Usage"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">-- Check index statistics SHOW INDEXES; -- Profile to verify index usage PROFILE MATCH (u:User {email: $email}) RETURN u.name; </code></pre></div> <h3 id="transaction-management" class="position-relative d-flex align-items-center group"> Transaction Management <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="transaction-management" aria-haspopup="dialog" aria-label="Share link: Transaction Management"> Share link </button> </h3> <h4 id="1-keep-transactions-short" class="position-relative d-flex align-items-center group"> 1. Keep Transactions Short <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="1-keep-transactions-short" aria-haspopup="dialog" aria-label="Share link: 1. Keep Transactions Short"> Share link </button> </h4>Minimize transaction duration to reduce lock contention: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">-- GOOD: Short transaction BEGIN TRANSACTION; INSERT (order:Order {id: 'o123', total: 99.99}); MATCH (user:User {id: 'u456'}) INSERT (user)-[:PLACED]->(order); COMMIT; -- BAD: Long-running transaction BEGIN TRANSACTION; -- Complex data processing... -- Multiple network calls... -- User input... COMMIT; -- Holds locks too long </code></pre></div> <h4 id="2-use-savepoints-for-partial-rollback" class="position-relative d-flex align-items-center group"> 2. Use Savepoints for Partial Rollback <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="2-use-savepoints-for-partial-rollback" aria-haspopup="dialog" aria-label="Share link: 2. Use Savepoints for Partial Rollback"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">BEGIN TRANSACTION; INSERT (user:User {name: 'Alice'}); SAVEPOINT sp1; -- Risky operation INSERT (payment:Payment {amount: 999.99}); -- Rollback just this operation if needed ROLLBACK TO SAVEPOINT sp1; -- Continue with transaction INSERT (user:User {name: 'Bob'}); COMMIT; </code></pre></div> <h4 id="3-handle-transaction-errors" class="position-relative d-flex align-items-center group"> 3. Handle Transaction Errors <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="3-handle-transaction-errors" aria-haspopup="dialog" aria-label="Share link: 3. Handle Transaction Errors"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-python" data-lang="python"># Python example async def create_order(user_id, items): async with client.connection() as tx: await tx.begin() try: await tx.execute( "INSERT (o:Order {id: $id, total: $total})", {"id": order_id, "total": total} ) await tx.execute( "MATCH (u:User {id: $uid}) INSERT (u)-[:PLACED]->(o:Order {id: $oid})", {"uid": user_id, "oid": order_id} ) await tx.commit() except Exception as e: await tx.rollback() raise </code></pre></div> <h3 id="security-best-practices" class="position-relative d-flex align-items-center group"> Security Best Practices <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-best-practices" aria-haspopup="dialog" aria-label="Share link: Security Best Practices"> Share link </button> </h3> <h4 id="1-use-row-level-security-rls" class="position-relative d-flex align-items-center group"> 1. Use Row-Level Security (RLS) <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="1-use-row-level-security-rls" aria-haspopup="dialog" aria-label="Share link: 1. Use Row-Level Security (RLS)"> Share link </button> </h4>Define security policies in the database: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">-- Tenant isolation CREATE POLICY tenant_isolation ON ALL USING (tenant_id = current_tenant()); -- User data access CREATE POLICY user_data_access ON User USING (id = current_user_id() OR current_user_role = 'admin'); -- Confidential relationships CREATE POLICY salary_access ON EARNS_SALARY USING (current_user_role IN ['hr', 'admin']); </code></pre></div> <h4 id="2-never-trust-client-input" class="position-relative d-flex align-items-center group"> 2. Never Trust Client Input <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="2-never-trust-client-input" aria-haspopup="dialog" aria-label="Share link: 2. Never Trust Client Input"> Share link </button> </h4>Always use parameterized queries: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-python" data-lang="python"># GOOD: Parameterized user_input = request.get_param('name') result, _ = await client.query( "MATCH (p:Person {name: $name}) RETURN p", {"name": user_input} ) # BAD: String concatenation (injection risk!) # query = f"MATCH (p:Person {{name: '{user_input}'}}) RETURN p" </code></pre></div> <h4 id="3-implement-audit-logging" class="position-relative d-flex align-items-center group"> 3. Implement Audit Logging <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="3-implement-audit-logging" aria-haspopup="dialog" aria-label="Share link: 3. Implement Audit Logging"> Share link </button> </h4>Log all data modifications: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">-- Geode automatically logs all mutations -- Review audit logs regularly -- Example: check recent mutations CALL system.audit_log(CURRENT_TIMESTAMP - DURATION 'P7D'); </code></pre></div> <h4 id="4-use-tls-for-all-connections" class="position-relative d-flex align-items-center group"> 4. Use TLS for All Connections <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="4-use-tls-for-all-connections" aria-haspopup="dialog" aria-label="Share link: 4. Use TLS for All Connections"> Share link </button> </h4>Geode enforces TLS 1.3 by default - don’t disable it: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash"># Client connection (TLS required) geode-client connect --host geode.example.com:3141 --tls-verify </code></pre></div> <h3 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> </h3> <h4 id="1-batch-operations" class="position-relative d-flex align-items-center group"> 1. Batch Operations <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="1-batch-operations" aria-haspopup="dialog" aria-label="Share link: 1. Batch Operations"> Share link </button> </h4>Use UNWIND for bulk inserts: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">-- Efficient batch insert UNWIND $users AS user_data INSERT (u:User { id: user_data.id, name: user_data.name, email: user_data.email }); </code></pre></div>From application: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-python" data-lang="python">users = [ {"id": "u1", "name": "Alice", "email": "[email protected]"}, {"id": "u2", "name": "Bob", "email": "[email protected]"}, # ... thousands more ] await client.query( "UNWIND $users AS u INSERT (user:User {id: u.id, name: u.name})", {"users": users} ) </code></pre></div> <h4 id="2-use-connection-pooling" class="position-relative d-flex align-items-center group"> 2. Use Connection Pooling <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="2-use-connection-pooling" aria-haspopup="dialog" aria-label="Share link: 2. Use Connection Pooling"> Share link </button> </h4>Configure appropriate pool sizes: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-python" data-lang="python"># Python client = Client( "localhost:3141", pool_size=20, # Adjust based on workload max_overflow=10 ) </code></pre></div><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go">// Go db, err := sql.Open("geode", "quic://localhost:3141?pool_size=20") </code></pre></div> <h4 id="3-monitor-query-performance" class="position-relative d-flex align-items-center group"> 3. Monitor Query Performance <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="3-monitor-query-performance" aria-haspopup="dialog" aria-label="Share link: 3. Monitor Query Performance"> Share link </button> </h4>Track slow queries: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-python" data-lang="python">import logging # Log slow queries async def execute_with_timing(query, params): start = time.time() result, _ = await client.query(query, params) duration = time.time() - start if duration > 1.0: # Log queries over 1 second logging.warning(f"Slow query ({duration:.2f}s): {query}") return result </code></pre></div> <h4 id="4-cache-frequently-accessed-data" class="position-relative d-flex align-items-center group"> 4. Cache Frequently Accessed Data <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="4-cache-frequently-accessed-data" aria-haspopup="dialog" aria-label="Share link: 4. Cache Frequently Accessed Data"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-python" data-lang="python">from functools import lru_cache import asyncio # Cache user lookups user_cache = {} async def get_user(user_id): if user_id in user_cache: return user_cache[user_id] result, _ = await client.query( "MATCH (u:User {id: $id}) RETURN u", {"id": user_id} ) user_cache[user_id] = result return result </code></pre></div> <h3 id="application-integration" class="position-relative d-flex align-items-center group"> Application 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="application-integration" aria-haspopup="dialog" aria-label="Share link: Application Integration"> Share link </button> </h3> <h4 id="1-use-prepared-statements" class="position-relative d-flex align-items-center group"> 1. Use Prepared Statements <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="1-use-prepared-statements" aria-haspopup="dialog" aria-label="Share link: 1. Use Prepared Statements"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-python" data-lang="python"># Prepare once, execute many times prepared = await client.prepare( "MATCH (p:Person {id: $id}) RETURN p.name, p.email" ) # Execute with different parameters for user_id in user_ids: result, _ = await prepared.execute({"id": user_id}) </code></pre></div> <h4 id="2-handle-concurrent-access" class="position-relative d-flex align-items-center group"> 2. Handle Concurrent Access <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="2-handle-concurrent-access" aria-haspopup="dialog" aria-label="Share link: 2. Handle Concurrent Access"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-python" data-lang="python">import asyncio # Process queries concurrently async def fetch_user_data(user_ids): tasks = [ client.query("MATCH (u:User {id: $id}) RETURN u", {"id": uid}) for uid in user_ids ] results = await asyncio.gather(*tasks) return results </code></pre></div> <h4 id="3-implement-retry-logic" class="position-relative d-flex align-items-center group"> 3. Implement Retry Logic <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="3-implement-retry-logic" aria-haspopup="dialog" aria-label="Share link: 3. Implement Retry Logic"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-python" data-lang="python">from tenacity import retry, stop_after_attempt, wait_exponential @retry( stop=stop_after_attempt(3), wait=wait_exponential(multiplier=1, min=1, max=10) ) async def query_with_retry(query, params): return await client.query(query, params) </code></pre></div> <h3 id="production-deployment" class="position-relative d-flex align-items-center group"> Production 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="production-deployment" aria-haspopup="dialog" aria-label="Share link: Production Deployment"> Share link </button> </h3> <h4 id="1-resource-planning" class="position-relative d-flex align-items-center group"> 1. Resource Planning <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="1-resource-planning" aria-haspopup="dialog" aria-label="Share link: 1. Resource Planning"> Share link </button> </h4>Minimum Resources: <ul> <li>CPU: 4 cores</li> <li>RAM: 8GB</li> <li>Storage: SSD recommended</li> </ul> Scale Based on: <ul> <li>Number of nodes/relationships</li> <li>Query complexity</li> <li>Concurrent connections</li> <li>Write throughput</li> </ul> <h4 id="2-backup-strategy" class="position-relative d-flex align-items-center group"> 2. Backup Strategy <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="2-backup-strategy" aria-haspopup="dialog" aria-label="Share link: 2. Backup Strategy"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash"># Daily backups 0 2 * * * /usr/local/bin/geode backup \ --output /backups/geode-$(date +\%Y\%m\%d).tar.gz # Retention: keep 30 days find /backups -name "geode-*.tar.gz" -mtime +30 -delete </code></pre></div> <h4 id="3-monitoring" class="position-relative d-flex align-items-center group"> 3. Monitoring <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="3-monitoring" aria-haspopup="dialog" aria-label="Share link: 3. Monitoring"> Share link </button> </h4>Monitor key metrics: <ul> <li>Query latency (p50, p95, p99)</li> <li>Throughput (queries/sec)</li> <li>Connection pool usage</li> <li>Transaction rate</li> <li>Storage growth</li> <li>Cache hit rates</li> </ul> <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-python" data-lang="python"># Example: Prometheus metrics from prometheus_client import Counter, Histogram query_counter = Counter('geode_queries_total', 'Total queries') query_duration = Histogram('geode_query_duration_seconds', 'Query duration') @query_duration.time() async def monitored_query(query, params): query_counter.inc() return await client.query(query, params) </code></pre></div> <h4 id="4-log-management" class="position-relative d-flex align-items-center group"> 4. Log Management <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="4-log-management" aria-haspopup="dialog" aria-label="Share link: 4. Log Management"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-yaml" data-lang="yaml"># logging.conf version: 1 handlers: file: class: logging.handlers.RotatingFileHandler filename: /var/log/geode/application.log maxBytes: 104857600 # 100MB backupCount: 10 loggers: geode: level: INFO handlers: [file] </code></pre></div> <h3 id="testing-best-practices" class="position-relative d-flex align-items-center group"> Testing Best Practices <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="testing-best-practices" aria-haspopup="dialog" aria-label="Share link: Testing Best Practices"> Share link </button> </h3> <h4 id="1-unit-test-queries" class="position-relative d-flex align-items-center group"> 1. Unit Test 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="1-unit-test-queries" aria-haspopup="dialog" aria-label="Share link: 1. Unit Test Queries"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-python" data-lang="python">import pytest @pytest.mark.asyncio async def test_user_creation(): # Setup await client.query("DELETE (u:User {email: '[email protected]'})") # Execute await client.query( "INSERT (u:User {email: $email, name: $name})", {"email": "[email protected]", "name": "Test User"} ) # Verify result, _ = await client.query( "MATCH (u:User {email: $email}) RETURN u.name", {"email": "[email protected]"} ) assert result.rows[0]['u.name'] == "Test User" # Cleanup await client.query("DELETE (u:User {email: '[email protected]'})") </code></pre></div> <h4 id="2-integration-tests" class="position-relative d-flex align-items-center group"> 2. Integration Tests <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="2-integration-tests" aria-haspopup="dialog" aria-label="Share link: 2. Integration Tests"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-python" data-lang="python">@pytest.mark.integration async def test_order_workflow(): # Create test data await tx.query("INSERT (u:User {id: 'test_user'})") await tx.query("INSERT (p:Product {id: 'test_prod', price: 99.99})") # Test workflow async with client.connection() as tx: await tx.begin() await tx.execute( "INSERT (o:Order {id: 'test_order', total: 99.99})" ) await tx.execute( "MATCH (u:User {id: 'test_user'}), (o:Order {id: 'test_order'}) " "INSERT (u)-[:PLACED]->(o)" ) await tx.commit() # Verify result, _ = await tx.query( "MATCH (u:User {id: 'test_user'})-[:PLACED]->(o:Order) " "RETURN o.total" ) assert result.rows[0]['o.total'] == 99.99 </code></pre></div> <h3 id="common-antipatterns-to-avoid" class="position-relative d-flex align-items-center group"> Common Antipatterns to Avoid <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-antipatterns-to-avoid" aria-haspopup="dialog" aria-label="Share link: Common Antipatterns to Avoid"> Share link </button> </h3> <h4 id="1-dont-use-properties-as-arrays-of-ids" class="position-relative d-flex align-items-center group"> 1. Don&rsquo;t Use Properties as Arrays of IDs <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="1-dont-use-properties-as-arrays-of-ids" aria-haspopup="dialog" aria-label="Share link: 1. Dont Use Properties as Arrays of IDs"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">-- BAD INSERT (user:User {friend_ids: ['u2', 'u3', 'u4']}); -- GOOD INSERT (u1:User)-[:FRIENDS_WITH]->(u2:User); INSERT (u1)-[:FRIENDS_WITH]->(u3:User); </code></pre></div> <h4 id="2-dont-create-redundant-relationships" class="position-relative d-flex align-items-center group"> 2. Don&rsquo;t Create Redundant Relationships <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="2-dont-create-redundant-relationships" aria-haspopup="dialog" aria-label="Share link: 2. Dont Create Redundant Relationships"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">-- BAD: Redundant relationship INSERT (user)-[:LIVES_IN]->(city); INSERT (city)-[:IN_STATE]->(state); INSERT (user)-[:LIVES_IN_STATE]->(state); -- Derivable! -- GOOD: Derive when needed MATCH (user)-[:LIVES_IN]->(city)-[:IN_STATE]->(state) RETURN state.name; </code></pre></div> <h4 id="3-dont-over-index" class="position-relative d-flex align-items-center group"> 3. Don&rsquo;t Over-Index <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="3-dont-over-index" aria-haspopup="dialog" aria-label="Share link: 3. Dont Over-Index"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">-- BAD: Too many indexes CREATE INDEX user_id ON User(id); CREATE INDEX user_name ON User(name); CREATE INDEX user_email ON User(email); CREATE INDEX user_created ON User(created); CREATE INDEX user_updated ON User(updated); -- ... etc -- GOOD: Strategic indexes CREATE INDEX user_id ON User(id); -- Primary lookup CREATE INDEX user_email ON User(email); -- Login </code></pre></div> <h3 id="conclusion" class="position-relative d-flex align-items-center group"> Conclusion <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="conclusion" aria-haspopup="dialog" aria-label="Share link: Conclusion"> Share link </button> </h3>Following these best practices ensures your Geode deployments are performant, secure, and maintainable. Focus on: <ol> <li>Schema Design: Model for queries, use appropriate granularity</li> <li>Query Optimization: Profile, index strategically, use parameters</li> <li>Security: RLS policies, parameterized queries, audit logging</li> <li>Performance: Batch operations, connection pooling, caching</li> <li>Production: Monitoring, backups, resource planning</li> </ol> Explore the documentation below for detailed guides on specific topics, advanced patterns, and troubleshooting techniques.

Popular

Related Articles

Graph Modeling Guide

Graph Schema Design Guide

Query Performance Guide

Guides

Password Hashing with Argon2id