API Reference Documentation

Geode provides comprehensive client libraries for Python, Go, Rust, and Zig, all implementing consistent APIs for connecting to Geode servers, executing GQL queries, and managing transactions. This reference covers all client library APIs and integration patterns. <h3 id="client-library-overview" class="position-relative d-flex align-items-center group"> Client Library 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="client-library-overview" aria-haspopup="dialog" aria-label="Share link: Client Library Overview"> 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> <h4 id="supported-languages" class="position-relative d-flex align-items-center group"> Supported Languages <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="supported-languages" aria-haspopup="dialog" aria-label="Share link: Supported Languages"> Share link </button> </h4><ul> <li>Python: Async client with aioquic (Python 3.9+)</li> <li>Go: database/sql driver implementation (Go 1.24+)</li> <li>Rust: Tokio-based async client (Rust 1.70+)</li> <li>Zig: Native client with vendored QUIC (Zig 0.1.0+)</li> </ul> All clients communicate via QUIC+TLS on port 3141 using Protobuf wire protocol. <h4 id="common-capabilities" class="position-relative d-flex align-items-center group"> Common Capabilities <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-capabilities" aria-haspopup="dialog" aria-label="Share link: Common Capabilities"> Share link </button> </h4><ul> <li>Connection pooling and management</li> <li>Parameterized query execution</li> <li>Transaction support (BEGIN, COMMIT, ROLLBACK, SAVEPOINT)</li> <li>Prepared statements</li> <li>Row-level security (RLS) policy management</li> <li>Error handling with GQL status codes</li> <li>Async/await patterns (where applicable)</li> </ul> <h3 id="python-client-api" class="position-relative d-flex align-items-center group"> Python Client 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="python-client-api" aria-haspopup="dialog" aria-label="Share link: Python Client API"> Share link </button> </h3> <h4 id="installation" class="position-relative d-flex align-items-center group"> Installation <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" aria-haspopup="dialog" aria-label="Share link: Installation"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash">pip install geode-client # or pip install -r requirements.txt </code></pre></div> <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><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-python" data-lang="python">from geode_client import Client import asyncio # Context manager (recommended) async def example(): client = Client(host="localhost", port=3141) async with client.connection() as conn: result, _ = await conn.query("MATCH (n) RETURN COUNT(n) AS count") for row in result.rows: print(row['count']) # Manual connection async def manual_example(): client = Client("localhost:3141") await client.connect() try: result, _ = await conn.query("MATCH (n) RETURN n LIMIT 10") for row in result.rows: print(row) finally: await client.close() # Connection pool configuration client = Client( "localhost:3141", max_connections=100, connection_timeout=30, verify_tls=True, ca_file="/path/to/ca.pem" ) </code></pre></div> <h4 id="query-execution" class="position-relative d-flex align-items-center group"> Query Execution <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-execution" aria-haspopup="dialog" aria-label="Share link: Query Execution"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-python" data-lang="python"># Simple query result, _ = await client.query("MATCH (u:User) RETURN u.name") for row in result.rows: print(row['name']) # Parameterized query (named parameters) result, _ = await client.query(""" MATCH (u:User) WHERE u.age >= $min_age AND u.verified = $verified RETURN u.name, u.age """, { "min_age": 18, "verified": True }) # Parameterized query (positional parameters) result, _ = await client.query(""" MATCH (u:User) WHERE u.age >= $1 AND u.verified = $2 RETURN u.name, u.age """, [18, True]) # Execute with no results (INSERT, UPDATE, DELETE) affected, _ = await client.query(""" CREATE (u:User { name: $name, email: $email, created_at: CURRENT_TIMESTAMP }) """, {"name": "Alice", "email": "[email protected]"}) print(f"Created {len(affected.rows)} nodes") </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><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-python" data-lang="python"># Transaction context manager async with client.connection() as conn: await conn.begin() try: await conn.execute("CREATE (u:User {name: $name})", {"name": "Alice"}) await conn.execute("CREATE (u:User {name: $name})", {"name": "Bob"}) await conn.commit() except Exception: await conn.rollback() raise # Manual transaction control conn = await client.connect() try: await conn.begin() await conn.execute("CREATE (u:User {name: 'Alice'})") await conn.execute("CREATE (u:User {name: 'Bob'})") await conn.commit() except Exception: await conn.rollback() raise finally: await conn.close() # Savepoints async with client.connection() as tx: await tx.begin() await tx.execute("CREATE (u:User {name: 'Alice'})") sp = await tx.savepoint("before_bob") try: await tx.execute("CREATE (u:User {name: 'Bob', invalid: ???})") except: await tx.rollback_to(sp) # Rollback to savepoint await tx.execute("CREATE (u:User {name: 'Charlie'})") await tx.commit() # Commits Alice and Charlie, Bob rolled back </code></pre></div> <h4 id="prepared-statements" class="position-relative d-flex align-items-center group"> 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="prepared-statements" aria-haspopup="dialog" aria-label="Share link: Prepared Statements"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-python" data-lang="python"># Prepare statement stmt = await conn.prepare(""" MATCH (u:User {id: $user_id}) RETURN u.name, u.email """) # Execute multiple times with different parameters for user_id in [1, 2, 3, 4, 5]: result, _ = await stmt.execute({"user_id": user_id}) for row in result.rows: print(f"{row['name']}: {row['email']}") # Close statement await stmt.close() </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><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-python" data-lang="python">from geode_client import ( GeodeError, GeodeConnectionError, QueryError, AuthError ) try: result, _ = await client.query("MATCH (u:User) WHERE u.invalid_syntax") except QueryError as e: print(f"Query error: {e}") except GeodeConnectionError as e: print(f"Connection failed: {e}") except AuthError as e: print(f"Auth failed: {e}") except GeodeError as e: print(f"Geode error: {e}") </code></pre></div> <h4 id="row-level-security-rls" class="position-relative d-flex align-items-center group"> 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="row-level-security-rls" aria-haspopup="dialog" aria-label="Share link: Row-Level Security (RLS)"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-python" data-lang="python"># Set session context for RLS async with client.connection() as conn: await conn.execute("SET app.user_id = $user_id", {"user_id": 123}) # Query with RLS enforced result, _ = await conn.query(""" MATCH (u:User)-[:POSTED]->(p:Post) RETURN p.title """) # Only returns posts accessible under policy # Clear RLS policy await conn.execute("SET app.user_id = NULL") </code></pre></div> <h3 id="go-client-api" class="position-relative d-flex align-items-center group"> Go Client 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="go-client-api" aria-haspopup="dialog" aria-label="Share link: Go Client API"> Share link </button> </h3> <h4 id="installation-1" class="position-relative d-flex align-items-center group"> Installation <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-1" aria-haspopup="dialog" aria-label="Share link: Installation"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash">go get geodedb.com/geode </code></pre></div> <h4 id="connection-management-1" 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-1" aria-haspopup="dialog" aria-label="Share link: Connection Management"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go">import ( "database/sql" _ "geodedb.com/geode" ) // Open connection db, err := sql.Open("geode", "quic://localhost:3141") if err != nil { log.Fatal(err) } defer db.Close() // Configure connection pool db.SetMaxOpenConns(100) db.SetMaxIdleConns(10) db.SetConnMaxLifetime(time.Hour) // Test connection if err := db.Ping(); err != nil { log.Fatal("Cannot connect:", err) } // Connection string options // quic://host:port?tls=true&ca_file=/path/to/ca.pem&timeout=30s db, err := sql.Open("geode", "quic://localhost:3141?tls=true&timeout=30s") </code></pre></div> <h4 id="query-execution-1" class="position-relative d-flex align-items-center group"> Query Execution <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-execution-1" aria-haspopup="dialog" aria-label="Share link: Query Execution"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go">// Query with rows rows, err := db.Query(` MATCH (u:User) WHERE u.age >= $1 AND u.verified = $2 RETURN u.name, u.age `, 18, true) if err != nil { log.Fatal(err) } defer rows.Close() for rows.Next() { var name string var age int if err := rows.Scan(&name, &age); err != nil { log.Fatal(err) } fmt.Printf("%s: %d\n", name, age) } if err := rows.Err(); err != nil { log.Fatal(err) } // Single row query var name string var email string err = db.QueryRow(` MATCH (u:User {id: $1}) RETURN u.name, u.email `, 123).Scan(&name, &email) if err == sql.ErrNoRows { fmt.Println("User not found") } else if err != nil { log.Fatal(err) } // Execute (no result rows) result, err := db.Exec(` CREATE (u:User { name: $1, email: $2, created_at: CURRENT_TIMESTAMP }) `, "Alice", "[email protected]") if err != nil { log.Fatal(err) } affected, _ := result.RowsAffected() fmt.Printf("Created %d nodes\n", affected) </code></pre></div> <h4 id="transaction-management-1" 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-1" aria-haspopup="dialog" aria-label="Share link: Transaction Management"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go">// Begin transaction tx, err := db.Begin() if err != nil { log.Fatal(err) } // Execute within transaction _, err = tx.Exec("CREATE (u:User {name: $1})", "Alice") if err != nil { tx.Rollback() log.Fatal(err) } _, err = tx.Exec("CREATE (u:User {name: $1})", "Bob") if err != nil { tx.Rollback() log.Fatal(err) } // Commit transaction if err = tx.Commit(); err != nil { log.Fatal(err) } // Transaction with defer pattern tx, err := db.Begin() if err != nil { return err } defer func() { if p := recover(); p != nil { tx.Rollback() panic(p) } else if err != nil { tx.Rollback() } else { err = tx.Commit() } }() _, err = tx.Exec("CREATE (u:User {name: 'Alice'})") // ... more operations </code></pre></div> <h4 id="prepared-statements-1" class="position-relative d-flex align-items-center group"> 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="prepared-statements-1" aria-haspopup="dialog" aria-label="Share link: Prepared Statements"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go">// Prepare statement stmt, err := db.Prepare(` MATCH (u:User {id: $1}) RETURN u.name, u.email `) if err != nil { log.Fatal(err) } defer stmt.Close() // Execute multiple times for _, id := range []int64{1, 2, 3, 4, 5} { var name, email string err = stmt.QueryRow(id).Scan(&name, &email) if err != nil { log.Println(err) continue } fmt.Printf("%s: %s\n", name, email) } </code></pre></div> <h4 id="error-handling-1" 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-1" aria-haspopup="dialog" aria-label="Share link: Error Handling"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go">import "geodedb.com/geode/geoderr" rows, err := db.Query("MATCH (u:User) WHERE invalid") if err != nil { if geodeErr, ok := err.(*geoderr.Error); ok { fmt.Printf("Geode error: %s\n", geodeErr.Message) fmt.Printf("Status code: %s\n", geodeErr.StatusCode) } else { log.Fatal("Other error:", err) } } </code></pre></div> <h3 id="rust-client-api" class="position-relative d-flex align-items-center group"> Rust Client 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="rust-client-api" aria-haspopup="dialog" aria-label="Share link: Rust Client API"> Share link </button> </h3> <h4 id="installation-2" class="position-relative d-flex align-items-center group"> Installation <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-2" aria-haspopup="dialog" aria-label="Share link: Installation"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-toml" data-lang="toml"># Cargo.toml [dependencies] geode-client = "0.18" tokio = { version = "1", features = ["full"] } </code></pre></div> <h4 id="connection-management-2" 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-2" aria-haspopup="dialog" aria-label="Share link: Connection Management"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-rust" data-lang="rust">use geode_client::{Client, ConnectionPool}; #[tokio::main] async fn main() -> geode_client::Result<()> { // Simple connection let client = Client::new("localhost", 3141).skip_verify(true); let mut conn = client.connect().await?; // Connection pool management let pool = ConnectionPool::new("localhost", 3141, 100).skip_verify(true); let mut pooled = pool.acquire().await?; let (_page, _) = pooled.query("RETURN 1").await?; Ok(()) } </code></pre></div> <h4 id="query-execution-2" class="position-relative d-flex align-items-center group"> Query Execution <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-execution-2" aria-haspopup="dialog" aria-label="Share link: Query Execution"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-rust" data-lang="rust">use geode_client::Value; use std::collections::HashMap; let mut conn = client.connect().await?; // Simple query let (page, _) = conn.query( "MATCH (u:User) RETURN u.name, u.age" ).await?; for row in &page.rows { let name = row.get("name").unwrap().as_string()?; let age = row.get("age").unwrap().as_int()?; println!("{}: {}", name, age); } // Parameterized query (named) let mut params = HashMap::new(); params.insert("min_age".to_string(), Value::int(18)); params.insert("verified".to_string(), Value::bool(true)); let (_page, _) = conn.query_with_params( "MATCH (u:User) WHERE u.age >= $min_age AND u.verified = $verified RETURN u.name, u.age", &params, ).await?; // Execute (no results) let mut create_params = HashMap::new(); create_params.insert("name".to_string(), Value::string("Alice")); create_params.insert("email".to_string(), Value::string("[email protected]")); let (created, _) = conn.query_with_params( "CREATE (u:User {name: $name, email: $email, created_at: CURRENT_TIMESTAMP})", &create_params, ).await?; println!("Created {} nodes", created.rows.len()); </code></pre></div> <h4 id="transaction-management-2" 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-2" aria-haspopup="dialog" aria-label="Share link: Transaction Management"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-rust" data-lang="rust">use geode_client::Value; use std::collections::HashMap; let mut conn = client.connect().await?; // Transaction conn.begin().await?; let mut params = HashMap::new(); params.insert("name".to_string(), Value::string("Alice")); conn.query_with_params("CREATE (u:User {name: $name})", &params).await?; params.insert("name".to_string(), Value::string("Bob")); conn.query_with_params("CREATE (u:User {name: $name})", &params).await?; conn.commit().await?; // Transaction with error handling conn.begin().await?; let result = async { conn.query("CREATE (u:User {name: 'Alice'})").await?; conn.query("CREATE (u:User {name: 'Bob'})").await?; Ok::<(), geode_client::Error>(()) }.await; match result { Ok(_) => conn.commit().await?, Err(e) => { conn.rollback().await?; return Err(e); } } // Savepoint conn.begin().await?; conn.query("CREATE (u:User {name: 'Alice'})").await?; let sp = conn.savepoint("before_bob")?; match conn.query("CREATE (u:User {invalid: ???})").await { Ok(_) => {}, Err(_) => { conn.rollback_to(&sp).await?; } } conn.commit().await?; </code></pre></div> <h4 id="prepared-statements-2" class="position-relative d-flex align-items-center group"> 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="prepared-statements-2" aria-haspopup="dialog" aria-label="Share link: Prepared Statements"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-rust" data-lang="rust">use geode_client::Value; use std::collections::HashMap; let mut conn = client.connect().await?; let stmt = conn.prepare( "MATCH (u:User {id: $id}) RETURN u.name, u.email" )?; // Execute multiple times for id in [1, 2, 3, 4, 5] { let mut params = HashMap::new(); params.insert("id".to_string(), Value::int(id)); let (page, _) = stmt.execute(&mut conn, &params).await?; for row in &page.rows { let name = row.get("name").unwrap().as_string()?; let email = row.get("email").unwrap().as_string()?; println!("{}: {}", name, email); } } </code></pre></div> <h4 id="error-handling-2" 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-2" aria-haspopup="dialog" aria-label="Share link: Error Handling"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-rust" data-lang="rust">use geode_client::{Error, ErrorKind}; match client.query("MATCH (u:User) WHERE invalid", &[]).await { Ok(result) => { /* handle result */ }, Err(Error::Query(e)) => { eprintln!("Query error: {}", e.message); eprintln!("Status: {}", e.status_code); }, Err(Error::Connection(e)) => { eprintln!("Connection error: {}", e); }, Err(e) => { eprintln!("Other error: {}", e); } } </code></pre></div> <h3 id="zig-client-api" class="position-relative d-flex align-items-center group"> Zig Client 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="zig-client-api" aria-haspopup="dialog" aria-label="Share link: Zig Client API"> Share link </button> </h3> <h4 id="integration" class="position-relative d-flex align-items-center group"> 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="integration" aria-haspopup="dialog" aria-label="Share link: Integration"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-zig" data-lang="zig">const std = @import("std"); const geode = @import("geode_client"); pub fn main() !void { var gpa = std.heap.GeneralPurposeAllocator(.{}){}; defer _ = gpa.deinit(); const allocator = gpa.allocator(); // Connect var client = try geode.Client.connect(allocator, "localhost", 3141); defer client.deinit(); // Query const result = try client.query("MATCH (n:User) RETURN n.name LIMIT 10", .{}); defer result.deinit(); while (try result.next()) |row| { const name = row.get("name").?; std.debug.print("Name: {s}\n", .{name.string}); } } </code></pre></div> <h3 id="common-integration-patterns" class="position-relative d-flex align-items-center group"> Common Integration 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="common-integration-patterns" aria-haspopup="dialog" aria-label="Share link: Common Integration Patterns"> Share link </button> </h3> <h4 id="connection-pooling" class="position-relative d-flex align-items-center group"> 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="connection-pooling" aria-haspopup="dialog" aria-label="Share link: Connection Pooling"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-python" data-lang="python"># Python: Built-in connection pool client = Client("localhost:3141", max_connections=100) # Go: Standard database/sql pooling db.SetMaxOpenConns(100) db.SetMaxIdleConns(10) # Rust: Custom pool let pool = Pool::new("localhost:3141", 100).await?; </code></pre></div> <h4 id="retry-logic" class="position-relative d-flex align-items-center group"> 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="retry-logic" aria-haspopup="dialog" aria-label="Share link: Retry Logic"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-python" data-lang="python"># Python with exponential backoff import asyncio async def query_with_retry(client, query, params, max_retries=3): for attempt in range(max_retries): try: return await client.query(query, params) except ConnectionError: if attempt == max_retries - 1: raise await asyncio.sleep(2 ** attempt) # Exponential backoff </code></pre></div><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go">// Go with retry func queryWithRetry(db *sql.DB, query string, args ...interface{}) (*sql.Rows, error) { maxRetries := 3 for i := 0; i < maxRetries; i++ { rows, err := db.Query(query, args...) if err == nil { return rows, nil } if i < maxRetries-1 { time.Sleep(time.Duration(1<<uint(i)) * time.Second) } } return nil, fmt.Errorf("query failed after %d retries", maxRetries) } </code></pre></div> <h4 id="batch-operations" class="position-relative d-flex align-items-center group"> 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="batch-operations" aria-haspopup="dialog" aria-label="Share link: Batch Operations"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-python" data-lang="python"># Python batch insert async with client.connection() as tx: await tx.begin() for i in range(1000): await tx.execute(""" CREATE (u:User { id: $id, name: $name, created_at: CURRENT_TIMESTAMP }) """, {"id": i, "name": f"User{i}"}) </code></pre></div><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go">// Go batch insert tx, _ := db.Begin() stmt, _ := tx.Prepare("CREATE (u:User {id: $1, name: $2})") for i := 0; i < 1000; i++ { _, err := stmt.Exec(i, fmt.Sprintf("User%d", i)) if err != nil { tx.Rollback() return err } } stmt.Close() tx.Commit() </code></pre></div> <h4 id="stream-processing" class="position-relative d-flex align-items-center group"> Stream Processing <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="stream-processing" aria-haspopup="dialog" aria-label="Share link: Stream Processing"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-python" data-lang="python"># Python async streaming async def process_large_result(): result, _ = await client.query("MATCH (n:User) RETURN n") for row in result.rows: await process_user(row) # Memory efficient: only one row in memory at a time </code></pre></div><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-rust" data-lang="rust">// Rust streaming let result = client.query("MATCH (n:User) RETURN n", &[]).await?; for row in result.rows() { process_user(&row)?; // Stream-based iteration } </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><ol> <li>Use Connection Pooling: Configure appropriate pool sizes for your workload</li> <li>Parameterize Queries: Always use parameters to prevent injection attacks</li> <li>Handle Errors: Implement proper error handling and retry logic</li> <li>Transaction Management: Use context managers or defer patterns for safety</li> <li>Close Resources: Always close connections, statements, and result sets</li> <li>Streaming: Use streaming for large result sets to manage memory</li> <li>Monitoring: Track connection pool metrics and query performance</li> <li>TLS: Enable TLS for production deployments</li> </ol> <h3 id="performance-tips" class="position-relative d-flex align-items-center group"> Performance Tips <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-tips" aria-haspopup="dialog" aria-label="Share link: Performance Tips"> Share link </button> </h3> <h4 id="connection-reuse" class="position-relative d-flex align-items-center group"> Connection Reuse <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-reuse" aria-haspopup="dialog" aria-label="Share link: Connection Reuse"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-python" data-lang="python"># Good: Reuse client connection client = Client(host="localhost", port=3141) async with client.connection() as conn: for i in range(100): await conn.query("MATCH (n:User {id: $id}) RETURN n", {"id": i}) # Avoid: Creating new connection per query for i in range(100): client = Client(host="localhost", port=3141) async with client.connection() as conn: await conn.query("MATCH (n:User {id: $id}) RETURN n", {"id": i}) </code></pre></div> <h4 id="prepared-statements-3" class="position-relative d-flex align-items-center group"> 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="prepared-statements-3" aria-haspopup="dialog" aria-label="Share link: Prepared Statements"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go">// Good: Prepare once, execute many stmt, _ := db.Prepare("MATCH (u:User {id: $1}) RETURN u") defer stmt.Close() for _, id := range ids { stmt.QueryRow(id).Scan(&result) } // Avoid: Preparing repeatedly for _, id := range ids { stmt, _ := db.Prepare("MATCH (u:User {id: $1}) RETURN u") stmt.QueryRow(id).Scan(&result) stmt.Close() } </code></pre></div> <h4 id="batch-transactions" class="position-relative d-flex align-items-center group"> Batch Transactions <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="batch-transactions" aria-haspopup="dialog" aria-label="Share link: Batch Transactions"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-python" data-lang="python"># Good: Single transaction for batch async with client.connection() as tx: await tx.begin() for item in items: await tx.execute("CREATE (n:Node {data: $data})", {"data": item}) # Avoid: Transaction per operation for item in items: async with client.connection() as tx: await tx.begin() await tx.execute("CREATE (n:Node {data: $data})", {"data": item}) </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>Query Language: GQL query syntax</li> <li>Transactions: Transaction management</li> <li>Security: Authentication and authorization</li> <li>Performance: Query optimization</li> <li>Deployment: Production deployment</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><a href="/docs/client-libraries/python-client/" >Python Client</a> - Complete Python API documentation</li> <li><a href="/docs/client-libraries/go-client/" >Go Client</a> - Complete Go API documentation</li> <li><a href="/docs/client-libraries/rust-client/" >Rust Client</a> - Complete Rust API documentation</li> <li><a href="/docs/client-libraries/nodejs-client/" >Node.js Client</a> - Complete Node.js API documentation</li> <li><a href="/docs/client-libraries/zig-client/" >Zig Client</a> - Complete Zig API documentation</li> <li><a href="/tags/query-language/" >Query Language</a> - GQL syntax reference</li> </ul> Geode’s client libraries provide consistent, production-ready APIs across multiple languages, enabling seamless integration with your application stack while maintaining high performance and reliability.

Popular

Related Articles

API Reference and CLI Manual