API Reference

Comprehensive API reference documentation for Geode covering GQL language syntax, client library interfaces, wire protocol specification, and all developer-facing APIs. <h3 id="gql-language-reference" class="position-relative d-flex align-items-center group"> GQL Language 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="gql-language-reference" aria-haspopup="dialog" aria-label="Share link: GQL Language Reference"> Share link </button> </h3><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> <h4 id="query-syntax" class="position-relative d-flex align-items-center group"> Query Syntax <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-syntax" aria-haspopup="dialog" aria-label="Share link: Query Syntax"> Share link </button> </h4>Pattern matching and data retrieval: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">// Basic pattern matching MATCH (variable:Label {property: value}) WHERE condition RETURN expression // Multi-pattern matching MATCH (a:User)-[r:KNOWS]->(b:User) WHERE a.age > 25 AND b.verified = true RETURN a.name, r.since, b.name // Variable-length paths MATCH path = (start)-[:KNOWS*1..3]->(end) WHERE start.name = 'Alice' RETURN path, LENGTH(path) // Optional patterns MATCH (u:User) OPTIONAL MATCH (u)-[:HAS_PROFILE]->(p:Profile) RETURN u.name, p.bio </code></pre></div> <h4 id="data-modification" class="position-relative d-flex align-items-center group"> Data Modification <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="data-modification" aria-haspopup="dialog" aria-label="Share link: Data Modification"> Share link </button> </h4>Create, update, and delete operations: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">// CREATE - insert new nodes/relationships CREATE (n:Label {property: value}) CREATE (a)-[r:TYPE {property: value}]->(b) // SET - update properties MATCH (n:User {id: 123}) SET n.name = 'New Name', n.updated_at = NOW() // DELETE - remove nodes/relationships MATCH (n:User {id: 123}) DELETE n // DETACH DELETE - remove node and all relationships MATCH (n:User {id: 123}) DETACH DELETE n // MERGE - upsert operation MERGE (u:User {email: 'alice@example.com'}) ON CREATE SET u.created_at = NOW() ON MATCH SET u.last_seen = NOW() </code></pre></div> <h4 id="schema-operations" class="position-relative d-flex align-items-center group"> Schema 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="schema-operations" aria-haspopup="dialog" aria-label="Share link: Schema Operations"> Share link </button> </h4>Indexes, constraints, and schema management: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">// CREATE INDEX CREATE INDEX FOR (n:Label) ON (n.property) CREATE INDEX index_name FOR (n:Label) ON (n.prop1, n.prop2) // CREATE CONSTRAINT CREATE CONSTRAINT ON (n:Label) ASSERT n.property IS UNIQUE CREATE CONSTRAINT ON (n:Label) ASSERT EXISTS(n.property) // DROP INDEX/CONSTRAINT DROP INDEX index_name DROP CONSTRAINT constraint_name // SHOW INDEXES/CONSTRAINTS SHOW INDEXES SHOW CONSTRAINTS </code></pre></div> <h3 id="python-client-api" class="position-relative d-flex align-items-center group"> Python Client API <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="python-client-api" aria-haspopup="dialog" aria-label="Share link: Python Client API"> Share link </button> </h3> <h4 id="connection-management" class="position-relative d-flex align-items-center group"> Connection Management <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="connection-management" aria-haspopup="dialog" aria-label="Share link: Connection Management"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-python" data-lang="python">from geode_client import Client import asyncio # Basic connection client = Client(host="localhost", port=3141) async with client.connection() as conn: result, _ = await conn.query("MATCH (n:User) RETURN n LIMIT 10") # With authentication client = Client( 'localhost:3141', username='admin', password='password', tls_verify=True, ca_cert='/path/to/ca.crt' ) # Connection pool client = Client( 'localhost:3141', pool_size=20, pool_timeout=30 ) </code></pre></div> <h4 id="query-execution" class="position-relative d-flex align-items-center group"> Query Execution <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-execution" aria-haspopup="dialog" aria-label="Share link: Query Execution"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-python" data-lang="python"># Simple query result, _ = await client.query("MATCH (u:User) RETURN u.name") for row in result.rows: print(row['u.name']) # Parameterized query result, _ = await client.query( "MATCH (u:User {id: $id}) RETURN u", {"id": 123} ) # Prepared statement stmt = await client.prepare("MATCH (u:User {id: $id}) RETURN u") result, _ = await stmt.execute({"id": 123}) # Batch execution queries = [ ("CREATE (:User {id: $id, name: $name})", {"id": 1, "name": "Alice"}), ("CREATE (:User {id: $id, name: $name})", {"id": 2, "name": "Bob"}), ] for query, params in queries: await client.execute(query, params) </code></pre></div> <h4 id="transaction-api" class="position-relative d-flex align-items-center group"> Transaction API <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-api" aria-haspopup="dialog" aria-label="Share link: Transaction API"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-python" data-lang="python"># Explicit transactions async with client.connection() as tx: await tx.begin() await tx.execute("CREATE (:User {id: 1})") await tx.execute("CREATE (:User {id: 2})") await tx.commit() # Transaction with savepoints async with client.connection() as tx: await tx.begin() await tx.execute("CREATE (:User {id: 1})") sp = await tx.savepoint('sp1') await tx.execute("CREATE (:User {id: 2})") await tx.rollback_to(sp) await tx.commit() # Only user 1 committed </code></pre></div> <h3 id="go-client-api" class="position-relative d-flex align-items-center group"> Go Client API <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="go-client-api" aria-haspopup="dialog" aria-label="Share link: Go Client API"> Share link </button> </h3> <h4 id="databasesql-interface" class="position-relative d-flex align-items-center group"> Database/SQL Interface <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="databasesql-interface" aria-haspopup="dialog" aria-label="Share link: Database/SQL Interface"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go">import ( "database/sql" _ "geodedb.com/geode" ) // Open connection db, err := sql.Open("geode", "quic://localhost:3141?insecure_tls_skip_verify=true") defer db.Close() // Query execution rows, err := db.Query("MATCH (u:User) WHERE u.age > $1 RETURN u.name, u.age", 25) defer rows.Close() for rows.Next() { var name string var age int err := rows.Scan(&name, &age) fmt.Printf("%s: %d\n", name, age) } // Prepared statements stmt, err := db.Prepare("MATCH (u:User {id: $1}) RETURN u") defer stmt.Close() rows, err = stmt.Query(123) </code></pre></div> <h4 id="transaction-handling" class="position-relative d-flex align-items-center group"> Transaction 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="transaction-handling" aria-haspopup="dialog" aria-label="Share link: Transaction Handling"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go">// Begin transaction tx, err := db.Begin() defer tx.Rollback() // Rollback if not committed // Execute in transaction _, err = tx.Exec("CREATE (:User {id: $1, name: $2})", 1, "Alice") _, err = tx.Exec("CREATE (:User {id: $1, name: $2})", 2, "Bob") // Commit err = tx.Commit() </code></pre></div> <h3 id="rust-client-api" class="position-relative d-flex align-items-center group"> Rust Client API <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="rust-client-api" aria-haspopup="dialog" aria-label="Share link: Rust Client API"> Share link </button> </h3> <h4 id="async-client" class="position-relative d-flex align-items-center group"> Async 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="async-client" aria-haspopup="dialog" aria-label="Share link: Async Client"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-rust" data-lang="rust">use geode_client::{Client, Error, Value}; use std::collections::HashMap; // Connect let client = Client::from_dsn("localhost:3141")?; let mut conn = client.connect().await?; // Query execution let (page, _) = conn.query("MATCH (u:User) RETURN u.name").await?; for row in &page.rows { let name = row.get("u.name").unwrap().as_string()?; println!("{}", name); } // Parameterized query let mut params = HashMap::new(); params.insert("id".to_string(), Value::int(123)); let _ = conn .query_with_params("MATCH (u:User {id: $id}) RETURN u", &params) .await?; // Transaction conn.begin().await?; let _ = conn.query("CREATE (:User {id: 1})").await?; let _ = conn.query("CREATE (:User {id: 2})").await?; conn.commit().await?; </code></pre></div> <h3 id="wire-protocol-reference" class="position-relative d-flex align-items-center group"> Wire Protocol 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="wire-protocol-reference" aria-haspopup="dialog" aria-label="Share link: Wire Protocol Reference"> Share link </button> </h3> <h4 id="json-line-protocol" class="position-relative d-flex align-items-center group"> JSON Line Protocol <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="json-line-protocol" aria-haspopup="dialog" aria-label="Share link: JSON Line Protocol"> Share link </button> </h4>Each message is a JSON object followed by newline: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-json" data-lang="json">// Client HELLO message {"type":"HELLO","version":"1.0","auth":{"username":"admin","password":"secret"}} // Server SCHEMA response {"type":"SCHEMA","fields":[{"name":"u.name","type":"STRING"},{"name":"u.age","type":"INTEGER"}]} // Client RUN_GQL message {"type":"RUN_GQL","query":"MATCH (u:User) RETURN u.name, u.age","params":{}} // Server BINDINGS response {"type":"BINDINGS","data":[{"u.name":"Alice","u.age":30}]} {"type":"BINDINGS","data":[{"u.name":"Bob","u.age":25}]} {"type":"SUCCESS","summary":{"rows":2,"time_ms":15}} // Server ERROR response {"type":"ERROR","code":"42000","message":"Syntax error: unexpected token","position":12} </code></pre></div> <h4 id="message-types" class="position-relative d-flex align-items-center group"> Message Types <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="message-types" aria-haspopup="dialog" aria-label="Share link: Message Types"> Share link </button> </h4>Client Messages: <ul> <li><code>HELLO</code> - Connection handshake</li> <li><code>RUN_GQL</code> - Execute GQL query</li> <li><code>PULL</code> - Fetch results (streaming)</li> <li><code>BEGIN</code> - Start transaction</li> <li><code>COMMIT</code> - Commit transaction</li> <li><code>ROLLBACK</code> - Rollback transaction</li> <li><code>PING</code> - Keep-alive</li> </ul> Server Messages: <ul> <li><code>SCHEMA</code> - Query result schema</li> <li><code>BINDINGS</code> - Result rows</li> <li><code>SUCCESS</code> - Operation completed</li> <li><code>ERROR</code> - Error with ISO code</li> <li><code>EXPLAIN</code> - Query execution plan</li> <li><code>PROFILE</code> - Performance metrics</li> </ul> <h3 id="error-codes" class="position-relative d-flex align-items-center group"> 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="error-codes" aria-haspopup="dialog" aria-label="Share link: Error Codes"> Share link </button> </h3>ISO SQL/GQL standard error codes: <table> <thead> <tr> <th>Code</th> <th>Category</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td>00000</td> <td>Success</td> <td>No error</td> </tr> <tr> <td>02000</td> <td>No Data</td> <td>Query returned no results</td> </tr> <tr> <td>21000</td> <td>Cardinality</td> <td>Too many/few rows</td> </tr> <tr> <td>22000</td> <td>Data Exception</td> <td>Invalid data value</td> </tr> <tr> <td>23000</td> <td>Constraint</td> <td>Constraint violation</td> </tr> <tr> <td>42000</td> <td>Syntax Error</td> <td>Invalid GQL syntax</td> </tr> <tr> <td>42S01</td> <td>Object Exists</td> <td>Object already exists</td> </tr> <tr> <td>42S02</td> <td>Object Not Found</td> <td>Object does not exist</td> </tr> <tr> <td>40001</td> <td>Transaction</td> <td>Serialization failure</td> </tr> <tr> <td>08000</td> <td>Connection</td> <td>Connection error</td> </tr> </tbody> </table> <h3 id="rest-api-experimental" class="position-relative d-flex align-items-center group"> REST API (Experimental) <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="rest-api-experimental" aria-haspopup="dialog" aria-label="Share link: REST API (Experimental)"> Share link </button> </h3>HTTP interface for query execution: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash"># Execute query curl -X POST http://localhost:3141/query \ -H "Content-Type: application/json" \ -d '{ "query": "MATCH (u:User) RETURN u.name LIMIT 10", "params": {} }' # Response { "schema": [{"name": "u.name", "type": "STRING"}], "data": [ {"u.name": "Alice"}, {"u.name": "Bob"} ], "summary": {"rows": 2, "time_ms": 12} } # Health check curl http://localhost:3141/health # Metrics curl http://localhost:3141/metrics </code></pre></div> <h3 id="configuration-reference" class="position-relative d-flex align-items-center group"> Configuration 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="configuration-reference" aria-haspopup="dialog" aria-label="Share link: Configuration Reference"> Share link </button> </h3>Server configuration options: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash">geode serve \ --listen 0.0.0.0:3141 \ --data-dir /var/lib/geode \ --wal-dir /var/lib/geode/wal \ --log-level info \ --max-connections 1000 \ --query-timeout 30000 \ --tls-cert /path/to/cert.pem \ --tls-key /path/to/key.pem \ --auth-enabled \ --replication-mode primary </code></pre></div> <h3 id="performance-tuning" class="position-relative d-flex align-items-center group"> Performance Tuning <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-tuning" aria-haspopup="dialog" aria-label="Share link: Performance Tuning"> Share link </button> </h3>Configuration parameters for optimization: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">// Query timeout SET query_timeout = 30000; // Memory limits SET max_memory_per_query = '1GB'; SET shared_buffer_size = '4GB'; // Connection pooling SET max_connections = 1000; SET connection_timeout = 10000; // Cache settings SET query_cache_size = '512MB'; SET index_cache_size = '2GB'; </code></pre></div> <h3 id="best-practices" class="position-relative d-flex align-items-center group"> 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="best-practices" aria-haspopup="dialog" aria-label="Share link: Best Practices"> Share link </button> </h3><ol> <li>Use Prepared Statements: For repeated queries with different parameters</li> <li>Batch Operations: Group multiple writes into transactions</li> <li>Connection Pooling: Reuse connections for better performance</li> <li>Error Handling: Always check error codes and handle appropriately</li> <li>Parameter Binding: Never concatenate user input into queries</li> <li>Index Usage: Create indexes for frequently queried properties</li> <li>Limit Results: Always use LIMIT for exploratory queries</li> </ol> <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>GQL Syntax: Complete language syntax guide</li> <li>Client Libraries: Language-specific guides</li> <li>Protocol Specification: Detailed wire protocol</li> <li>Error Handling: Error codes and handling</li> <li>Performance: Query optimization</li> </ul> <h3 id="further-reading" class="position-relative d-flex align-items-center group"> Further Reading <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="further-reading" aria-haspopup="dialog" aria-label="Share link: Further Reading"> Share link </button> </h3><ul> <li><a href="/tags/gql-reference/" >GQL Reference</a> - Complete GQL documentation</li> <li><a href="/tags/python/" >Python Client</a> - Python-specific API details</li> <li><a href="/tags/go/" >Go Client</a> - Go client documentation</li> <li><a href="/tags/rust/" >Rust Client</a> - Rust client documentation</li> <li><a href="/tags/protocol/" >Protocol</a> - Wire protocol specification</li> </ul> This reference provides the complete API surface for building applications with Geode, from GQL queries to client library integration and protocol-level communication. <h3 id="comprehensive-gql-functions-reference" class="position-relative d-flex align-items-center group"> Comprehensive GQL Functions 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="comprehensive-gql-functions-reference" aria-haspopup="dialog" aria-label="Share link: Comprehensive GQL Functions Reference"> Share link </button> </h3> <h4 id="string-functions" class="position-relative d-flex align-items-center group"> String Functions <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="string-functions" aria-haspopup="dialog" aria-label="Share link: String Functions"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">-- String manipulation RETURN upper('hello'); -- 'HELLO' RETURN lower('WORLD'); -- 'world' RETURN substring('Geode', 0, 3); -- 'Geo' RETURN trim(' text '); -- 'text' RETURN replace('foo bar', 'bar', 'baz'); -- 'foo baz' RETURN split('a,b,c', ','); -- ['a', 'b', 'c'] RETURN concat('Hello', ' ', 'World'); -- 'Hello World' RETURN length('Geode'); -- 5 RETURN reverse('abc'); -- 'cba' </code></pre></div> <h4 id="numeric-functions" class="position-relative d-flex align-items-center group"> Numeric Functions <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="numeric-functions" aria-haspopup="dialog" aria-label="Share link: Numeric Functions"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">-- Math operations RETURN abs(-42); -- 42 RETURN ceil(3.14); -- 4 RETURN floor(3.99); -- 3 RETURN round(3.567, 2); -- 3.57 RETURN sqrt(16); -- 4.0 RETURN pow(2, 8); -- 256 RETURN log(100); -- 4.605 (natural log) RETURN log10(1000); -- 3.0 RETURN exp(1); -- 2.718 RETURN sin(0); -- 0.0 RETURN cos(0); -- 1.0 RETURN rand(); -- Random float [0.0, 1.0) </code></pre></div> <h4 id="datetime-functions" class="position-relative d-flex align-items-center group"> Date/Time Functions <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="datetime-functions" aria-haspopup="dialog" aria-label="Share link: Date/Time Functions"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">-- Current timestamp RETURN now(); -- Current timestamp RETURN date(); -- Current date RETURN time(); -- Current time -- Date construction RETURN datetime('2024-01-15T10:30:00Z'); RETURN date({year: 2024, month: 1, day: 15}); RETURN time({hour: 14, minute: 30, second: 0}); -- Date arithmetic RETURN datetime() + duration({days: 7}); -- One week from now RETURN datetime() - duration({hours: 24}); -- Yesterday RETURN duration.between(date('2024-01-01'), date('2024-12-31')); -- Date extraction RETURN year(datetime()); -- 2024 RETURN month(datetime()); -- 1 RETURN day(datetime()); -- 15 RETURN hour(datetime()); -- 14 RETURN minute(datetime()); -- 30 RETURN second(datetime()); -- 0 RETURN dayOfWeek(datetime()); -- 1-7 (Monday=1) </code></pre></div> <h4 id="aggregation-functions" class="position-relative d-flex align-items-center group"> Aggregation Functions <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="aggregation-functions" aria-haspopup="dialog" aria-label="Share link: Aggregation Functions"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">-- Basic aggregations MATCH (u:User) RETURN count(u) AS total_users, count(DISTINCT u.city) AS unique_cities, sum(u.age) AS total_age, avg(u.age) AS average_age, min(u.age) AS youngest, max(u.age) AS oldest, stdev(u.age) AS age_std_dev, percentile_cont(u.age, 0.5) AS median_age, percentile_cont(u.age, 0.95) AS p95_age; -- Collection aggregations MATCH (u:User) RETURN collect(u.name) AS all_names, collect(DISTINCT u.city) AS all_cities; </code></pre></div> <h4 id="list-functions" class="position-relative d-flex align-items-center group"> List Functions <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="list-functions" aria-haspopup="dialog" aria-label="Share link: List Functions"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">-- List operations RETURN size([1, 2, 3, 4, 5]); -- 5 RETURN head([1, 2, 3]); -- 1 RETURN last([1, 2, 3]); -- 3 RETURN tail([1, 2, 3]); -- [2, 3] RETURN [x IN [1, 2, 3, 4, 5] WHERE x > 2]; -- [3, 4, 5] RETURN [x IN [1, 2, 3] | x * 2]; -- [2, 4, 6] RETURN reduce(s = 0, x IN [1, 2, 3] | s + x); -- 6 RETURN range(0, 10, 2); -- [0, 2, 4, 6, 8, 10] </code></pre></div> <h4 id="graph-functions" class="position-relative d-flex align-items-center group"> Graph Functions <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="graph-functions" aria-haspopup="dialog" aria-label="Share link: Graph Functions"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">-- Node and relationship functions MATCH (n:User) RETURN id(n) AS node_id, labels(n) AS node_labels, keys(n) AS property_keys, properties(n) AS all_properties; MATCH (a)-[r]->(b) RETURN id(r) AS relationship_id, type(r) AS relationship_type, startNode(r) AS start, endNode(r) AS end; -- Path functions MATCH path = (a:User)-[:KNOWS*1..3]->(b:User) RETURN length(path) AS path_length, nodes(path) AS path_nodes, relationships(path) AS path_relationships; </code></pre></div> <h4 id="type-checking-and-coercion" class="position-relative d-flex align-items-center group"> Type Checking and Coercion <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-checking-and-coercion" aria-haspopup="dialog" aria-label="Share link: Type Checking and Coercion"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">-- Type checking RETURN toBoolean('true'); -- true RETURN toFloat('3.14'); -- 3.14 RETURN toInteger('42'); -- 42 RETURN toString(123); -- '123' -- Type predicates WITH value RETURN value IS NULL AS is_null, value IS NOT NULL AS is_not_null; </code></pre></div> <h3 id="advanced-query-patterns" class="position-relative d-flex align-items-center group"> Advanced Query Patterns <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="advanced-query-patterns" aria-haspopup="dialog" aria-label="Share link: Advanced Query Patterns"> Share link </button> </h3> <h4 id="common-table-expressions-with" class="position-relative d-flex align-items-center group"> Common Table Expressions (WITH) <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="common-table-expressions-with" aria-haspopup="dialog" aria-label="Share link: Common Table Expressions (WITH)"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">-- Multi-stage query with WITH MATCH (u:User)-[:PURCHASED]->(p:Product) WITH u, count(p) AS purchase_count WHERE purchase_count > 5 MATCH (u)-[:LIVES_IN]->(c:City) WITH u, purchase_count, c ORDER BY purchase_count DESC LIMIT 100 MATCH (u)-[:FRIEND]->(f:User) WHERE (f)-[:LIVES_IN]->(c) RETURN u.name, purchase_count, c.name, count(f) AS local_friends ORDER BY local_friends DESC; </code></pre></div> <h4 id="conditional-logic-case" class="position-relative d-flex align-items-center group"> Conditional Logic (CASE) <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="conditional-logic-case" aria-haspopup="dialog" aria-label="Share link: Conditional Logic (CASE)"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">MATCH (u:User) RETURN u.name, CASE WHEN u.age < 18 THEN 'minor' WHEN u.age < 65 THEN 'adult' ELSE 'senior' END AS age_category, CASE u.subscription_tier WHEN 'free' THEN 0 WHEN 'premium' THEN 9.99 WHEN 'enterprise' THEN 99.99 ELSE 0 END AS monthly_cost; </code></pre></div> <h4 id="window-functions" class="position-relative d-flex align-items-center group"> Window Functions <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="window-functions" aria-haspopup="dialog" aria-label="Share link: Window Functions"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">-- Ranking and partitioning MATCH (u:User)-[:PURCHASED]->(p:Product) RETURN u.name, p.category, p.price, row_number() OVER (PARTITION BY p.category ORDER BY p.price DESC) AS category_rank, rank() OVER (ORDER BY p.price DESC) AS overall_rank, percent_rank() OVER (PARTITION BY p.category ORDER BY p.price) AS price_percentile; </code></pre></div> <h4 id="recursive-queries" class="position-relative d-flex align-items-center group"> Recursive 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="recursive-queries" aria-haspopup="dialog" aria-label="Share link: Recursive Queries"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">-- Recursive traversal (organizational hierarchy) MATCH path = (emp:Employee {id: $employee_id})-[:REPORTS_TO*0..]->(mgr:Employee) RETURN emp.name AS employee, [n IN nodes(path) | n.name] AS reporting_chain, length(path) AS levels_up; -- Fixed-depth recursion MATCH (start:Category {name: 'Electronics'})-[:SUBCATEGORY*3]->(end:Category) RETURN end.name AS subcategory_3_levels_down; </code></pre></div> <h3 id="client-library-advanced-features" class="position-relative d-flex align-items-center group"> Client Library 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="client-library-advanced-features" aria-haspopup="dialog" aria-label="Share link: Client Library Advanced Features"> Share link </button> </h3> <h4 id="python-client-streaming-results" class="position-relative d-flex align-items-center group"> Python Client: 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="python-client-streaming-results" aria-haspopup="dialog" aria-label="Share link: Python Client: Streaming Results"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-python" data-lang="python">from geode_client import Client client = Client(host="localhost", port=3141) async with client.connection() as conn: # Stream large result sets async for batch in client.query_stream(""" MATCH (u:User) RETURN u.id, u.name, u.email """, batch_size=1000): # Process batch of 1000 rows await process_users(batch) # Memory efficient for millions of rows </code></pre></div> <h4 id="python-client-query-builders" class="position-relative d-flex align-items-center group"> Python Client: Query Builders <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="python-client-query-builders" aria-haspopup="dialog" aria-label="Share link: Python Client: Query Builders"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-python" data-lang="python">from geode_client import QueryBuilder # Programmatic query construction qb = QueryBuilder() query = (qb .match("(u:User)") .where("u.age > $min_age") .where("u.city = $city") .return_("u.name", "u.age") .order_by("u.age DESC") .limit(10) .build()) result, _ = await client.query(query, {"min_age": 25, "city": "Seattle"}) </code></pre></div> <h4 id="go-client-context-and-timeouts" class="position-relative d-flex align-items-center group"> Go Client: Context and Timeouts <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="go-client-context-and-timeouts" aria-haspopup="dialog" aria-label="Share link: Go Client: Context and Timeouts"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go">import ( "context" "time" "geodedb.com/geode" ) // Query with timeout ctx, cancel := context.WithTimeout(context.Background(), 5*time.Second) defer cancel() rows, err := db.QueryContext(ctx, ` MATCH (u:User)-[:PURCHASED]->(p:Product) WHERE p.category = $1 RETURN u.name, count(p) AS purchases ORDER BY purchases DESC LIMIT 100 `, "Electronics") if err == context.DeadlineExceeded { // Query timed out } </code></pre></div> <h4 id="go-client-bulk-insert" class="position-relative d-flex align-items-center group"> Go Client: Bulk Insert <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="go-client-bulk-insert" aria-haspopup="dialog" aria-label="Share link: Go Client: Bulk Insert"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go">// Efficient bulk insert with prepared statement stmt, err := db.Prepare("CREATE (:User {id: $1, name: $2, email: $3})") defer stmt.Close() tx, err := db.Begin() defer tx.Rollback() for _, user := range users { _, err = tx.Stmt(stmt).Exec(user.ID, user.Name, user.Email) if err != nil { return err } } err = tx.Commit() // Commit all inserts atomically </code></pre></div> <h4 id="rust-client-type-safe-query-results" class="position-relative d-flex align-items-center group"> Rust Client: Type-Safe Query 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="rust-client-type-safe-query-results" aria-haspopup="dialog" aria-label="Share link: Rust Client: Type-Safe Query Results"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-rust" data-lang="rust">use geode_client::Client; let client = Client::from_dsn("localhost:3141")?; let mut conn = client.connect().await?; // Type-safe result access let (page, _) = conn .query("MATCH (u:User) WHERE u.active = true RETURN u.id, u.name, u.email, u.age") .await?; for row in &page.rows { let id = row.get("u.id").unwrap().as_int()?; let name = row.get("u.name").unwrap().as_string()?; let email = row.get("u.email").unwrap().as_string()?; println!("{}: {} ({})", id, name, email); } </code></pre></div> <h3 id="protocol-deep-dive" class="position-relative d-flex align-items-center group"> Protocol Deep Dive <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="protocol-deep-dive" aria-haspopup="dialog" aria-label="Share link: Protocol Deep Dive"> Share link </button> </h3> <h4 id="connection-handshake" class="position-relative d-flex align-items-center group"> Connection Handshake <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-handshake" aria-haspopup="dialog" aria-label="Share link: Connection Handshake"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-json" data-lang="json">// Client sends HELLO { "type": "HELLO", "version": "1.0", "client": "geode-python/0.3.19", "auth": { "method": "basic", "username": "admin", "password": "secret" }, "capabilities": { "streaming": true, "prepared_statements": true, "transactions": true } } // Server responds with welcome { "type": "WELCOME", "version": "1.0", "server": "geode/0.2.18", "session_id": "550e8400-e29b-41d4-a716-446655440000", "capabilities": { "max_query_size": 1048576, "supported_isolation_levels": ["READ_COMMITTED", "REPEATABLE_READ", "SERIALIZABLE"] } } </code></pre></div> <h4 id="query-execution-flow" class="position-relative d-flex align-items-center group"> Query Execution Flow <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-execution-flow" aria-haspopup="dialog" aria-label="Share link: Query Execution Flow"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-json" data-lang="json">// Client sends query { "type": "RUN_GQL", "query": "MATCH (u:User {id: $id}) RETURN u.name, u.email", "params": {"id": 123}, "options": { "timeout_ms": 30000, "include_stats": true } } // Server sends schema { "type": "SCHEMA", "fields": [ {"name": "u.name", "type": "STRING", "nullable": false}, {"name": "u.email", "type": "STRING", "nullable": true} ] } // Server streams results { "type": "BINDINGS", "data": [ {"u.name": "Alice", "u.email": "[email protected]"} ] } // Server sends success { "type": "SUCCESS", "summary": { "rows": 1, "time_ms": 2.5, "nodes_scanned": 1, "index_hits": 1 } } </code></pre></div> <h4 id="transaction-protocol" class="position-relative d-flex align-items-center group"> Transaction Protocol <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-protocol" aria-haspopup="dialog" aria-label="Share link: Transaction Protocol"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-json" data-lang="json">// BEGIN {"type": "BEGIN", "isolation_level": "SERIALIZABLE"} {"type": "SUCCESS", "transaction_id": "tx-98765"} // RUN_GQL (within transaction) {"type": "RUN_GQL", "transaction_id": "tx-98765", "query": "CREATE (:User {name: 'Bob'})"} {"type": "SUCCESS", "summary": {"nodes_created": 1}} // COMMIT {"type": "COMMIT", "transaction_id": "tx-98765"} {"type": "SUCCESS", "summary": {"committed": true}} </code></pre></div> <h3 id="performance-tuning-reference" class="position-relative d-flex align-items-center group"> Performance Tuning 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="performance-tuning-reference" aria-haspopup="dialog" aria-label="Share link: Performance Tuning Reference"> Share link </button> </h3> <h4 id="query-hints" class="position-relative d-flex align-items-center group"> Query Hints <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-hints" aria-haspopup="dialog" aria-label="Share link: Query Hints"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">-- Force index usage MATCH (u:User) USING INDEX u:User(email) WHERE u.email = 'alice@example.com' RETURN u; -- Disable index (force scan) MATCH (u:User) WITHOUT INDEX WHERE u.age > 30 RETURN u; -- Join hint MATCH (u:User), (p:Product) WHERE u.id = p.user_id USING JOIN ON u.id = p.user_id RETURN u, p; </code></pre></div> <h4 id="query-plan-analysis" class="position-relative d-flex align-items-center group"> Query Plan Analysis <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-plan-analysis" aria-haspopup="dialog" aria-label="Share link: Query Plan Analysis"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">EXPLAIN MATCH (u:User)-[:PURCHASED]->(p:Product) WHERE u.city = 'Seattle' AND p.price > 100 RETURN u.name, p.name; -- Returns execution plan: -- IndexScan (User.city = 'Seattle') -- -> Expand ([:PURCHASED]) -- -> Filter (Product.price > 100) -- -> Return </code></pre></div> <h4 id="configuration-parameters" class="position-relative d-flex align-items-center group"> Configuration Parameters <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="configuration-parameters" aria-haspopup="dialog" aria-label="Share link: Configuration Parameters"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">-- Set session parameters SET query_timeout = 60000; -- 60 second timeout SET max_memory_per_query = '2GB'; -- Memory limit SET enable_parallel_scan = true; -- Parallel execution SET work_mem = '256MB'; -- Sort/hash memory -- View current settings SHOW ALL; SHOW query_timeout; </code></pre></div>This reference provides the complete API surface for building applications with Geode, from GQL queries to client library integration and protocol-level communication.

Popular

Related Articles

GQL Specification Reference

Pattern Matching in GQL

Complete GQL API Reference

API Reference and CLI Manual

DSN (Data Source Name) Specification

Advanced Pattern Matching Reference

Aggregation Functions

GQL Operators Reference

Index Types Reference

GQL Quick Reference

Data Types Reference

Statistics and Metrics Reference