Node.js Client Library | Geode Database

<h2 id="nodejs-client-library" class="position-relative d-flex align-items-center group"> Node.js 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="nodejs-client-library" aria-haspopup="dialog" aria-label="Share link: Node.js Client Library"> Share link </button> </h2><div id="headingShareModal" class="heading-share-modal" role="dialog" aria-modal="true" aria-labelledby="headingShareTitle" hidden> <div class="hsm-dialog" role="document"> <div class="hsm-header"> <h2 id="headingShareTitle" class="h6 mb-0 fw-bold">Share this section</h2> <button type="button" class="hsm-close" aria-label="Close"> </button> </div> <div class="hsm-body"> <label for="headingShareInput" class="form-label small text-muted mb-1 text-uppercase fw-bold" style="font-size: 0.7rem; letter-spacing: 0.5px;">Permalink</label> <div class="input-group mb-4 hsm-url-group"> <input id="headingShareInput" type="text" class="form-control font-monospace" readonly aria-readonly="true" style="font-size: 0.85rem;" /> <button class="btn btn-primary hsm-copy" type="button" aria-label="Copy" title="Copy"> </button> </div> <div class="small fw-bold mb-2 text-muted text-uppercase" style="font-size: 0.7rem; letter-spacing: 0.5px;">Share via</div> <div class="hsm-share-grid"> <a id="share-twitter" class="btn btn-outline-secondary w-100" target="_blank" rel="noopener noreferrer"> Twitter </a> <a id="share-linkedin" class="btn btn-outline-secondary w-100" target="_blank" rel="noopener noreferrer"> LinkedIn </a> <a id="share-facebook" class="btn btn-outline-secondary w-100" target="_blank" rel="noopener noreferrer"> Facebook </a> </div> </div> </div> </div> <style> .heading-share-modal { position: fixed; inset: 0; display: flex; justify-content: center; align-items: center; background: rgba(0, 0, 0, 0.6); z-index: 1050; padding: 1rem; backdrop-filter: blur(4px); -webkit-backdrop-filter: blur(4px); } .heading-share-modal[hidden] { display: none !important; } .hsm-dialog { max-width: 420px; width: 100%; background: var(--bs-body-bg, #fff); color: var(--bs-body-color, #212529); border: 1px solid var(--bs-border-color, rgba(0,0,0,0.1)); border-radius: 1rem; box-shadow: 0 25px 50px -12px rgba(0, 0, 0, 0.25); overflow: hidden; animation: hsm-fade-in 0.2s ease-out; } @keyframes hsm-fade-in { from { opacity: 0; transform: scale(0.95); } to { opacity: 1; transform: scale(1); } } [data-bs-theme="dark"] .hsm-dialog { background: #1e293b; border-color: rgba(255,255,255,0.1); color: #f8f9fa; } .hsm-header { display: flex; justify-content: space-between; align-items: center; padding: 1rem 1.5rem; border-bottom: 1px solid var(--bs-border-color, rgba(0,0,0,0.1)); background: rgba(0,0,0,0.02); } [data-bs-theme="dark"] .hsm-header { background: rgba(255,255,255,0.02); border-color: rgba(255,255,255,0.1); } .hsm-close { background: transparent; border: none; color: inherit; opacity: 0.5; padding: 0.25rem 0.5rem; border-radius: 0.25rem; font-size: 1.2rem; line-height: 1; transition: opacity 0.2s; } .hsm-close:hover { opacity: 1; } .hsm-body { padding: 1.5rem; } .hsm-url-group { display: flex !important; align-items: stretch; } .hsm-url-group .form-control { flex: 1; min-width: 0; margin: 0; background: var(--bs-secondary-bg, #f8f9fa); border-color: var(--bs-border-color, #dee2e6); border-top-right-radius: 0; border-bottom-right-radius: 0; height: 42px; } .hsm-url-group .btn { flex: 0 0 auto; margin: 0; margin-left: -1px; border-top-left-radius: 0; border-bottom-left-radius: 0; height: 42px; display: flex; align-items: center; justify-content: center; padding: 0 1.25rem; z-index: 2; } [data-bs-theme="dark"] .hsm-url-group .form-control { background: #0f172a; border-color: #334155; color: #e2e8f0; } .hsm-share-grid { display: flex; flex-direction: column; gap: 0.5rem; } .hsm-share-grid .btn { display: flex; align-items: center; justify-content: center; font-size: 0.9rem; padding: 0.6rem; border-color: var(--bs-border-color); width: 100%; } [data-bs-theme="dark"] .hsm-share-grid .btn { color: #e2e8f0; border-color: #475569; } [data-bs-theme="dark"] .hsm-share-grid .btn:hover { background: #334155; border-color: #cbd5e1; } </style> <script> (function(){ const modal = document.getElementById('headingShareModal'); if(!modal) return; const input = modal.querySelector('#headingShareInput'); const copyBtn = modal.querySelector('.hsm-copy'); const twitter = modal.querySelector('#share-twitter'); const linkedin = modal.querySelector('#share-linkedin'); const facebook = modal.querySelector('#share-facebook'); const closeBtn = modal.querySelector('.hsm-close'); let lastFocus=null; let trapBound=false; function buildUrl(id){ return window.location.origin + window.location.pathname + '#' + id; } function isOpen(){ return !modal.hasAttribute('hidden'); } function hydrate(id){ const url=buildUrl(id); input.value=url; const enc=encodeURIComponent(url); const text=encodeURIComponent(document.title); if(twitter) twitter.href=`https://twitter.com/intent/tweet?url=${enc}&text=${text}`; if(linkedin) linkedin.href=`https://www.linkedin.com/sharing/share-offsite/?url=${enc}`; if(facebook) facebook.href=`https://www.facebook.com/sharer/sharer.php?u=${enc}`; } function openModal(id){ lastFocus=document.activeElement; hydrate(id); if(!isOpen()){ modal.removeAttribute('hidden'); } requestAnimationFrame(()=>{ input.focus(); }); trapFocus(); } function closeModal(){ if(!isOpen()) return; modal.setAttribute('hidden',''); if(lastFocus && typeof lastFocus.focus==='function') lastFocus.focus(); } function copyCurrent(){ try{ navigator.clipboard.writeText(input.value).then(()=>feedback(true),()=>fallback()); } catch(e){ fallback(); } } function fallback(){ input.select(); try{ document.execCommand('copy'); feedback(true);}catch(e){ feedback(false);} } function feedback(ok){ if(!copyBtn) return; const icon=copyBtn.querySelector('i'); if(!icon) return; const prev=copyBtn.getAttribute('data-prev')||icon.className; if(!copyBtn.getAttribute('data-prev')) copyBtn.setAttribute('data-prev',prev); icon.className= ok ? 'fa-duotone fa-clipboard-check':'fa-duotone fa-circle-exclamation'; setTimeout(()=>{ icon.className=prev; },1800); } function handleShareClick(e){ e.preventDefault(); const btn=e.currentTarget; const id=btn.getAttribute('data-share-target'); if(id) openModal(id); } function bindShareButtons(){ document.querySelectorAll('.h-share').forEach(btn=>{ if(!btn.dataset.hShareBound){ btn.addEventListener('click', handleShareClick); btn.dataset.hShareBound='1'; } }); } bindShareButtons(); if(document.readyState==='loading'){ document.addEventListener('DOMContentLoaded', bindShareButtons); } else { requestAnimationFrame(bindShareButtons); } document.addEventListener('click', function(e){ const shareBtn=e.target.closest && e.target.closest('.h-share'); if(shareBtn && !shareBtn.dataset.hShareBound){ handleShareClick.call(shareBtn, e); } }, true); document.addEventListener('click', e=>{ if(e.target===modal) closeModal(); if(e.target.closest && e.target.closest('.hsm-close')){ e.preventDefault(); closeModal(); } if(copyBtn && (e.target===copyBtn || (e.target.closest && e.target.closest('.hsm-copy')))) { e.preventDefault(); copyCurrent(); } }); document.addEventListener('keydown', e=>{ if(e.key==='Escape' && isOpen()) closeModal(); }); function trapFocus(){ if(trapBound) return; trapBound=true; modal.addEventListener('keydown', f=>{ if(f.key==='Tab' && isOpen()){ const focusable=[...modal.querySelectorAll('a[href],button,input,textarea,select,[tabindex]:not([tabindex="-1"])')].filter(el=>!el.hasAttribute('disabled')); if(!focusable.length) return; const first=focusable[0]; const last=focusable[focusable.length-1]; if(f.shiftKey && document.activeElement===first){ f.preventDefault(); last.focus(); } else if(!f.shiftKey && document.activeElement===last){ f.preventDefault(); first.focus(); } } }); } if(closeBtn) closeBtn.addEventListener('click', e=>{ e.preventDefault(); closeModal(); }); })(); </script>The Node.js client provides a TypeScript-first API for Geode with QUIC + TLS 1.3 (default) or gRPC transport, pooling, query builders, and prepared statements. <h3 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> </h3><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash">npm install @geodedb/client </code></pre></div> <h3 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> </h3><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' ); for (const row of rows) { console.log(`${row.name}: ${row.age}`); } await client.close(); </code></pre></div> <h3 id="dsn-format" class="position-relative d-flex align-items-center group"> DSN Format <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="dsn-format" aria-haspopup="dialog" aria-label="Share link: DSN Format"> Share link </button> </h3><blockquote> Note: See the official <a href="/docs/reference/dsn/" >DSN specification</a> for complete details. </blockquote> <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-fallback" data-lang="fallback">quic://[username:password@]host[:port][?options] # QUIC transport (default port: 3141) grpc://[username:password@]host[:port][?options] # gRPC transport (default port: 50051) host:port # Scheme-less (defaults to QUIC) </code></pre></div>Supported options: <code>page_size</code>, <code>hello_name</code>, <code>hello_ver</code>, <code>conformance</code>, <code>username</code>/<code>user</code>, <code>password</code>/<code>pass</code>, <code>ca</code>, <code>cert</code>, <code>key</code>, <code>insecure_tls_skip_verify</code>, <code>server_name</code>, <code>connect_timeout</code>, <code>request_timeout</code>, <code>tls</code> (gRPC only). Environment defaults: <code>GEODE_HOST</code>, <code>GEODE_PORT</code>, <code>GEODE_TRANSPORT</code>, <code>GEODE_TLS_CA</code>, <code>GEODE_USERNAME</code>, <code>GEODE_PASSWORD</code>. <h3 id="pooling" class="position-relative d-flex align-items-center group"> 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="pooling" aria-haspopup="dialog" aria-label="Share link: Pooling"> Share link </button> </h3>Pooling is enabled by default. Configure it via <code>ClientOptions</code>: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-ts" data-lang="ts">const client = await createClient('quic://localhost:3141', { pooling: true, pool: { min: 2, max: 10, acquireTimeout: 30000, idleTimeout: 60000, }, }); </code></pre></div>Disable pooling for a single connection: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-ts" data-lang="ts">const client = await createClient('quic://localhost:3141', { pooling: false }); </code></pre></div> <h3 id="queries" class="position-relative d-flex align-items-center group"> 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="queries" aria-haspopup="dialog" aria-label="Share link: Queries"> Share link </button> </h3><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-ts" data-lang="ts">const result = await client.query('MATCH (n) RETURN n'); for await (const row of result) { const node = row.get('n')?.asNode; console.log(node); } const rows = await client.queryAll('MATCH (n) RETURN n.name AS name'); const first = await client.queryFirst('MATCH (n) RETURN n LIMIT 1'); const count = await client.queryScalar<number>('MATCH (n) RETURN count(n) AS cnt', 'cnt'); </code></pre></div> <h3 id="streaming-queries" class="position-relative d-flex align-items-center group"> Streaming 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="streaming-queries" aria-haspopup="dialog" aria-label="Share link: Streaming Queries"> Share link </button> </h3><code>query()</code> returns an async iterator for streaming large result sets: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-ts" data-lang="ts">const result = await client.query('MATCH (p:Person) RETURN p.name AS name'); for await (const row of result) { console.log(row.get('name')?.asString); } </code></pre></div> <h3 id="parameters-and-cancellation" class="position-relative d-flex align-items-center group"> Parameters and Cancellation <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="parameters-and-cancellation" aria-haspopup="dialog" aria-label="Share link: Parameters and Cancellation"> Share link </button> </h3><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-ts" data-lang="ts">const controller = new AbortController(); const rows = await client.queryAll( 'MATCH (p:Person) WHERE p.age > $minAge RETURN p.name AS name', { params: { minAge: 21 }, signal: controller.signal, pageSize: 1000 } ); </code></pre></div> <h3 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> </h3><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-ts" data-lang="ts">await client.withTransaction(async (tx) => { await tx.exec("CREATE (:Person {name: 'Alice'})"); await tx.exec("CREATE (:Person {name: 'Bob'})"); }); </code></pre></div>Manual transaction control with savepoints: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-ts" data-lang="ts">const conn = await client.getConnection(); const tx = await conn.begin(); try { await tx.exec("CREATE (p:Person {name: 'Alice'})"); await tx.savepoint('before_update'); await tx.exec("MATCH (p:Person {name: 'Alice'}) SET p.age = 30"); await tx.rollbackTo('before_update'); await tx.commit(); } catch (err) { await tx.rollback(); throw err; } finally { await client.releaseConnection(conn); } </code></pre></div> <h3 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> </h3><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-ts" data-lang="ts">const stmt = await client.prepare('MATCH (p:Person {name: $name}) RETURN p'); const rows = await stmt.executeAll({ name: 'Alice' }); stmt.close(); </code></pre></div> <h3 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> </h3><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-ts" data-lang="ts">import { query } from '@geodedb/client'; const { query: gql, params } = query() .match('(p:Person)') .return('p.name AS name') .build(); const rows = await client.queryAll(gql, { params }); </code></pre></div> <h3 id="explain-and-profile" class="position-relative d-flex align-items-center group"> Explain and Profile <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="explain-and-profile" aria-haspopup="dialog" aria-label="Share link: Explain and Profile"> Share link </button> </h3><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-ts" data-lang="ts">import { explain, profile } from '@geodedb/client'; await client.withConnection(async (conn) => { const plan = await explain(conn, 'MATCH (p:Person) RETURN p'); const prof = await profile(conn, 'MATCH (p:Person) RETURN p'); console.log(plan, prof); }); </code></pre></div> <h3 id="authentication-helpers" class="position-relative d-flex align-items-center group"> Authentication Helpers <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="authentication-helpers" aria-haspopup="dialog" aria-label="Share link: Authentication Helpers"> Share link </button> </h3><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-ts" data-lang="ts">import { createAuthClient } from '@geodedb/client'; await client.withConnection(async (conn) => { const auth = createAuthClient(conn); const user = await auth.currentUser(); console.log(user); }); </code></pre></div> <h3 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> </h3><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-ts" data-lang="ts">await client.withConnection(async (conn) => { const rows = await conn.queryAll('MATCH (n) RETURN n LIMIT 10'); console.log(rows); }); </code></pre></div> <h3 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> </h3><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-ts" data-lang="ts">import { isGeodeError, DriverError } from '@geodedb/client'; try { await client.exec('INVALID QUERY'); } catch (err) { if (isGeodeError(err)) { if (err instanceof DriverError && err.isRetryable) { // Retry logic } } throw err; } </code></pre></div> <h3 id="type-mapping" class="position-relative d-flex align-items-center group"> Type Mapping <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-mapping" aria-haspopup="dialog" aria-label="Share link: Type Mapping"> Share link </button> </h3><ul> <li><code>queryAll</code> returns plain JavaScript objects.</li> <li><code>query</code> returns <code>Row</code> objects (<code>Map<string, GQLValue></code>).</li> <li>Use <code>row.get('field')</code> for typed access, or <code>result.toObjects()</code> to convert.</li> </ul> <h3 id="repository" class="position-relative d-flex align-items-center group"> Repository <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="repository" aria-haspopup="dialog" aria-label="Share link: Repository"> Share link </button> </h3><ul> <li>GitLab: <a href="https://gitlab.com/devnw/geode/geode-client-nodejs" aria-label="devnw/geode/geode-client-nodejs – opens in new window" target="_blank" rel="noopener noreferrer" >devnw/geode/geode-client-nodejs ↗ </a> </li> <li>npm: <a href="https://www.npmjs.com/package/@geodedb/client" aria-label="@geodedb/client – opens in new window" target="_blank" rel="noopener noreferrer" >@geodedb/client ↗ </a> </li> </ul>