Node.js Client | 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 official Node.js client for Geode provides a high-performance QUIC + TLS 1.3 implementation with full TypeScript types. Use <code>createClient</code> for a ready-to-use client with optional pooling. <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>Requirements: Node.js 20+ <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-options" class="position-relative d-flex align-items-center group"> DSN 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="dsn-options" aria-haspopup="dialog" aria-label="Share link: DSN Options"> Share link </button> </h3><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-fallback" data-lang="fallback">quic://[username:password@]host[:port][?options] </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>. <h4 id="environment-defaults" class="position-relative d-flex align-items-center group"> Environment Defaults <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="environment-defaults" aria-haspopup="dialog" aria-label="Share link: Environment Defaults"> Share link </button> </h4><ul> <li><code>GEODE_HOST</code></li> <li><code>GEODE_PORT</code></li> <li><code>GEODE_TLS_CA</code></li> <li><code>GEODE_USERNAME</code></li> <li><code>GEODE_PASSWORD</code></li> </ul> <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 dedicated 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 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> <h4 id="streaming-results" class="position-relative d-flex align-items-center group"> Streaming Results <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-results" aria-haspopup="dialog" aria-label="Share link: Streaming Results"> Share link </button> </h4><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="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 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(); } 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' }); </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="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 { DriverError, TransportError, ConfigError, SecurityError, isRetryableError, } from '@geodedb/client'; try { await client.queryAll('INVALID QUERY'); } catch (e) { if (e instanceof DriverError) { console.log('Server error:', e.code, e.message); console.log('Status class:', e.statusClass); // ISO 39075 code if (isRetryableError(e)) { // Serialization or deadlock - can retry } } else if (e instanceof TransportError) { console.log('Network error:', e.operation, e.message); } else if (e instanceof ConfigError) { console.log('Configuration error:', e.field, e.message); } else if (e instanceof SecurityError) { console.log('Security error:', e.type, e.message); } } </code></pre></div> <h4 id="iso-39075-status-classes" class="position-relative d-flex align-items-center group"> ISO 39075 Status Classes <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="iso-39075-status-classes" aria-haspopup="dialog" aria-label="Share link: ISO 39075 Status Classes"> Share link </button> </h4><table> <thead> <tr> <th>Class</th> <th>Meaning</th> <th>Retryable</th> </tr> </thead> <tbody> <tr> <td>00000</td> <td>Success</td> <td>-</td> </tr> <tr> <td>01000</td> <td>Warning</td> <td>No</td> </tr> <tr> <td>02000</td> <td>No data</td> <td>No</td> </tr> <tr> <td>25000</td> <td>Invalid transaction state</td> <td>No</td> </tr> <tr> <td>28000</td> <td>Authorization error</td> <td>No</td> </tr> <tr> <td>40001</td> <td>Serialization failure</td> <td>Yes</td> </tr> <tr> <td>40502</td> <td>Transaction deadlock</td> <td>Yes</td> </tr> <tr> <td>42000</td> <td>Syntax error</td> <td>No</td> </tr> <tr> <td>23000</td> <td>Constraint violation</td> <td>No</td> </tr> <tr> <td>58000</td> <td>System error</td> <td>No</td> </tr> </tbody> </table> <h3 id="type-system" class="position-relative d-flex align-items-center group"> Type System <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-system" aria-haspopup="dialog" aria-label="Share link: Type System"> Share link </button> </h3>The client provides a comprehensive GQL type system: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-ts" data-lang="ts">import { GQLValue, fromJSON } from '@geodedb/client'; // Create typed values const intVal = GQLValue.int(42); const strVal = GQLValue.string('hello'); const arrVal = GQLValue.array([GQLValue.int(1), GQLValue.int(2)]); const nodeVal = GQLValue.node({ id: '123', labels: ['Person'], properties: { name: 'Alice' }, }); // Type-safe access intVal.asNumber; // 42 intVal.asInt; // 42n (bigint) strVal.asString; // 'hello' arrVal.asArray; // [GQLValue, GQLValue] nodeVal.asNode; // { id, labels, properties } // Convert to plain JS intVal.toJS(); // 42 nodeVal.toJS(); // { id: '123', labels: ['Person'], ... } // Parse from JSON const value = fromJSON({ name: 'Alice', age: 30 }); </code></pre></div> <h4 id="supported-types" class="position-relative d-flex align-items-center group"> Supported 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="supported-types" aria-haspopup="dialog" aria-label="Share link: Supported Types"> Share link </button> </h4><table> <thead> <tr> <th>GQL Type</th> <th>Node.js Type</th> </tr> </thead> <tbody> <tr> <td>INT</td> <td>number/bigint</td> </tr> <tr> <td>FLOAT</td> <td>number</td> </tr> <tr> <td>DECIMAL</td> <td>Decimal</td> </tr> <tr> <td>STRING</td> <td>string</td> </tr> <tr> <td>BOOL</td> <td>boolean</td> </tr> <tr> <td>NULL</td> <td>null</td> </tr> <tr> <td>ARRAY/LIST</td> <td>Array</td> </tr> <tr> <td>OBJECT/MAP</td> <td>Object/Map</td> </tr> <tr> <td>NODE</td> <td>GQLNode</td> </tr> <tr> <td>EDGE</td> <td>GQLEdge</td> </tr> <tr> <td>PATH</td> <td>GQLPath</td> </tr> <tr> <td>BYTEA</td> <td>Uint8Array</td> </tr> <tr> <td>DATE</td> <td>Date</td> </tr> <tr> <td>TIME</td> <td>Date</td> </tr> <tr> <td>TIMESTAMP</td> <td>Date</td> </tr> <tr> <td>UUID</td> <td>string</td> </tr> <tr> <td>JSON/JSONB</td> <td>any</td> </tr> </tbody> </table> <h3 id="advanced-features" class="position-relative d-flex align-items-center group"> Advanced 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="advanced-features" aria-haspopup="dialog" aria-label="Share link: Advanced Features"> Share link </button> </h3> <h4 id="batch-operations" class="position-relative d-flex align-items-center group"> Batch Operations <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="batch-operations" aria-haspopup="dialog" aria-label="Share link: Batch Operations"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-ts" data-lang="ts">import { batch, batchMap, batchParallel } from '@geodedb/client'; // Execute multiple queries in a batch const summary = await client.batch([ { query: "CREATE (n:Person {name: 'Alice'})" }, { query: "CREATE (n:Person {name: 'Bob'})" }, { query: 'MATCH (n:Person) RETURN count(n) AS cnt' }, ]); console.log(`${summary.successful}/${summary.total} queries succeeded`); console.log('Total time:', summary.totalDurationMs, 'ms'); // Stop on first error const summary2 = await client.batch(queries, { stopOnError: true }); // Execute in a transaction (all or nothing) const summary3 = await client.batch(queries, { transaction: true }); // Map over data const people = [{ name: 'Alice' }, { name: 'Bob' }, { name: 'Charlie' }]; await batchMap(conn, 'CREATE (n:Person {name: $name})', people); </code></pre></div> <h4 id="query-explainprofile" class="position-relative d-flex align-items-center group"> Query Explain/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="query-explainprofile" aria-haspopup="dialog" aria-label="Share link: Query Explain/Profile"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-ts" data-lang="ts">import { explain, profile, formatPlan, formatProfile } from '@geodedb/client'; // Get query execution plan const plan = await client.explain('MATCH (n:Person)-[:KNOWS]->(m) RETURN n, m'); console.log('Estimated cost:', plan.totalCost); console.log('Estimated rows:', plan.totalRows); // Format plan for display console.log(formatPlan(plan)); // Profile actual execution const prof = await client.profile('MATCH (n:Person) RETURN count(n)'); console.log('Execution time:', prof.totalTimeMs, 'ms'); console.log('Rows processed:', prof.totalRows); console.log('Planning time:', prof.planningTimeMs, 'ms'); console.log('Memory used:', prof.memoryBytes, 'bytes'); // Format profile for display console.log(formatProfile(prof)); </code></pre></div> <h4 id="authentication-client" class="position-relative d-flex align-items-center group"> Authentication 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="authentication-client" aria-haspopup="dialog" aria-label="Share link: Authentication Client"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-ts" data-lang="ts">import { AuthClient } from '@geodedb/client'; const auth = await client.auth(); // User management await auth.createUser('alice', { password: 'securePass123', roles: ['analyst'] }); await auth.changePassword('alice', 'newPassword456'); await auth.deactivateUser('alice'); const users = await auth.listUsers(); // Role management await auth.createRole('analyst', { description: 'Data analyst role', permissions: [{ resource: 'NODE', action: 'READ' }], }); await auth.assignRole('alice', 'analyst'); await auth.grantPermission('analyst', { resource: 'NODE', action: 'READ', label: 'Person' }); // Row-level security policies await auth.createRLSPolicy( 'tenant_isolation', 'Document', 'ALL', 'n.tenant_id = current_user().tenant_id', { roles: ['user', 'analyst'] } ); await auth.enableRLSPolicy('tenant_isolation', 'Document'); // Session info const currentUser = await auth.currentUser(); const roles = await auth.currentRoles(); const canRead = await auth.hasPermission('NODE', 'READ', 'Person'); </code></pre></div> <h4 id="abortcancellation" class="position-relative d-flex align-items-center group"> Abort/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="abortcancellation" aria-haspopup="dialog" aria-label="Share link: Abort/Cancellation"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-ts" data-lang="ts">const controller = new AbortController(); // Cancel after 5 seconds setTimeout(() => controller.abort(), 5000); try { const rows = await client.queryAll('MATCH (n) RETURN n', { signal: controller.signal }); } catch (e) { if (e.message.includes('Aborted')) { console.log('Query was cancelled'); } } </code></pre></div> <h3 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> </h3><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, // Minimum connections to maintain max: 10, // Maximum connections acquireTimeout: 30000, // Max wait time to acquire idleTimeout: 60000, // Close idle connections after }, }); // Check pool stats console.log(client.poolStats); // { total: 5, available: 3, inUse: 2, waiting: 0 } </code></pre></div> <h3 id="api-reference" class="position-relative d-flex align-items-center group"> API Reference <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="api-reference" aria-haspopup="dialog" aria-label="Share link: API Reference"> Share link </button> </h3> <h4 id="geodeclient" class="position-relative d-flex align-items-center group"> GeodeClient <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="geodeclient" aria-haspopup="dialog" aria-label="Share link: GeodeClient"> Share link </button> </h4><table> <thead> <tr> <th>Method</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td><code>query(gql, options?)</code></td> <td>Execute query, return async iterator</td> </tr> <tr> <td><code>queryAll(gql, options?)</code></td> <td>Execute query, return all rows</td> </tr> <tr> <td><code>queryFirst(gql, options?)</code></td> <td>Get first row</td> </tr> <tr> <td><code>queryScalar(gql, col, options?)</code></td> <td>Get single value</td> </tr> <tr> <td><code>exec(gql, options?)</code></td> <td>Execute statement (no results)</td> </tr> <tr> <td><code>withTransaction(fn)</code></td> <td>Execute in transaction</td> </tr> <tr> <td><code>prepare(gql)</code></td> <td>Create prepared statement</td> </tr> <tr> <td><code>explain(gql, options?)</code></td> <td>Get query execution plan</td> </tr> <tr> <td><code>profile(gql, options?)</code></td> <td>Profile query execution</td> </tr> <tr> <td><code>batch(queries, options?)</code></td> <td>Execute multiple queries</td> </tr> <tr> <td><code>auth()</code></td> <td>Get authentication client</td> </tr> <tr> <td><code>ping()</code></td> <td>Check connection health</td> </tr> <tr> <td><code>close()</code></td> <td>Close client</td> </tr> </tbody> </table> <h4 id="connection" class="position-relative d-flex align-items-center group"> Connection <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" aria-haspopup="dialog" aria-label="Share link: Connection"> Share link </button> </h4><table> <thead> <tr> <th>Method</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td><code>query(gql, options?)</code></td> <td>Execute query</td> </tr> <tr> <td><code>exec(gql, options?)</code></td> <td>Execute statement</td> </tr> <tr> <td><code>begin()</code></td> <td>Start transaction</td> </tr> <tr> <td><code>prepare(gql)</code></td> <td>Create prepared statement</td> </tr> <tr> <td><code>explain(gql, options?)</code></td> <td>Get query plan</td> </tr> <tr> <td><code>profile(gql, options?)</code></td> <td>Profile execution</td> </tr> <tr> <td><code>batch(queries, options?)</code></td> <td>Execute batch</td> </tr> <tr> <td><code>ping()</code></td> <td>Health check</td> </tr> <tr> <td><code>reset()</code></td> <td>Reset session</td> </tr> <tr> <td><code>close()</code></td> <td>Close connection</td> </tr> </tbody> </table> <h4 id="transaction" class="position-relative d-flex align-items-center group"> Transaction <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" aria-haspopup="dialog" aria-label="Share link: Transaction"> Share link </button> </h4><table> <thead> <tr> <th>Method</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td><code>query(gql, options?)</code></td> <td>Execute query</td> </tr> <tr> <td><code>exec(gql, options?)</code></td> <td>Execute statement</td> </tr> <tr> <td><code>savepoint(name)</code></td> <td>Create savepoint</td> </tr> <tr> <td><code>rollbackTo(name)</code></td> <td>Rollback to savepoint</td> </tr> <tr> <td><code>commit()</code></td> <td>Commit transaction</td> </tr> <tr> <td><code>rollback()</code></td> <td>Rollback transaction</td> </tr> </tbody> </table> <h4 id="preparedstatement" class="position-relative d-flex align-items-center group"> PreparedStatement <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="preparedstatement" aria-haspopup="dialog" aria-label="Share link: PreparedStatement"> Share link </button> </h4><table> <thead> <tr> <th>Method</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td><code>execute(params?, options?)</code></td> <td>Execute, return iterator</td> </tr> <tr> <td><code>executeAll(params?, options?)</code></td> <td>Execute, return all rows</td> </tr> <tr> <td><code>exec(params?, options?)</code></td> <td>Execute (no results)</td> </tr> <tr> <td><code>validate(params?)</code></td> <td>Validate parameters</td> </tr> <tr> <td><code>close()</code></td> <td>Close statement</td> </tr> <tr> <td><code>query</code></td> <td>Get query text</td> </tr> <tr> <td><code>parameterCount</code></td> <td>Get parameter count</td> </tr> <tr> <td><code>namedParameters</code></td> <td>Get named parameter names</td> </tr> </tbody> </table> <h4 id="authclient" class="position-relative d-flex align-items-center group"> AuthClient <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="authclient" aria-haspopup="dialog" aria-label="Share link: AuthClient"> Share link </button> </h4><table> <thead> <tr> <th>Method</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td><code>createUser(name, options)</code></td> <td>Create user</td> </tr> <tr> <td><code>deleteUser(name)</code></td> <td>Delete user</td> </tr> <tr> <td><code>getUser(name)</code></td> <td>Get user info</td> </tr> <tr> <td><code>listUsers()</code></td> <td>List all users</td> </tr> <tr> <td><code>changePassword(name, password)</code></td> <td>Change password</td> </tr> <tr> <td><code>activateUser(name)</code></td> <td>Activate user</td> </tr> <tr> <td><code>deactivateUser(name)</code></td> <td>Deactivate user</td> </tr> <tr> <td><code>createRole(name, options?)</code></td> <td>Create role</td> </tr> <tr> <td><code>deleteRole(name)</code></td> <td>Delete role</td> </tr> <tr> <td><code>assignRole(user, role)</code></td> <td>Assign role to user</td> </tr> <tr> <td><code>revokeRole(user, role)</code></td> <td>Revoke role from user</td> </tr> <tr> <td><code>grantPermission(role, perm)</code></td> <td>Grant permission</td> </tr> <tr> <td><code>revokePermission(role, perm)</code></td> <td>Revoke permission</td> </tr> <tr> <td><code>createRLSPolicy(...)</code></td> <td>Create RLS policy</td> </tr> <tr> <td><code>deleteRLSPolicy(name, label)</code></td> <td>Delete RLS policy</td> </tr> <tr> <td><code>currentUser()</code></td> <td>Get current user</td> </tr> <tr> <td><code>currentRoles()</code></td> <td>Get current roles</td> </tr> <tr> <td><code>hasPermission(res, action, label?)</code></td> <td>Check permission</td> </tr> </tbody> </table> <h3 id="testing" class="position-relative d-flex align-items-center group"> 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="testing" aria-haspopup="dialog" aria-label="Share link: Testing"> Share link </button> </h3><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash"># Run unit tests npm test # Run with coverage npm run test:coverage # Run integration tests (requires Docker) npm run test:integration </code></pre></div> <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/codepros/geode/geode-client-nodejs" aria-label="devnw/codepros/geode/geode-client-nodejs – opens in new window" target="_blank" rel="noopener noreferrer" >devnw/codepros/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>