Client Libraries - Official Geode SDKs for Go, Python, Rust, Zig, and Node.js | Tags

<h2 id="geode-client-libraries" class="position-relative d-flex align-items-center group"> Geode 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="geode-client-libraries" aria-haspopup="dialog" aria-label="Share link: Geode Client Libraries"> 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 official client libraries for Go, Python, Rust, Zig, and Node.js/TypeScript. Each client uses the same QUIC + TLS 1.3 wire protocol while exposing language-idiomatic APIs for developers. <h3 id="introduction" class="position-relative d-flex align-items-center group"> Introduction <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="introduction" aria-haspopup="dialog" aria-label="Share link: Introduction"> Share link </button> </h3>Geode client libraries are designed with common principles: <ul> <li>Secure by Default: All connections use QUIC with TLS 1.3 encryption</li> <li>High Performance: Native async support and connection pooling</li> <li>Type Safety: Strong typing appropriate to each language</li> <li>GQL Standard: ISO/IEC 39075:2024 compliance</li> <li>Consistent Protocol: Protobuf wire protocol over QUIC streams</li> </ul> <h4 id="choosing-a-client-library" class="position-relative d-flex align-items-center group"> Choosing a Client Library <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="choosing-a-client-library" aria-haspopup="dialog" aria-label="Share link: Choosing a Client Library"> Share link </button> </h4><table> <thead> <tr> <th>Language</th> <th>Best For</th> <th>Key Features</th> </tr> </thead> <tbody> <tr> <td>Go</td> <td>Microservices, APIs</td> <td><code>database/sql</code> driver, prepared statements</td> </tr> <tr> <td>Python</td> <td>Data science, ML, scripting</td> <td>Async/await, query builders, RLS support</td> </tr> <tr> <td>Rust</td> <td>High-performance systems</td> <td>Zero-cost abstractions, tokio integration</td> </tr> <tr> <td>Zig</td> <td>Systems programming, embedded</td> <td>Low overhead, vendored QUIC</td> </tr> <tr> <td>Node.js</td> <td>Web applications, APIs</td> <td>TypeScript support, async patterns</td> </tr> </tbody> </table> <h3 id="go-client-library" class="position-relative d-flex align-items-center group"> Go Client Library <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-library" aria-haspopup="dialog" aria-label="Share link: Go Client Library"> Share link </button> </h3>The Go client implements the standard <code>database/sql</code> interface, making it familiar to Go developers and compatible with existing database tooling. <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 ( "context" "database/sql" "fmt" "log" _ "geodedb.com/geode" ) func main() { // Open connection using standard database/sql db, err := sql.Open("geode", "localhost:3141") if err != nil { log.Fatal(err) } defer db.Close() // Execute GQL queries rows, err := db.QueryContext(context.Background(), "MATCH (p:Person) WHERE p.age > $1 RETURN p.name, p.age", 25, ) 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 is %d years old\n", name, age) } } </code></pre></div> <h4 id="connection-string-options" class="position-relative d-flex align-items-center group"> Connection String Options <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-string-options" aria-haspopup="dialog" aria-label="Share link: Connection String Options"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go">// Full DSN with all options dsn := "localhost:3141?" + "page_size=1000&" + "hello_name=myapp&" + "hello_ver=1.0.0&" + "conformance=full&" + "ca=/path/to/ca.crt&" + "cert=/path/to/client.crt&" + "key=/path/to/client.key&" + "insecure_tls_skip_verify=false" db, err := sql.Open("geode", dsn) </code></pre></div><table> <thead> <tr> <th>Option</th> <th>Description</th> <th>Default</th> </tr> </thead> <tbody> <tr> <td><code>page_size</code></td> <td>Results per page</td> <td>1000</td> </tr> <tr> <td><code>hello_name</code></td> <td>Client application name</td> <td>“geode-go”</td> </tr> <tr> <td><code>hello_ver</code></td> <td>Client version string</td> <td>library version</td> </tr> <tr> <td><code>conformance</code></td> <td>GQL conformance level</td> <td>“strict”</td> </tr> <tr> <td><code>ca</code></td> <td>CA certificate path</td> <td>system CAs</td> </tr> <tr> <td><code>cert</code></td> <td>Client certificate path</td> <td>none</td> </tr> <tr> <td><code>key</code></td> <td>Client private key path</td> <td>none</td> </tr> <tr> <td><code>insecure_tls_skip_verify</code></td> <td>Skip TLS verification</td> <td>false</td> </tr> </tbody> </table> <h4 id="transactions" class="position-relative d-flex align-items-center group"> 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="transactions" aria-haspopup="dialog" aria-label="Share link: Transactions"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go">func transferFunds(db *sql.DB, from, to string, amount float64) error { tx, err := db.BeginTx(context.Background(), nil) if err != nil { return err } defer tx.Rollback() // Debit source account _, err = tx.ExecContext(context.Background(), ` MATCH (a:Account {id: $1}) SET a.balance = a.balance - $2 `, from, amount) if err != nil { return err } // Credit destination account _, err = tx.ExecContext(context.Background(), ` MATCH (a:Account {id: $1}) SET a.balance = a.balance + $2 `, to, amount) if err != nil { return err } return tx.Commit() } </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-go" data-lang="go">// Prepare once, execute many times stmt, err := db.PrepareContext(context.Background(), "MATCH (p:Product {category: $1}) RETURN p.name, p.price LIMIT $2") if err != nil { log.Fatal(err) } defer stmt.Close() // Execute with different parameters categories := []string{"Electronics", "Books", "Clothing"} for _, cat := range categories { rows, err := stmt.QueryContext(context.Background(), cat, 10) if err != nil { log.Fatal(err) } // Process rows... rows.Close() } </code></pre></div> <h3 id="python-client-library" class="position-relative d-flex align-items-center group"> Python Client Library <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-library" aria-haspopup="dialog" aria-label="Share link: Python Client Library"> Share link </button> </h3>The Python client is async-first, built on aioquic for high-performance QUIC transport with full asyncio integration. <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(): client = Client(host="localhost", port=3141) async with client.connection() as conn: # Simple query page, _ = await conn.query( "MATCH (p:Person) RETURN p.name AS name, p.age AS age" ) for row in page.rows: print(f"{row['name'].as_string}: {row['age'].as_int}") asyncio.run(main()) </code></pre></div> <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">from geode_client import Client, ConnectionPool async def with_pool(): # Create pool with configuration pool = ConnectionPool( host="localhost", port=3141, min_connections=5, max_connections=20, connection_timeout=30.0 ) await pool.initialize() try: # Acquire connection from pool async with pool.connection() as conn: result, _ = await conn.query("MATCH (n) RETURN count(n) AS total") print(f"Total nodes: {result.rows[0]['total'].as_int}") finally: await pool.close() </code></pre></div> <h4 id="parameterized-queries" class="position-relative d-flex align-items-center group"> Parameterized Queries <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="parameterized-queries" aria-haspopup="dialog" aria-label="Share link: Parameterized Queries"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-python" data-lang="python">async def find_users(conn, min_age: int, city: str): result, schema = await conn.query( """ MATCH (u:User)-[:LIVES_IN]->(c:City {name: $city}) WHERE u.age >= $min_age RETURN u.name AS name, u.email AS email, u.age AS age ORDER BY u.age DESC """, {"min_age": min_age, "city": city} ) return [ { "name": row['name'].as_string, "email": row['email'].as_string, "age": row['age'].as_int } for row in result.rows ] </code></pre></div> <h4 id="transactions-with-savepoints" class="position-relative d-flex align-items-center group"> Transactions with Savepoints <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="transactions-with-savepoints" aria-haspopup="dialog" aria-label="Share link: Transactions with Savepoints"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-python" data-lang="python">async def complex_operation(conn): async with conn.transaction() as tx: # Create user await tx.execute(""" CREATE (u:User {user_id: $id, name: $name, email: $email}) """, {"id": "user_123", "name": "Alice", "email": "[email protected]"}) # Create savepoint before risky operation savepoint = await tx.savepoint("before_preferences") try: # This might fail await tx.execute(""" MATCH (u:User {user_id: $id}) CREATE (u)-[:PREFERS]->(:Category {name: $category}) """, {"id": "user_123", "category": "InvalidCategory"}) except Exception: # Rollback to savepoint, continue transaction await tx.rollback_to(savepoint) # Use default category instead await tx.execute(""" MATCH (u:User {user_id: $id}) CREATE (u)-[:PREFERS]->(:Category {name: 'General'}) """, {"id": "user_123"}) # Transaction commits successfully </code></pre></div> <h4 id="query-builders" class="position-relative d-flex align-items-center group"> Query Builders <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-builders" aria-haspopup="dialog" aria-label="Share link: Query Builders"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-python" data-lang="python">from geode_client.query import QueryBuilder, PatternBuilder # Build queries programmatically query = (QueryBuilder() .match(PatternBuilder() .node("u", "User") .rel("r", "FOLLOWS", direction="out") .node("f", "User") .build()) .where("u.user_id = $user_id") .return_("f.name AS friend_name", "r.since AS followed_since") .order_by("r.since DESC") .limit(10) .build()) result, _ = await conn.query(query, {"user_id": "user_456"}) </code></pre></div> <h3 id="rust-client-library" class="position-relative d-flex align-items-center group"> Rust Client Library <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-library" aria-haspopup="dialog" aria-label="Share link: Rust Client Library"> Share link </button> </h3>The Rust client uses Quinn for QUIC transport and tokio for async execution, providing zero-cost abstractions and high performance. <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">[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, Config}; use tokio; #[tokio::main] async fn main() -> Result<(), Box<dyn std::error::Error>> { let config = Config::new("localhost", 3141); let client = Client::new(config)?; let mut conn = client.connect().await?; // Execute query let (page, schema) = conn.query( "MATCH (p:Person) RETURN p.name AS name, p.age AS age" ).await?; for row in page.rows { let name: String = row.get("name")?; let age: i64 = row.get("age")?; println!("{}: {} years old", name, age); } Ok(()) } </code></pre></div> <h4 id="typed-value-extraction" class="position-relative d-flex align-items-center group"> Typed Value Extraction <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="typed-value-extraction" aria-haspopup="dialog" aria-label="Share link: Typed Value Extraction"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-rust" data-lang="rust">use geode_client::Value; fn process_results(page: Page) -> Result<Vec<Person>, Error> { page.rows.iter().map(|row| { Ok(Person { id: row.get::<String>("id")?, name: row.get::<String>("name")?, age: row.get::<i64>("age")?, email: row.get::<Option<String>>("email")?, // Nullable tags: row.get::<Vec<String>>("tags")?, // List metadata: row.get::<HashMap<String, Value>>("meta")?, // Map }) }).collect() } </code></pre></div> <h4 id="connection-pooling-1" 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-1" aria-haspopup="dialog" aria-label="Share link: Connection Pooling"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-rust" data-lang="rust">use geode_client::{Pool, PoolConfig}; async fn with_pool() -> Result<(), Error> { let pool_config = PoolConfig { min_connections: 5, max_connections: 50, connection_timeout: Duration::from_secs(30), idle_timeout: Duration::from_secs(300), }; let pool = Pool::new("localhost", 3141, pool_config).await?; // Acquire connection from pool let conn = pool.get().await?; let (page, _) = conn.query("MATCH (n) RETURN count(n) AS c").await?; println!("Count: {}", page.rows[0].get::<i64>("c")?); // Connection returned to pool when dropped Ok(()) } </code></pre></div> <h4 id="query-builder" class="position-relative d-flex align-items-center group"> Query Builder <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-builder" aria-haspopup="dialog" aria-label="Share link: Query Builder"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-rust" data-lang="rust">use geode_client::query::{Query, Pattern}; let query = Query::new() .match_pattern( Pattern::node("p", "Product") .with_property("category", &category) ) .where_clause("p.price < $max_price") .return_fields(&["p.name", "p.price"]) .order_by("p.price ASC") .limit(20) .build(); let (page, _) = conn.query_with_params( &query, params! { "max_price" => 100.0 } ).await?; </code></pre></div> <h3 id="zig-client-library" class="position-relative d-flex align-items-center group"> Zig Client Library <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-library" aria-haspopup="dialog" aria-label="Share link: Zig Client Library"> Share link </button> </h3>The Zig client provides low-level control with vendored QUIC implementation, ideal for systems programming and embedded applications. <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>Add to your <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://github.com/geodedb/geode-client-zig/archive/v0.1.0.tar.gz", .hash = "...", }, }, </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-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 to Geode var client = try geode.Client.init(allocator, "localhost", 3141); defer client.deinit(); // Execute query const result = try client.query( "MATCH (p:Person) RETURN p.name AS name, p.age AS age", &.{}, ); defer result.deinit(); // Process results for (result.rows) |row| { const name = row.getString("name") orelse continue; const age = row.getInt("age") orelse continue; std.debug.print("{s}: {d} years old\n", .{ name, age }); } } </code></pre></div> <h4 id="parameterized-queries-1" class="position-relative d-flex align-items-center group"> Parameterized Queries <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="parameterized-queries-1" aria-haspopup="dialog" aria-label="Share link: Parameterized Queries"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-zig" data-lang="zig">const params = .{ .min_age = @as(i64, 21), .city = "San Francisco", }; const result = try client.query( \\MATCH (u:User)-[:LIVES_IN]->(c:City {name: $city}) \\WHERE u.age >= $min_age \\RETURN u.name AS name, u.age AS age , params); defer result.deinit(); </code></pre></div> <h4 id="transaction-support" class="position-relative d-flex align-items-center group"> Transaction Support <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-support" aria-haspopup="dialog" aria-label="Share link: Transaction Support"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-zig" data-lang="zig">// Begin transaction var tx = try client.beginTransaction(); errdefer tx.rollback() catch {}; // Execute operations try tx.execute( "CREATE (u:User {id: $id, name: $name})", .{ .id = "user_001", .name = "Bob" }, ); try tx.execute( "MATCH (u:User {id: $id}) CREATE (u)-[:OWNS]->(:Account {balance: 0})", .{ .id = "user_001" }, ); // Commit transaction try tx.commit(); </code></pre></div> <h3 id="nodejs--typescript-client" class="position-relative d-flex align-items-center group"> Node.js / TypeScript 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="nodejs--typescript-client" aria-haspopup="dialog" aria-label="Share link: Node.js / TypeScript Client"> Share link </button> </h3>The Node.js client provides full TypeScript support with async patterns familiar to JavaScript developers. <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><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash">npm install @geodedb/client # or yarn add @geodedb/client </code></pre></div> <h4 id="quick-start-typescript" class="position-relative d-flex align-items-center group"> Quick Start (TypeScript) <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-typescript" aria-haspopup="dialog" aria-label="Share link: Quick Start (TypeScript)"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-typescript" data-lang="typescript">import { Client, Connection } from '@geodedb/client'; async function main() { const client = new Client({ host: 'localhost', port: 3141, }); const conn = await client.connect(); try { const { rows, schema } = await conn.query<{ name: string; age: number; }>('MATCH (p:Person) RETURN p.name AS name, p.age AS age'); for (const row of rows) { console.log(`${row.name}: ${row.age} years old`); } } finally { await conn.close(); } } main().catch(console.error); </code></pre></div> <h4 id="type-safe-queries" class="position-relative d-flex align-items-center group"> Type-Safe Queries <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="type-safe-queries" aria-haspopup="dialog" aria-label="Share link: Type-Safe Queries"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-typescript" data-lang="typescript">// Define result types interface UserNode { userId: string; name: string; email: string; createdAt: Date; } interface FollowRelation { since: Date; strength: number; } // Query with type inference const result = await conn.query<{ user: UserNode; follows: UserNode; rel: FollowRelation; }>(` MATCH (u:User {userId: $userId})-[r:FOLLOWS]->(f:User) RETURN u AS user, f AS follows, r AS rel `, { userId: 'user_123' }); // TypeScript knows the types for (const { user, follows, rel } of result.rows) { console.log(`${user.name} follows ${follows.name} since ${rel.since}`); } </code></pre></div> <h4 id="connection-pool" class="position-relative d-flex align-items-center group"> Connection Pool <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-pool" aria-haspopup="dialog" aria-label="Share link: Connection Pool"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-typescript" data-lang="typescript">import { Pool } from '@geodedb/client'; const pool = new Pool({ host: 'localhost', port: 3141, minConnections: 5, maxConnections: 20, idleTimeout: 60000, }); // Use pool async function queryWithPool() { const conn = await pool.acquire(); try { const result = await conn.query('MATCH (n) RETURN count(n) AS total'); return result.rows[0].total; } finally { pool.release(conn); } } </code></pre></div> <h3 id="wire-protocol-overview" class="position-relative d-flex align-items-center group"> Wire Protocol 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="wire-protocol-overview" aria-haspopup="dialog" aria-label="Share link: Wire Protocol Overview"> Share link </button> </h3>All Geode clients use the same Protobuf wire protocol over QUIC (default) or gRPC: <h4 id="message-types" class="position-relative d-flex align-items-center group"> Message Types <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="message-types" aria-haspopup="dialog" aria-label="Share link: Message Types"> Share link </button> </h4><table> <thead> <tr> <th>Client Message</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td><code>HelloRequest</code></td> <td>Connection handshake with client info</td> </tr> <tr> <td><code>ExecuteRequest</code></td> <td>Execute GQL query</td> </tr> <tr> <td><code>PullRequest</code></td> <td>Fetch result rows</td> </tr> <tr> <td><code>BeginRequest</code></td> <td>Start transaction</td> </tr> <tr> <td><code>CommitRequest</code></td> <td>Commit transaction</td> </tr> <tr> <td><code>RollbackRequest</code></td> <td>Rollback transaction</td> </tr> <tr> <td><code>PingRequest</code></td> <td>Keep-alive</td> </tr> </tbody> </table> <table> <thead> <tr> <th>Server Response</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td><code>ExecutionResponse</code></td> <td>Response wrapper with schema, data pages, errors, explain, or profile payloads</td> </tr> </tbody> </table> <h4 id="connection-security" class="position-relative d-flex align-items-center group"> Connection Security <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="connection-security" aria-haspopup="dialog" aria-label="Share link: Connection Security"> Share link </button> </h4>All connections require TLS 1.3: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-python" data-lang="python"># Custom TLS configuration (Python example) client = Client( host="localhost", port=3141, tls_config=TLSConfig( ca_cert="/path/to/ca.crt", client_cert="/path/to/client.crt", client_key="/path/to/client.key", verify_hostname=True ) ) </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/go/" >Go Client</a> : Detailed Go client documentation</li> <li><a href="/tags/python/" >Python Client</a> : Python async client guide</li> <li><a href="/tags/rust/" >Rust Client</a> : Rust client with tokio</li> <li><a href="/tags/zig/" >Zig Client</a> : Zig systems programming client</li> <li><a href="/tags/javascript/" >JavaScript</a> : Node.js client usage</li> <li><a href="/tags/typescript/" >TypeScript</a> : TypeScript type definitions</li> <li><a href="/tags/protocol/" >Protocol</a> : Wire protocol specification</li> <li><a href="/tags/security/" >Security</a> : TLS and authentication</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>Client Comparison Guide: Feature matrix across all clients</li> <li>Connection Pooling Best Practices: Optimize connection management</li> <li>Error Handling: Working with GQL error codes</li> <li>Performance Tuning: Maximizing client throughput</li> <li>Migration Guides: Moving from other graph databases</li> </ul> Browse the tagged content below for comprehensive client library documentation, tutorials, and examples.

Popular

Client Libraries - Official Geode SDKs for Go, Python, Rust, Zig, and Node.js

Related Articles

Installation Guide

DSN (Data Source Name) Specification