JavaScript Client Library - Node.js SDK for Geode Graph Database | Tags

<h2 id="javascript-client-library-for-geode" class="position-relative d-flex align-items-center group"> JavaScript Client Library for Geode <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="javascript-client-library-for-geode" aria-haspopup="dialog" aria-label="Share link: JavaScript Client Library for Geode"> 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 Geode JavaScript client enables Node.js applications to connect to Geode using QUIC + TLS 1.3 transport. It provides async/await patterns, connection pooling, and GQL conformance profile support for building high-performance graph-powered applications. <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>The JavaScript client is designed for modern Node.js development: <ul> <li>Async/Await Native: First-class Promise support throughout</li> <li>Connection Pooling: Efficient connection management for high-throughput scenarios</li> <li>Stream Support: Handle large result sets with streaming APIs</li> <li>Framework Agnostic: Works with Express, Fastify, Koa, NestJS, and more</li> <li>ESM and CommonJS: Supports both module systems</li> </ul> <h4 id="requirements" class="position-relative d-flex align-items-center group"> Requirements <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="requirements" aria-haspopup="dialog" aria-label="Share link: Requirements"> Share link </button> </h4><ul> <li>Node.js 18.0 or later (for native QUIC support)</li> <li>npm 8.0+ or yarn 1.22+</li> </ul> <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"># Using npm npm install @geodedb/client # Using yarn yarn add @geodedb/client # Using pnpm pnpm add @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> <h4 id="basic-connection" class="position-relative d-flex align-items-center group"> Basic 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="basic-connection" aria-haspopup="dialog" aria-label="Share link: Basic Connection"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-javascript" data-lang="javascript">const { Client } = require('@geodedb/client'); async function main() { // Create client const client = new Client({ host: 'localhost', port: 3141, }); // Connect const conn = await client.connect(); try { // Execute query const result = await conn.query( 'MATCH (p:Person) RETURN p.name AS name, p.age AS age' ); // Process results for (const row of result.rows) { console.log(`${row.name}: ${row.age} years old`); } } finally { // Always close connection await conn.close(); } } main().catch(console.error); </code></pre></div> <h4 id="es-modules" class="position-relative d-flex align-items-center group"> ES Modules <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="es-modules" aria-haspopup="dialog" aria-label="Share link: ES Modules"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-javascript" data-lang="javascript">import { Client } from '@geodedb/client'; const client = new Client({ host: 'localhost', port: 3141 }); const conn = await client.connect(); const { rows } = await conn.query('RETURN "Hello, Geode!" AS greeting'); console.log(rows[0].greeting); await conn.close(); </code></pre></div> <h3 id="connection-configuration" class="position-relative d-flex align-items-center group"> Connection Configuration <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-configuration" aria-haspopup="dialog" aria-label="Share link: Connection Configuration"> Share link </button> </h3> <h4 id="full-configuration-options" class="position-relative d-flex align-items-center group"> Full Configuration 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="full-configuration-options" aria-haspopup="dialog" aria-label="Share link: Full Configuration Options"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-javascript" data-lang="javascript">const client = new Client({ // Connection settings host: 'geode.example.com', port: 3141, // TLS configuration tls: { ca: fs.readFileSync('/path/to/ca.crt'), cert: fs.readFileSync('/path/to/client.crt'), key: fs.readFileSync('/path/to/client.key'), rejectUnauthorized: true, // Verify server certificate }, // Client identification clientName: 'my-application', clientVersion: '1.0.0', // Query settings defaultPageSize: 1000, queryTimeout: 30000, // 30 seconds // Connection settings connectTimeout: 10000, // 10 seconds idleTimeout: 60000, // 1 minute }); </code></pre></div> <h4 id="environment-variables" class="position-relative d-flex align-items-center group"> Environment Variables <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-variables" aria-haspopup="dialog" aria-label="Share link: Environment Variables"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-javascript" data-lang="javascript">// Load configuration from environment const client = new Client({ host: process.env.GEODE_HOST || 'localhost', port: parseInt(process.env.GEODE_PORT) || 3141, tls: process.env.GEODE_TLS_ENABLED === 'true' ? { ca: fs.readFileSync(process.env.GEODE_CA_PATH), } : undefined, }); </code></pre></div> <h3 id="executing-queries" class="position-relative d-flex align-items-center group"> Executing 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="executing-queries" aria-haspopup="dialog" aria-label="Share link: Executing Queries"> Share link </button> </h3> <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>Always use parameters to prevent injection and improve performance: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-javascript" data-lang="javascript">// Good: Parameterized query const result = await conn.query( 'MATCH (u:User {email: $email}) RETURN u', { email: userInput } ); // Bad: String interpolation (vulnerable to injection) // const result = await conn.query(`MATCH (u:User {email: "${userInput}"}) RETURN u`); </code></pre></div> <h4 id="parameter-types" class="position-relative d-flex align-items-center group"> Parameter 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="parameter-types" aria-haspopup="dialog" aria-label="Share link: Parameter Types"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-javascript" data-lang="javascript">// String parameters await conn.query('CREATE (p:Person {name: $name})', { name: 'Alice' }); // Number parameters await conn.query('MATCH (p:Person) WHERE p.age > $age RETURN p', { age: 21 }); // Boolean parameters await conn.query('MATCH (p:Product) WHERE p.active = $active RETURN p', { active: true }); // Null parameters await conn.query('MATCH (p:Person) SET p.middleName = $middle', { middle: null }); // Array parameters await conn.query('MATCH (p:Person) WHERE p.id IN $ids RETURN p', { ids: ['id1', 'id2', 'id3'] }); // Object/Map parameters await conn.query('CREATE (c:Config {settings: $settings})', { settings: { theme: 'dark', notifications: true } }); // Date parameters await conn.query('CREATE (e:Event {date: $date})', { date: new Date('2026-01-28T10:00:00Z') }); </code></pre></div> <h4 id="execute-vs-query" class="position-relative d-flex align-items-center group"> Execute vs Query <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="execute-vs-query" aria-haspopup="dialog" aria-label="Share link: Execute vs Query"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-javascript" data-lang="javascript">// Use query() for SELECT operations that return data const { rows, schema } = await conn.query( 'MATCH (p:Person) RETURN p.name, p.age' ); // Use execute() for mutations that don't need results const { summary } = await conn.execute( 'CREATE (p:Person {name: $name, age: $age})', { name: 'Bob', age: 30 } ); console.log(`Created ${summary.nodesCreated} nodes`); </code></pre></div> <h3 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> </h3> <h4 id="creating-a-pool" class="position-relative d-flex align-items-center group"> Creating a 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="creating-a-pool" aria-haspopup="dialog" aria-label="Share link: Creating a Pool"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-javascript" data-lang="javascript">const { Pool } = require('@geodedb/client'); const pool = new Pool({ host: 'localhost', port: 3141, // Pool configuration minConnections: 5, // Minimum idle connections maxConnections: 20, // Maximum total connections acquireTimeout: 5000, // Wait time for connection idleTimeout: 60000, // Close idle connections after maxLifetime: 3600000, // Maximum connection age (1 hour) }); // Initialize pool await pool.initialize(); </code></pre></div> <h4 id="using-the-pool" class="position-relative d-flex align-items-center group"> Using the 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="using-the-pool" aria-haspopup="dialog" aria-label="Share link: Using the Pool"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-javascript" data-lang="javascript">// Method 1: Manual acquire/release 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); } } // Method 2: Using withConnection helper async function queryWithHelper() { return pool.withConnection(async (conn) => { const result = await conn.query('MATCH (n) RETURN count(n) AS total'); return result.rows[0].total; }); } // Method 3: Using connection callback const total = await pool.query('MATCH (n) RETURN count(n) AS total'); </code></pre></div> <h4 id="pool-events" class="position-relative d-flex align-items-center group"> Pool Events <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="pool-events" aria-haspopup="dialog" aria-label="Share link: Pool Events"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-javascript" data-lang="javascript">pool.on('connect', (conn) => { console.log('New connection established'); }); pool.on('acquire', (conn) => { console.log('Connection acquired from pool'); }); pool.on('release', (conn) => { console.log('Connection released to pool'); }); pool.on('error', (err) => { console.error('Pool error:', err); }); pool.on('close', () => { console.log('Pool closed'); }); </code></pre></div> <h4 id="graceful-shutdown" class="position-relative d-flex align-items-center group"> Graceful Shutdown <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="graceful-shutdown" aria-haspopup="dialog" aria-label="Share link: Graceful Shutdown"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-javascript" data-lang="javascript">// Handle shutdown signals process.on('SIGTERM', async () => { console.log('Shutting down...'); await pool.drain(); // Wait for active connections await pool.close(); // Close all connections process.exit(0); }); </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> <h4 id="basic-transaction" class="position-relative d-flex align-items-center group"> Basic 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="basic-transaction" aria-haspopup="dialog" aria-label="Share link: Basic Transaction"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-javascript" data-lang="javascript">async function transferFunds(fromId, toId, amount) { const conn = await pool.acquire(); try { await conn.beginTransaction(); try { // Debit source account await conn.execute( 'MATCH (a:Account {id: $id}) SET a.balance = a.balance - $amount', { id: fromId, amount } ); // Credit destination account await conn.execute( 'MATCH (a:Account {id: $id}) SET a.balance = a.balance + $amount', { id: toId, amount } ); await conn.commit(); return { success: true }; } catch (err) { await conn.rollback(); throw err; } } finally { pool.release(conn); } } </code></pre></div> <h4 id="transaction-with-savepoints" class="position-relative d-flex align-items-center group"> Transaction 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="transaction-with-savepoints" aria-haspopup="dialog" aria-label="Share link: Transaction with Savepoints"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-javascript" data-lang="javascript">async function complexOperation(conn) { await conn.beginTransaction(); try { // Create user await conn.execute( 'CREATE (u:User {id: $id, name: $name})', { id: 'user_001', name: 'Alice' } ); // Create savepoint before risky operation await conn.savepoint('before_preferences'); try { // This might fail await conn.execute( 'MATCH (u:User {id: $id}) CREATE (u)-[:PREFERS]->(:Category {name: $cat})', { id: 'user_001', cat: 'InvalidCategory' } ); } catch (err) { // Rollback to savepoint, not entire transaction await conn.rollbackToSavepoint('before_preferences'); // Use default instead await conn.execute( 'MATCH (u:User {id: $id}) CREATE (u)-[:PREFERS]->(:Category {name: "General"})', { id: 'user_001' } ); } await conn.commit(); } catch (err) { await conn.rollback(); throw err; } } </code></pre></div> <h3 id="streaming-large-results" class="position-relative d-flex align-items-center group"> Streaming Large 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-large-results" aria-haspopup="dialog" aria-label="Share link: Streaming Large Results"> Share link </button> </h3> <h4 id="using-async-iterators" class="position-relative d-flex align-items-center group"> Using Async Iterators <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="using-async-iterators" aria-haspopup="dialog" aria-label="Share link: Using Async Iterators"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-javascript" data-lang="javascript">async function streamLargeDataset() { const conn = await client.connect(); try { const stream = conn.stream( 'MATCH (p:Product) RETURN p.id, p.name, p.price', {}, { batchSize: 1000 } ); let count = 0; for await (const row of stream) { // Process row await processProduct(row); count++; if (count % 10000 === 0) { console.log(`Processed ${count} products`); } } console.log(`Total: ${count} products`); } finally { await conn.close(); } } </code></pre></div> <h4 id="streaming-to-file" class="position-relative d-flex align-items-center group"> Streaming to File <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-to-file" aria-haspopup="dialog" aria-label="Share link: Streaming to File"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-javascript" data-lang="javascript">const fs = require('fs'); const { pipeline } = require('stream/promises'); const { Transform } = require('stream'); async function exportToCSV(filename) { const conn = await client.connect(); try { const queryStream = conn.stream( 'MATCH (u:User) RETURN u.id, u.name, u.email' ); const csvTransform = new Transform({ objectMode: true, transform(row, encoding, callback) { const line = `${row.id},${row.name},${row.email}\n`; callback(null, line); } }); const fileStream = fs.createWriteStream(filename); // Write header fileStream.write('id,name,email\n'); // Stream data await pipeline(queryStream, csvTransform, fileStream); } finally { await conn.close(); } } </code></pre></div> <h3 id="framework-integration" class="position-relative d-flex align-items-center group"> Framework Integration <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="framework-integration" aria-haspopup="dialog" aria-label="Share link: Framework Integration"> Share link </button> </h3> <h4 id="expressjs" class="position-relative d-flex align-items-center group"> Express.js <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="expressjs" aria-haspopup="dialog" aria-label="Share link: Express.js"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-javascript" data-lang="javascript">const express = require('express'); const { Pool } = require('@geodedb/client'); const app = express(); const pool = new Pool({ host: 'localhost', port: 3141 }); // Middleware to attach connection app.use(async (req, res, next) => { req.geode = await pool.acquire(); res.on('finish', () => pool.release(req.geode)); next(); }); // Route handlers app.get('/users/:id', async (req, res) => { try { const { rows } = await req.geode.query( 'MATCH (u:User {id: $id}) RETURN u', { id: req.params.id } ); if (rows.length === 0) { return res.status(404).json({ error: 'User not found' }); } res.json(rows[0]); } catch (err) { res.status(500).json({ error: err.message }); } }); app.get('/users/:id/friends', async (req, res) => { const { rows } = await req.geode.query( `MATCH (u:User {id: $id})-[:FRIENDS_WITH]->(f:User) RETURN f.id AS id, f.name AS name`, { id: req.params.id } ); res.json(rows); }); app.listen(3000); </code></pre></div> <h4 id="fastify" class="position-relative d-flex align-items-center group"> Fastify <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="fastify" aria-haspopup="dialog" aria-label="Share link: Fastify"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-javascript" data-lang="javascript">const fastify = require('fastify')(); const { Pool } = require('@geodedb/client'); // Register Geode plugin fastify.register(async (fastify) => { const pool = new Pool({ host: 'localhost', port: 3141 }); await pool.initialize(); fastify.decorate('geode', pool); fastify.addHook('onClose', async () => { await pool.close(); }); }); // Routes fastify.get('/products', async (request, reply) => { const { category, minPrice, maxPrice } = request.query; const { rows } = await fastify.geode.query( `MATCH (p:Product) WHERE ($category IS NULL OR p.category = $category) AND ($minPrice IS NULL OR p.price >= $minPrice) AND ($maxPrice IS NULL OR p.price <= $maxPrice) RETURN p.id, p.name, p.price, p.category ORDER BY p.price`, { category, minPrice, maxPrice } ); return rows; }); fastify.listen({ port: 3000 }); </code></pre></div> <h4 id="nestjs" class="position-relative d-flex align-items-center group"> NestJS <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="nestjs" aria-haspopup="dialog" aria-label="Share link: NestJS"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-javascript" data-lang="javascript">// geode.module.ts import { Module, Global } from '@nestjs/common'; import { Pool } from '@geodedb/client'; @Global() @Module({ providers: [ { provide: 'GEODE_POOL', useFactory: async () => { const pool = new Pool({ host: process.env.GEODE_HOST, port: parseInt(process.env.GEODE_PORT), }); await pool.initialize(); return pool; }, }, ], exports: ['GEODE_POOL'], }) export class GeodeModule {} // users.service.ts import { Injectable, Inject } from '@nestjs/common'; import { Pool } from '@geodedb/client'; @Injectable() export class UsersService { constructor(@Inject('GEODE_POOL') private readonly pool: Pool) {} async findById(id: string) { const { rows } = await this.pool.query( 'MATCH (u:User {id: $id}) RETURN u', { id } ); return rows[0]; } async findFriends(userId: string) { const { rows } = await this.pool.query( `MATCH (u:User {id: $id})-[:FRIENDS_WITH]->(f:User) RETURN f`, { id: userId } ); return 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> <h4 id="error-types" class="position-relative d-flex align-items-center group"> Error 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="error-types" aria-haspopup="dialog" aria-label="Share link: Error Types"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-javascript" data-lang="javascript">const { GeodeError, ConnectionError, QueryError, TransactionError, TimeoutError, } = require('@geodedb/client'); async function safeQuery(conn, query, params) { try { return await conn.query(query, params); } catch (err) { if (err instanceof ConnectionError) { console.error('Connection failed:', err.message); // Retry with new connection } else if (err instanceof QueryError) { console.error('Query failed:', err.code, err.message); // Log query details for debugging } else if (err instanceof TimeoutError) { console.error('Query timed out'); // Consider increasing timeout or optimizing query } else { throw err; } } } </code></pre></div> <h4 id="gql-error-codes" class="position-relative d-flex align-items-center group"> GQL Error Codes <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="gql-error-codes" aria-haspopup="dialog" aria-label="Share link: GQL Error Codes"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-javascript" data-lang="javascript">const { GqlErrorCode } = require('@geodedb/client'); try { await conn.query('INVALID SYNTAX'); } catch (err) { switch (err.code) { case GqlErrorCode.SYNTAX_ERROR: console.error('Invalid GQL syntax'); break; case GqlErrorCode.CONSTRAINT_VIOLATION: console.error('Constraint violated'); break; case GqlErrorCode.NOT_FOUND: console.error('Entity not found'); break; default: console.error('Unknown error:', err.code); } } </code></pre></div> <h3 id="performance-best-practices" class="position-relative d-flex align-items-center group"> Performance Best Practices <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="performance-best-practices" aria-haspopup="dialog" aria-label="Share link: Performance Best Practices"> Share link </button> </h3> <h4 id="connection-reuse" class="position-relative d-flex align-items-center group"> Connection Reuse <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="connection-reuse" aria-haspopup="dialog" aria-label="Share link: Connection Reuse"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-javascript" data-lang="javascript">// Bad: New connection per request app.get('/data', async (req, res) => { const conn = await client.connect(); // Expensive! const result = await conn.query('...'); await conn.close(); res.json(result); }); // Good: Use connection pool app.get('/data', async (req, res) => { const result = await pool.query('...'); // Reuses connection res.json(result); }); </code></pre></div> <h4 id="batch-operations" class="position-relative d-flex align-items-center group"> Batch Operations <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="batch-operations" aria-haspopup="dialog" aria-label="Share link: Batch Operations"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-javascript" data-lang="javascript">// Process items in batches async function batchInsert(items, batchSize = 100) { const conn = await pool.acquire(); try { await conn.beginTransaction(); for (let i = 0; i < items.length; i += batchSize) { const batch = items.slice(i, i + batchSize); await conn.execute( `UNWIND $items AS item CREATE (p:Product { id: item.id, name: item.name, price: item.price })`, { items: batch } ); } await conn.commit(); } catch (err) { await conn.rollback(); throw err; } finally { pool.release(conn); } } </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/typescript/" >TypeScript</a> : TypeScript type definitions and usage</li> <li><a href="/tags/nodejs/" >Node.js</a> : Node.js specific patterns</li> <li><a href="/tags/client-libraries/" >Client Libraries</a> : Overview of all client libraries</li> <li><a href="/tags/protocol/" >Protocol</a> : Wire protocol specification</li> <li><a href="/tags/performance/" >Performance</a> : Query optimization tips</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>Node.js Client API Reference: Complete API documentation</li> <li>Express Integration Guide: Building REST APIs with Geode</li> <li>GraphQL Integration: Using Geode as a GraphQL data source</li> <li>Serverless Deployment: Using Geode with AWS Lambda, Vercel</li> <li>Testing Guide: Unit and integration testing patterns</li> </ul> Browse the tagged content below for JavaScript and Node.js documentation, tutorials, and examples.

Popular

JavaScript Client Library - Node.js SDK for Geode Graph Database

Related Articles

Node.js Client