Software Development Kits (SDKs)

<h2 id="software-development-kits-sdks" class="position-relative d-flex align-items-center group"> Software Development Kits (SDKs) <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="software-development-kits-sdks" aria-haspopup="dialog" aria-label="Share link: Software Development Kits (SDKs)"> 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>Geode provides production-ready SDKs for Go, Python, Node.js, Rust, and Zig, enabling developers to integrate graph database capabilities into applications with minimal setup. Each SDK is designed to leverage language-specific features while maintaining consistent behavior across platforms through adherence to the ISO/IEC 39075:2024 GQL standard. <h3 id="overview" class="position-relative d-flex align-items-center group"> 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="overview" aria-haspopup="dialog" aria-label="Share link: Overview"> Share link </button> </h3>Geode’s SDKs provide: <ul> <li>Native Language Integration: Idiomatic APIs for each language</li> <li>Type Safety: Strong typing where supported (Go, Rust, Zig)</li> <li>Async Support: Native async/await in Python and Rust</li> <li>Connection Pooling: Built-in connection management for performance</li> <li>Transaction Management: Full ACID transaction support with savepoints</li> <li>Error Handling: Language-appropriate error types with ISO error codes</li> <li>Performance: Optimized for high-throughput workloads (runtime and workload dependent)</li> </ul> <h3 id="sdk-comparison-matrix" class="position-relative d-flex align-items-center group"> SDK Comparison Matrix <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="sdk-comparison-matrix" aria-haspopup="dialog" aria-label="Share link: SDK Comparison Matrix"> Share link </button> </h3><table> <thead> <tr> <th>Feature</th> <th>Go</th> <th>Python</th> <th>Node.js</th> <th>Rust</th> <th>Zig</th> </tr> </thead> <tbody> <tr> <td>Installation</td> <td><code>go get</code></td> <td><code>pip install</code></td> <td><code>npm install</code></td> <td><code>cargo add</code></td> <td><code>zig fetch</code></td> </tr> <tr> <td>Async Support</td> <td>Context-aware</td> <td>async/await</td> <td>async/await</td> <td>tokio</td> <td>Event loop</td> </tr> <tr> <td>Type Safety</td> <td>Strong</td> <td>Type hints</td> <td>TypeScript types</td> <td>Strong</td> <td>Strong</td> </tr> <tr> <td>Connection Pool</td> <td>database/sql</td> <td>ConnectionPool</td> <td>Built-in pooling</td> <td>Quinn</td> <td>Custom</td> </tr> <tr> <td>Transaction Support</td> <td>✓</td> <td>✓</td> <td>✓</td> <td>✓</td> <td>Manual</td> </tr> <tr> <td>Prepared Statements</td> <td>✓</td> <td>✓</td> <td>✓</td> <td>✓</td> <td>Manual</td> </tr> <tr> <td>Query Builder</td> <td>Planned</td> <td>✓</td> <td>✓</td> <td>✓</td> <td>Planned</td> </tr> <tr> <td>Performance</td> <td>Workload-dependent</td> <td>Workload-dependent</td> <td>Workload-dependent</td> <td>Workload-dependent</td> <td>Workload-dependent</td> </tr> </tbody> </table> <h3 id="go-sdk" class="position-relative d-flex align-items-center group"> Go SDK <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-sdk" aria-haspopup="dialog" aria-label="Share link: Go SDK"> 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">go get geodedb.com/geode </code></pre></div> <h4 id="quick-start" class="position-relative d-flex align-items-center group"> Quick Start <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="quick-start" aria-haspopup="dialog" aria-label="Share link: Quick Start"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go">package main import ( "database/sql" "fmt" "log" _ "geodedb.com/geode" ) func main() { // Open connection (implements database/sql) 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) // Execute query rows, err := db.Query(` MATCH (p:Person)-[:KNOWS]->(friend:Person) WHERE p.name = $name RETURN friend.name, friend.age `, "Alice") if err != nil { log.Fatal(err) } defer rows.Close() // Iterate results for rows.Next() { var name string var age int if err := rows.Scan(&name, &age); err != nil { log.Fatal(err) } fmt.Printf("%s is %d years old\n", name, age) } } </code></pre></div> <h4 id="features" class="position-relative d-flex align-items-center group"> Features <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="features" aria-haspopup="dialog" aria-label="Share link: Features"> Share link </button> </h4><ul> <li>database/sql Interface: Drop-in replacement for SQL databases</li> <li>Connection Pooling: Automatic connection lifecycle management</li> <li>Prepared Statements: Query compilation and caching</li> <li>Context Support: Timeout and cancellation with context.Context</li> <li>Transaction Support: Full ACID transactions with savepoints</li> </ul> <h4 id="documentation" class="position-relative d-flex align-items-center group"> Documentation <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="documentation" aria-haspopup="dialog" aria-label="Share link: Documentation"> Share link </button> </h4>Full Go SDK documentation: <a href="/docs/client-libraries/go-client/" >Go Client Guide</a> <h3 id="python-sdk" class="position-relative d-flex align-items-center group"> Python SDK <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-sdk" aria-haspopup="dialog" aria-label="Share link: Python SDK"> 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">pip install geode-client </code></pre></div> <h4 id="quick-start-1" class="position-relative d-flex align-items-center group"> Quick Start <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="quick-start-1" aria-haspopup="dialog" aria-label="Share link: Quick Start"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-python" data-lang="python">import asyncio from geode_client import Client async def main(): # Create client with connection pool client = Client(host="localhost", port=3141) async with client.connection() as conn: # Execute query result, _ = await conn.query(""" MATCH (p:Person)-[:KNOWS]->(friend:Person) WHERE p.name = $name RETURN friend.name AS name, friend.age AS age """, {"name": "Alice"}) # Process results for row in result.rows: print(f"{row['name'].as_string} is {row['age'].as_int} years old") # Transaction support await conn.begin() try: await conn.execute( """ CREATE (p:Person {name: $name, age: $age}) """, {"name": "Bob", "age": 30}, ) await conn.commit() except Exception: await conn.rollback() raise asyncio.run(main()) </code></pre></div> <h4 id="features-1" class="position-relative d-flex align-items-center group"> Features <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="features-1" aria-haspopup="dialog" aria-label="Share link: Features"> Share link </button> </h4><ul> <li>Async/Await: Native asyncio integration</li> <li>Connection Pooling: Configurable pool to reduce connection overhead (throughput depends on workload)</li> <li>Query Builder: Type-safe query construction</li> <li>Row-Level Security: Built-in RLS policy management</li> <li>Type System: Comprehensive value type support</li> </ul> <h4 id="documentation-1" class="position-relative d-flex align-items-center group"> Documentation <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="documentation-1" aria-haspopup="dialog" aria-label="Share link: Documentation"> Share link </button> </h4>Full Python SDK documentation: <a href="/docs/client-libraries/python-client/" >Python Client Guide</a> <h3 id="rust-sdk" class="position-relative d-flex align-items-center group"> Rust SDK <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-sdk" aria-haspopup="dialog" aria-label="Share link: Rust SDK"> 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>Add to <code>Cargo.toml</code>: <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> <h4 id="quick-start-2" class="position-relative d-flex align-items-center group"> Quick Start <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="quick-start-2" aria-haspopup="dialog" aria-label="Share link: Quick Start"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-rust" data-lang="rust">use geode_client::{Client, Result, Value}; use std::collections::HashMap; #[tokio::main] async fn main() -> Result<()> { // Connect to Geode let client = Client::new("localhost", 3141).skip_verify(true); let mut conn = client.connect().await?; // Execute query let mut params = HashMap::new(); params.insert("name".to_string(), Value::string("Alice")); let (results, _) = conn.query_with_params( "MATCH (p:Person)-[:KNOWS]->(friend:Person)\n WHERE p.name = $name\n RETURN friend.name AS name, friend.age AS age", &params, ).await?; // Process results for row in &results.rows { let name = row.get("name").unwrap().as_string()?; let age = row.get("age").unwrap().as_int()?; println!("{} is {} years old", name, age); } // Transaction conn.begin().await?; let mut create_params = HashMap::new(); create_params.insert("name".to_string(), Value::string("Bob")); create_params.insert("age".to_string(), Value::int(30)); conn.query_with_params( "CREATE (p:Person {name: $name, age: $age})", &create_params, ).await?; conn.commit().await?; Ok(()) } </code></pre></div> <h4 id="features-2" class="position-relative d-flex align-items-center group"> Features <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="features-2" aria-haspopup="dialog" aria-label="Share link: Features"> Share link </button> </h4><ul> <li>Zero-Cost Abstractions: Compile-time optimization</li> <li>Tokio Integration: Native async runtime</li> <li>Type Safety: Compile-time type checking</li> <li>High Performance: Designed for high-throughput workloads (see server throughput baselines)</li> <li>Serde Integration: Automatic serialization/deserialization</li> </ul> <h4 id="documentation-2" class="position-relative d-flex align-items-center group"> Documentation <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="documentation-2" aria-haspopup="dialog" aria-label="Share link: Documentation"> Share link </button> </h4>Full Rust SDK documentation: <a href="/docs/client-libraries/rust-client/" >Rust Client Guide</a> <h3 id="nodejs-sdk" class="position-relative d-flex align-items-center group"> Node.js SDK <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="nodejs-sdk" aria-haspopup="dialog" aria-label="Share link: Node.js SDK"> Share link </button> </h3> <h4 id="installation-3" 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-3" 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">npm install @geodedb/client </code></pre></div> <h4 id="quick-start-3" class="position-relative d-flex align-items-center group"> Quick Start <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="quick-start-3" aria-haspopup="dialog" aria-label="Share link: Quick Start"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-ts" data-lang="ts">import { createClient } from '@geodedb/client'; const client = await createClient('quic://localhost:3141'); const rows = await client.queryAll( 'MATCH (p:Person) RETURN p.name AS name, p.age AS age' ); console.log(rows); await client.close(); </code></pre></div> <h4 id="features-3" class="position-relative d-flex align-items-center group"> Features <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="features-3" aria-haspopup="dialog" aria-label="Share link: Features"> Share link </button> </h4><ul> <li>TypeScript-first API with strong typing</li> <li>Connection pooling enabled by default</li> <li>Streaming queries via async iterators</li> <li>Transactions with <code>withTransaction</code> and savepoints</li> </ul> <h4 id="documentation-3" class="position-relative d-flex align-items-center group"> Documentation <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="documentation-3" aria-haspopup="dialog" aria-label="Share link: Documentation"> Share link </button> </h4>Full Node.js SDK documentation: <a href="/docs/client-libraries/nodejs-client/" >Node.js Client Guide</a> <h3 id="zig-sdk" class="position-relative d-flex align-items-center group"> Zig SDK <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-sdk" aria-haspopup="dialog" aria-label="Share link: Zig SDK"> Share link </button> </h3> <h4 id="installation-4" 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-4" aria-haspopup="dialog" aria-label="Share link: Installation"> Share link </button> </h4>Add to <code>build.zig.zon</code>: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-zig" data-lang="zig">.dependencies = .{ .geode_client = .{ .url = "https://gitlab.com/devnw/codepros/geode/geode-client-zig/archive/v0.1.0.tar.gz", .hash = "...", }, } </code></pre></div> <h4 id="quick-start-4" class="position-relative d-flex align-items-center group"> Quick Start <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="quick-start-4" aria-haspopup="dialog" aria-label="Share link: Quick Start"> 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(); var client = geode.GeodeClient.init(allocator, "localhost", 3141, true); defer client.deinit(); try client.connect(); try client.openStream(); try client.sendHello("docs-sdk", "1.0.0"); const hello = try client.receiveMessage(30000); defer allocator.free(hello); // Execute a parameterized query var params = std.json.ObjectMap.init(allocator); defer params.deinit(); try params.put("name", .{ .string = "Alice" }); try client.sendRunGql(1, \\MATCH (p:Person)-[:KNOWS]->(friend:Person) \\WHERE p.name = $name \\RETURN friend.name, friend.age , .{ .object = params }); const schema = try client.receiveMessage(30000); defer allocator.free(schema); try client.sendPull(1, 1000); const result = try client.receiveMessage(30000); defer allocator.free(result); std.debug.print("Result: {s}\\n", .{result}); } </code></pre></div> <h4 id="features-4" class="position-relative d-flex align-items-center group"> Features <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="features-4" aria-haspopup="dialog" aria-label="Share link: Features"> Share link </button> </h4><ul> <li>Memory Safety: Compile-time memory management</li> <li>Performance: Workload-dependent throughput with low client overhead</li> <li>Comptime Features: Compile-time query validation</li> <li>Vendored QUIC: No external dependencies</li> <li>Cross-Platform: Linux, macOS, Windows support</li> </ul> <h4 id="documentation-4" class="position-relative d-flex align-items-center group"> Documentation <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="documentation-4" aria-haspopup="dialog" aria-label="Share link: Documentation"> Share link </button> </h4>Full Zig SDK documentation: <a href="/docs/client-libraries/zig-client/" >Zig Client Guide</a> <h3 id="common-sdk-patterns" class="position-relative d-flex align-items-center group"> Common SDK 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-sdk-patterns" aria-haspopup="dialog" aria-label="Share link: Common SDK Patterns"> 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>Go: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go">db, err := sql.Open("geode", "quic://localhost:3141") db.SetMaxOpenConns(100) db.SetMaxIdleConns(10) db.SetConnMaxLifetime(time.Hour) </code></pre></div>Python: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-python" data-lang="python">from geode_client import ConnectionPool pool = ConnectionPool( url="localhost:3141", min_connections=10, max_connections=100, max_idle_time=300 ) </code></pre></div>Rust: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-rust" data-lang="rust">let client = Client::builder() .url("localhost:3141") .max_connections(100) .connect() .await?; </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>Go: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go">import "geodedb.com/geode/errors" if err != nil { if errors.IsSyntaxError(err) { log.Printf("Query syntax error: %v", err) } else if errors.IsConstraintViolation(err) { log.Printf("Constraint violation: %v", err) } else { log.Printf("Unexpected error: %v", err) } } </code></pre></div>Python: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-python" data-lang="python">from geode_client import Client, SyntaxError, ConstraintViolation try: result, _ = await client.query(query) except SyntaxError as e: print(f"Query syntax error: {e}") except ConstraintViolation as e: print(f"Constraint violation: {e}") </code></pre></div>Rust: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-rust" data-lang="rust">use geode_client::Error; match client.execute(query, params).await { Ok(results) => process_results(results), Err(Error::SyntaxError(msg)) => eprintln!("Syntax error: {}", msg), Err(Error::ConstraintViolation(msg)) => eprintln!("Constraint: {}", msg), Err(e) => eprintln!("Error: {}", e), } </code></pre></div> <h4 id="transaction-patterns" class="position-relative d-flex align-items-center group"> Transaction 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="transaction-patterns" aria-haspopup="dialog" aria-label="Share link: Transaction Patterns"> Share link </button> </h4>All SDKs support ACID transactions: Go: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go">tx, err := db.Begin() defer tx.Rollback() // Safe to call even after commit _, err = tx.Exec("CREATE (n:Node {id: $id})", 1) _, err = tx.Exec("CREATE (m:Node {id: $id})", 2) err = tx.Commit() </code></pre></div>Python: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-python" data-lang="python">async with client.connection() as conn: await conn.begin() try: await conn.execute("CREATE (n:Node {id: $id})", {"id": 1}) await conn.execute("CREATE (m:Node {id: $id})", {"id": 2}) await conn.commit() except Exception: await conn.rollback() raise </code></pre></div>Rust: <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?; conn.begin().await?; let mut params = HashMap::new(); params.insert("id".to_string(), Value::int(1)); conn.query_with_params("CREATE (n:Node {id: $id})", &params).await?; params.insert("id".to_string(), Value::int(2)); conn.query_with_params("CREATE (m:Node {id: $id})", &params).await?; conn.commit().await?; </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>Go: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go">stmt, err := db.Prepare("MATCH (n:Node {id: $id}) RETURN n") defer stmt.Close() for id := 1; id <= 100; id++ { var node Node err := stmt.QueryRow(id).Scan(&node) } </code></pre></div>Python: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-python" data-lang="python">stmt = await conn.prepare( "MATCH (n:Node {id: $id}) RETURN n" ) for i in range(100): result, _ = await stmt.execute({"id": i}) </code></pre></div> <h3 id="performance-best-practices" class="position-relative d-flex align-items-center group"> Performance 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="performance-best-practices" aria-haspopup="dialog" aria-label="Share link: Performance Best Practices"> Share link </button> </h3><ol> <li>Use Connection Pools: Always configure appropriate pool sizes</li> <li>Prepare Statements: Prepare frequently-used queries</li> <li>Batch Operations: Group multiple operations in transactions</li> <li>Async Where Available: Use async SDKs (Python, Rust) for I/O-bound workloads</li> <li>Limit Result Sets: Use LIMIT clause to avoid large result transfers</li> <li>Index Usage: Ensure queries use appropriate indexes</li> </ol> <h3 id="testing-with-sdks" class="position-relative d-flex align-items-center group"> Testing with SDKs <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-with-sdks" aria-haspopup="dialog" aria-label="Share link: Testing with SDKs"> Share link </button> </h3> <h4 id="go-testing" class="position-relative d-flex align-items-center group"> Go Testing <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-testing" aria-haspopup="dialog" aria-label="Share link: Go Testing"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go">func TestGeodeIntegration(t *testing.T) { db, err := sql.Open("geode", os.Getenv("GEODE_URL")) require.NoError(t, err) defer db.Close() // Clean up test data _, err = db.Exec("MATCH (n:TestNode) DELETE n") require.NoError(t, err) // Test query _, err = db.Exec("CREATE (n:TestNode {id: $id})", 1) require.NoError(t, err) var count int err = db.QueryRow("MATCH (n:TestNode) RETURN COUNT(n)").Scan(&count) require.NoError(t, err) assert.Equal(t, 1, count) } </code></pre></div> <h4 id="python-testing" class="position-relative d-flex align-items-center group"> Python Testing <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-testing" aria-haspopup="dialog" aria-label="Share link: Python Testing"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-python" data-lang="python">import pytest from geode_client import Client @pytest.fixture async def client(): client = Client(host="localhost", port=3141) async with client.connection() as conn: # Clean up test data await conn.execute("MATCH (n:TestNode) DELETE n") yield conn @pytest.mark.asyncio async def test_create_node(client): await client.execute( "CREATE (n:TestNode {id: $id})", {"id": 1} ) result, _ = await client.query( "MATCH (n:TestNode) RETURN COUNT(n) AS count" ) assert result.rows[0]['count'] == 1 </code></pre></div> <h3 id="migration-guides" class="position-relative d-flex align-items-center group"> Migration Guides <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="migration-guides" aria-haspopup="dialog" aria-label="Share link: Migration Guides"> Share link </button> </h3> <h4 id="from-neo4j-driver" class="position-relative d-flex align-items-center group"> From Neo4j Driver <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="from-neo4j-driver" aria-haspopup="dialog" aria-label="Share link: From Neo4j Driver"> Share link </button> </h4>Neo4j (Python): <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-python" data-lang="python">from neo4j import GraphDatabase driver = GraphDatabase.driver("bolt://localhost:7687") with driver.session() as session: result = session.run( "MATCH (p:Person {name: $name}) RETURN p", name="Alice" ) </code></pre></div>Geode (Python): <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-python" data-lang="python">from geode_client import Client client = Client(host="localhost", port=3141) async with client.connection() as conn: result, _ = await conn.query( "MATCH (p:Person {name: $name}) RETURN p", {"name": "Alice"} ) </code></pre></div> <h4 id="from-sql" class="position-relative d-flex align-items-center group"> From SQL <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="from-sql" aria-haspopup="dialog" aria-label="Share link: From SQL"> Share link </button> </h4>SQL (Go): <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go">rows, err := db.Query("SELECT * FROM users WHERE name = ?", "Alice") </code></pre></div>GQL (Go with Geode): <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go">rows, err := db.Query("MATCH (u:User {name: $name}) RETURN u", "Alice") </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><a href="/tags/client-libraries/" >Client Libraries</a> - Detailed client documentation</li> <li><a href="/tags/api/" >API Development</a> - API integration patterns</li> <li><a href="/tags/integration/" >Integration</a> - System integration guide</li> <li><a href="/tags/gql-syntax/" >GQL Syntax</a> - Query language reference</li> <li><a href="/tags/examples/" >Examples</a> - Code examples and patterns</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/go-client/" >Go SDK Documentation</a> - Complete Go guide</li> <li><a href="/docs/client-libraries/python-client/" >Python SDK Documentation</a> - Python reference</li> <li><a href="/docs/client-libraries/rust-client/" >Rust SDK Documentation</a> - Rust guide</li> <li><a href="/docs/client-libraries/nodejs-client/" >Node.js SDK Documentation</a> - Node.js guide</li> <li><a href="/docs/client-libraries/zig-client/" >Zig SDK Documentation</a> - Zig reference</li> </ul>

Popular

Related Articles

Client Libraries