Developer Guide

<h2 id="developer-guide" class="position-relative d-flex align-items-center group"> Developer Guide <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="developer-guide" aria-haspopup="dialog" aria-label="Share link: Developer Guide"> 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>The complete technical reference for developing applications with Geode graph database. This guide covers API documentation, query syntax, client libraries, architectural patterns, and production best practices for building scalable graph applications. <h3 id="architecture-overview" class="position-relative d-flex align-items-center group"> Architecture Overview <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="architecture-overview" aria-haspopup="dialog" aria-label="Share link: Architecture Overview"> Share link </button> </h3>Geode is built on modern, production-ready foundations: Core Technology: <ul> <li>Written in Zig for performance and safety</li> <li>QUIC transport with TLS 1.3 encryption</li> <li>Protobuf wire protocol for client-server communication</li> <li>ACID-compliant transaction engine</li> <li>ISO/IEC 39075:2024 GQL standard compliance</li> </ul> Key Components: <ul> <li>Query Parser & Optimizer</li> <li>Storage Engine with MVCC</li> <li>Transaction Manager</li> <li>Security & Authorization Layer</li> <li>Client Protocol Handler</li> </ul> Architecture Characteristics: <ul> <li>Memory-mapped I/O for efficient storage access</li> <li>SIMD-accelerated vector operations</li> <li>Six specialized index types for different workloads</li> </ul> <h3 id="query-language-reference" class="position-relative d-flex align-items-center group"> Query Language Reference <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-language-reference" aria-haspopup="dialog" aria-label="Share link: Query Language Reference"> Share link </button> </h3> <h4 id="gql-syntax-overview" class="position-relative d-flex align-items-center group"> GQL Syntax Overview <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="gql-syntax-overview" aria-haspopup="dialog" aria-label="Share link: GQL Syntax Overview"> Share link </button> </h4>Graph Query Language (GQL) is a declarative language for querying property graphs. Unlike SQL’s table-oriented model, GQL thinks in terms of graph patterns. <h4 id="match-clause" class="position-relative d-flex align-items-center group"> MATCH Clause <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="match-clause" aria-haspopup="dialog" aria-label="Share link: MATCH Clause"> Share link </button> </h4>Find patterns in the graph: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">-- Basic node match MATCH (p:Person) RETURN p -- Match with property filter MATCH (p:Person {name: 'Alice'}) RETURN p -- Match relationship MATCH (a:Person)-[:KNOWS]->(b:Person) RETURN a.name, b.name -- Multi-hop traversal MATCH (a:Person)-[:KNOWS*2]->(b:Person) RETURN a.name, b.name -- Variable-length with bounds MATCH (a)-[:KNOWS*1..3]->(b) RETURN a, b -- Undirected matching MATCH (a)-[:KNOWS]-(b) -- Either direction RETURN a, b </code></pre></div> <h4 id="create-clause" class="position-relative d-flex align-items-center group"> CREATE Clause <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="create-clause" aria-haspopup="dialog" aria-label="Share link: CREATE Clause"> Share link </button> </h4>Insert nodes and relationships: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">-- Create single node CREATE (p:Person {name: 'Alice', age: 30}) -- Create multiple nodes CREATE (a:Person {name: 'Alice'}), (b:Person {name: 'Bob'}) -- Create with relationship CREATE (a:Person {name: 'Alice'})-[:KNOWS]->(b:Person {name: 'Bob'}) -- Create relationship between existing nodes MATCH (a:Person {name: 'Alice'}) MATCH (b:Person {name: 'Bob'}) CREATE (a)-[:KNOWS {since: 2020}]->(b) </code></pre></div> <h4 id="set-clause" class="position-relative d-flex align-items-center group"> SET Clause <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="set-clause" aria-haspopup="dialog" aria-label="Share link: SET Clause"> Share link </button> </h4>Update properties: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">-- Set single property MATCH (p:Person {name: 'Alice'}) SET p.age = 31 -- Set multiple properties MATCH (p:Person {name: 'Alice'}) SET p.age = 31, p.city = 'NYC', p.updated_at = timestamp() -- Add new properties MATCH (p:Person {name: 'Alice'}) SET p += {email: 'alice@example.com', verified: true} </code></pre></div> <h4 id="delete-clause" class="position-relative d-flex align-items-center group"> DELETE Clause <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="delete-clause" aria-haspopup="dialog" aria-label="Share link: DELETE Clause"> Share link </button> </h4>Remove nodes and relationships: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">-- Delete relationship MATCH (a:Person)-[r:KNOWS]->(b:Person) WHERE a.name = 'Alice' AND b.name = 'Bob' DELETE r -- Delete node (must have no relationships) MATCH (p:Person {name: 'Alice'}) DELETE p -- Delete node and all relationships MATCH (p:Person {name: 'Alice'}) DETACH DELETE p </code></pre></div> <h4 id="where-clause" class="position-relative d-flex align-items-center group"> WHERE Clause <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="where-clause" aria-haspopup="dialog" aria-label="Share link: WHERE Clause"> Share link </button> </h4>Filter results: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">-- Property comparison MATCH (p:Person) WHERE p.age > 25 RETURN p -- Multiple conditions MATCH (p:Person) WHERE p.age > 25 AND p.city = 'NYC' RETURN p -- IN operator MATCH (p:Person) WHERE p.name IN ['Alice', 'Bob', 'Carol'] RETURN p -- Pattern predicate MATCH (p:Person) WHERE EXISTS { MATCH (p)-[:KNOWS]->(:Person {city: 'NYC'}) } RETURN p -- Null checks MATCH (p:Person) WHERE p.email IS NOT NULL RETURN p </code></pre></div> <h4 id="aggregation" class="position-relative d-flex align-items-center group"> Aggregation <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="aggregation" aria-haspopup="dialog" aria-label="Share link: Aggregation"> Share link </button> </h4>Compute aggregate values: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">-- Count MATCH (p:Person) RETURN COUNT(p) -- Count distinct MATCH (p:Person) RETURN COUNT(DISTINCT p.city) -- Sum, Average MATCH (o:Order) RETURN SUM(o.total), AVG(o.total) -- Min, Max MATCH (p:Product) RETURN MIN(p.price), MAX(p.price) -- Group by MATCH (p:Person) RETURN p.city, COUNT(p) as residents ORDER BY residents DESC -- Collect into list MATCH (p:Person)-[:KNOWS]->(friend) RETURN p.name, COLLECT(friend.name) as friends </code></pre></div> <h4 id="subqueries" class="position-relative d-flex align-items-center group"> Subqueries <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="subqueries" aria-haspopup="dialog" aria-label="Share link: Subqueries"> Share link </button> </h4>Compose complex queries: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">-- Existential subquery MATCH (p:Person) WHERE EXISTS { MATCH (p)-[:KNOWS]->(:Person {city: 'NYC'}) } RETURN p -- Scalar subquery MATCH (p:Person) RETURN p.name, ( MATCH (p)-[:KNOWS]->(friend) RETURN COUNT(friend) ) as friend_count -- WITH clause for chaining MATCH (p:Person) WITH p, SIZE((p)-[:KNOWS]->()) as friend_count WHERE friend_count > 5 RETURN p.name, friend_count </code></pre></div> <h4 id="optional-match" class="position-relative d-flex align-items-center group"> OPTIONAL MATCH <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="optional-match" aria-haspopup="dialog" aria-label="Share link: OPTIONAL MATCH"> Share link </button> </h4>Handle nullable patterns: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">-- Optional relationship MATCH (u:User) OPTIONAL MATCH (u)-[:HAS_AVATAR]->(img:Image) RETURN u.name, img.url -- Multiple optional patterns MATCH (u:User) OPTIONAL MATCH (u)-[:HAS_AVATAR]->(img:Image) OPTIONAL MATCH (u)-[:HAS_PROFILE]->(prof:Profile) RETURN u.name, img.url, prof.bio </code></pre></div> <h3 id="client-libraries" class="position-relative d-flex align-items-center group"> Client Libraries <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="client-libraries" aria-haspopup="dialog" aria-label="Share link: Client Libraries"> Share link </button> </h3> <h4 id="python-client" class="position-relative d-flex align-items-center group"> Python Client <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="python-client" aria-haspopup="dialog" aria-label="Share link: Python Client"> Share link </button> </h4>Installation: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash">pip install geode-client </code></pre></div>Basic Usage: <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", name="Alice" ) # Iterate results for row in result.rows: print(row['p']) # Transactions async with client.connection() as tx: await tx.begin() await tx.execute("CREATE (p:Person {name: $name})", name="Bob") await tx.execute("CREATE (p:Person {name: $name})", name="Carol") asyncio.run(main()) </code></pre></div>Connection Pooling: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-python" data-lang="python">client = Client("localhost:3141", pool_size=100, pool_timeout=30) </code></pre></div>Error Handling: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-python" data-lang="python">from geode_client import QueryError, TransactionConflictError try: await client.execute(query) except TransactionConflictError: # Retry logic pass except QueryError as e: # Handle other errors if e.is_syntax_error: logger.error(f"Syntax error: {e}") </code></pre></div> <h4 id="go-client" class="position-relative d-flex align-items-center group"> Go Client <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="go-client" aria-haspopup="dialog" aria-label="Share link: Go Client"> Share link </button> </h4>Installation: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash">go get geodedb.com/geode </code></pre></div>Basic Usage: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go">import ( "database/sql" _ "geodedb.com/geode" ) func main() { db, err := sql.Open("geode", "quic://localhost:3141") if err != nil { panic(err) } defer db.Close() // Query rows, err := db.Query("MATCH (p:Person {name: $name}) RETURN p", sql.Named("name", "Alice")) defer rows.Close() // Transaction tx, _ := db.Begin() tx.Exec("CREATE (p:Person {name: $name})", sql.Named("name", "Bob")) tx.Commit() } </code></pre></div>Connection Pool Configuration: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go">db.SetMaxOpenConns(100) db.SetMaxIdleConns(10) db.SetConnMaxLifetime(time.Hour) </code></pre></div> <h4 id="rust-client" class="position-relative d-flex align-items-center group"> Rust Client <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="rust-client" aria-haspopup="dialog" aria-label="Share link: Rust Client"> Share link </button> </h4>Installation: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-toml" data-lang="toml">[dependencies] geode-client = "0.18" tokio = { version = "1", features = ["full"] } </code></pre></div>Basic Usage: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-rust" data-lang="rust">use geode_client::{Client, params}; #[tokio::main] async fn main() -> Result<(), Box<dyn std::error::Error>> { let client = Client::connect("localhost:3141").await?; // Query with parameters let mut results = client.execute( "MATCH (p:Person {name: $name}) RETURN p", params! { "name" => "Alice" } ).stream().await?; while let Some(row) = results.next().await { println!("{:?}", row.get::<String>("p.name")?); } // Transaction let tx = client.begin().await?; tx.execute("CREATE (p:Person {name: $name})", params! { "name" => "Bob" }).await?; tx.commit().await?; Ok(()) } </code></pre></div> <h4 id="zig-client" class="position-relative d-flex align-items-center group"> Zig Client <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="zig-client" aria-haspopup="dialog" aria-label="Share link: Zig Client"> Share link </button> </h4>Usage (client is vendored in geode-client-zig/): <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-zig" data-lang="zig">const geode = @import("geode_client"); pub fn main() !void { var gpa = std.heap.GeneralPurposeAllocator(.{}){}; defer _ = gpa.deinit(); const allocator = gpa.allocator(); var client = try geode.Client.connect(allocator, "localhost", 3141); defer client.disconnect(); // Execute query const result = try client.execute("MATCH (p:Person) RETURN p.name", .{}); defer result.deinit(); // Process results while (try result.next()) |row| { const name = try row.get("p.name"); std.debug.print("Name: {s}\n", .{name}); } } </code></pre></div> <h3 id="api-reference" class="position-relative d-flex align-items-center group"> API Reference <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="api-reference" aria-haspopup="dialog" aria-label="Share link: API Reference"> Share link </button> </h3> <h4 id="connection-management" class="position-relative d-flex align-items-center group"> Connection 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="connection-management" aria-haspopup="dialog" aria-label="Share link: Connection Management"> Share link </button> </h4>Python: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-python" data-lang="python">client = Client( address="localhost:3141", tls_verify=True, pool_size=100, pool_timeout=30, query_timeout=60 ) </code></pre></div>Go: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go">db, err := sql.Open("geode", "quic://user:pass@localhost:3141?tls=true") </code></pre></div>Rust: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-rust" data-lang="rust">let client = Client::builder() .address("localhost:3141") .pool_size(100) .connect_timeout(Duration::from_secs(30)) .connect() .await?; </code></pre></div> <h4 id="transaction-api" class="position-relative d-flex align-items-center group"> Transaction API <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-api" aria-haspopup="dialog" aria-label="Share link: Transaction API"> Share link </button> </h4>Python: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-python" data-lang="python">async with client.connection() as tx: await tx.begin() await tx.execute(query1) sp = await tx.savepoint("checkpoint") try: await tx.execute(query2) except: await tx.rollback_to(sp) await tx.execute(query3) </code></pre></div>Go: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go">tx, _ := db.Begin() tx.Exec(query1) tx.Exec(query2) tx.Commit() // or tx.Rollback() </code></pre></div>Rust: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-rust" data-lang="rust">let tx = client.begin().await?; tx.execute(query1, params).await?; tx.execute(query2, params).await?; tx.commit().await?; </code></pre></div> <h4 id="result-handling" class="position-relative d-flex align-items-center group"> Result Handling <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="result-handling" aria-haspopup="dialog" aria-label="Share link: Result Handling"> Share link </button> </h4>Python: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-python" data-lang="python">result, _ = await client.query(query) # Get first row row = await result.first() # Iterate all rows for row in result.rows: value = row['column_name'] # Get all rows as list rows = await result.collect() </code></pre></div>Go: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go">rows, _ := db.Query(query) defer rows.Close() for rows.Next() { var name string var age int rows.Scan(&name, &age) } </code></pre></div>Rust: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-rust" data-lang="rust">let mut stream = client.execute(query, params).stream().await?; while let Some(row) = stream.next().await { let name: String = row.get("name")?; let age: i64 = row.get("age")?; } </code></pre></div> <h3 id="best-practices" class="position-relative d-flex align-items-center group"> 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="best-practices" aria-haspopup="dialog" aria-label="Share link: Best Practices"> Share link </button> </h3> <h4 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> </h4>Use Parameters: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-python" data-lang="python"># Good: Prepared statement, safe from injection result, _ = await client.query( "MATCH (p:Person {name: $name}) RETURN p", name=user_input ) # Bad: String concatenation, vulnerable query = f"MATCH (p:Person {{name: '{user_input}'}}) RETURN p" </code></pre></div>Create Indexes: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">CREATE INDEX ON Person(email) CREATE INDEX ON Product(name) </code></pre></div>Profile Queries: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">PROFILE MATCH (a:Person)-[:KNOWS*2]->(b) WHERE a.city = 'NYC' RETURN b.name </code></pre></div> <h4 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> </h4>Keep Transactions Short: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-python" data-lang="python"># Good: focused transaction async with client.connection() as tx: await tx.begin() await tx.execute("CREATE (p:Person {name: 'Alice'})") # Bad: long-running transaction holding locks async with client.connection() as tx: await tx.begin() for item in huge_list: # Don't do this await tx.execute(f"CREATE (p:Person {{name: '{item}'}})") </code></pre></div>Use Savepoints for Complex Operations: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-python" data-lang="python">async with client.connection() as tx: await tx.begin() await tx.execute(critical_operation) sp = await tx.savepoint("optional_part") try: await tx.execute(optional_operation) except: await tx.rollback_to(sp) # Keep critical_operation </code></pre></div> <h4 id="error-handling" class="position-relative d-flex align-items-center group"> Error Handling <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="error-handling" aria-haspopup="dialog" aria-label="Share link: Error Handling"> Share link </button> </h4>Implement Retry Logic: <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 execute_with_retry(client, query): result, _ = await client.query(query) return result </code></pre></div>Handle Specific Errors: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-python" data-lang="python">from geode_client import QueryError try: await client.execute(query) except QueryError as exc: message = str(exc).lower() if "40502" in message: # Retry this one pass elif "syntax" in message: # Don't retry syntax errors logger.error("Invalid query syntax") raise else: raise </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="configuration" class="position-relative d-flex align-items-center group"> Configuration <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="configuration" aria-haspopup="dialog" aria-label="Share link: Configuration"> Share link </button> </h4>Server Configuration: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-yaml" data-lang="yaml">server: listen: 0.0.0.0:3141 max_connections: 10000 tls: cert_file: /etc/geode/server.crt key_file: /etc/geode/server.key storage: data_dir: /var/lib/geode wal_dir: /var/lib/geode/wal performance: query_timeout: 60s transaction_timeout: 300s max_query_memory: 1GB </code></pre></div>Client Configuration: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-python" data-lang="python">client = Client( address="geode.example.com:3141", tls_verify=True, pool_size=100, connect_timeout=30, query_timeout=60 ) </code></pre></div> <h4 id="monitoring" class="position-relative d-flex align-items-center group"> 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="monitoring" aria-haspopup="dialog" aria-label="Share link: Monitoring"> Share link </button> </h4>Key Metrics: <ul> <li>Query latency (p50, p95, p99)</li> <li>Transaction throughput</li> <li>Connection pool utilization</li> <li>Error rates</li> <li>Memory usage</li> </ul> Health Checks: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-python" data-lang="python">@app.get("/health") async def health(): try: await client.execute("MATCH (n) RETURN count(n) LIMIT 1") return {"status": "healthy"} except: return {"status": "unhealthy"}, 503 </code></pre></div> <h4 id="backup--recovery" class="position-relative d-flex align-items-center group"> Backup &amp; Recovery <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--recovery" aria-haspopup="dialog" aria-label="Share link: Backup &amp; Recovery"> Share link </button> </h4>Backup Strategy: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash"># Snapshot backup ./geode backup --output /backups/geode-$(date +%Y%m%d).tar.gz # Continuous WAL archiving ./geode wal-archive --destination s3://backups/wal/ </code></pre></div>Recovery: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash"># Restore from snapshot ./geode restore --input /backups/geode-20250124.tar.gz # Point-in-time recovery ./geode restore --snapshot /backups/base.tar.gz --wal /backups/wal/ --target-time 2025-01-24T15:30:00Z </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>Tutorials: Step-by-step learning guides</li> <li>Examples: Working code samples</li> <li>API Reference: Complete function documentation</li> <li>Performance Guide: Optimization techniques</li> <li>Security Guide: Authentication and authorization</li> </ul>

Popular

Related Articles

Development