Reference

<h2 id="reference" class="position-relative d-flex align-items-center group"> 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="reference" aria-haspopup="dialog" aria-label="Share link: Reference"> 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>Comprehensive technical reference documentation for Geode covering all APIs, commands, error codes, operators, and specifications. <h3 id="overview" class="position-relative d-flex align-items-center group"> Overview <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="overview" aria-haspopup="dialog" aria-label="Share link: Overview"> Share link </button> </h3>This section provides detailed reference material for developers, operators, and administrators working with Geode. Unlike guides that focus on how-to instructions, reference documentation provides exhaustive, structured information about every command, function, operator, and error code. Use this section when you need precise details about specific functionality, error messages, or command syntax. All reference material is organized for quick lookup and includes complete specifications. <h3 id="topics-in-this-section" class="position-relative d-flex align-items-center group"> Topics in This Section <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="topics-in-this-section" aria-haspopup="dialog" aria-label="Share link: Topics in This Section"> Share link </button> </h3><ul> <li><a href="/docs/reference/api-reference-complete/" >Complete API Reference</a> - Comprehensive API documentation covering all functions, methods, and interfaces</li> <li><a href="/docs/reference/cli-and-api/" >CLI and API</a> - Command-line interface reference including all CLI commands and options</li> <li><a href="/docs/reference/dsn/" >DSN Specification</a> - Official DSN format for QUIC/gRPC connection strings</li> <li><a href="/docs/reference/types/" >Data Types</a> - All 50+ data types with constructors and storage characteristics</li> <li><a href="/docs/reference/indexes/" >Index Types</a> - B-tree, Hash, Full-text, Spatial, Vector, and specialized indexes</li> <li><a href="/docs/reference/statistics/" >Statistics and Metrics</a> - Query statistics, storage metrics, and Prometheus integration</li> <li><a href="/docs/reference/error-codes/" >Error Codes</a> - Complete error code reference with descriptions and resolution steps</li> <li><a href="/docs/reference/status-codes/" >Status Codes</a> - GQL status codes following ISO/IEC 39075:2024 standard</li> <li><a href="/docs/reference/operators/" >Operators</a> - All supported operators including comparison, arithmetic, logical, and pattern operators</li> <li><a href="/docs/reference/type-conversion/" >Type Conversion</a> - Type conversion rules, coercion, and promotion specifications</li> <li><a href="/docs/reference/unicode-support/" >Unicode Support</a> - Unicode normalization, collation, and string handling</li> <li><a href="/docs/reference/changelog/" >Changelog</a> - Version history with detailed changes, features, and bug fixes</li> </ul> <h3 id="quick-reference" class="position-relative d-flex align-items-center group"> Quick 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="quick-reference" aria-haspopup="dialog" aria-label="Share link: Quick Reference"> Share link </button> </h3> <h4 id="common-functions" class="position-relative d-flex align-items-center group"> Common 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="common-functions" aria-haspopup="dialog" aria-label="Share link: Common Functions"> Share link </button> </h4>Aggregation Functions: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">COUNT(*), COUNT(expr) SUM(expr), AVG(expr) MIN(expr), MAX(expr) </code></pre></div>String Functions: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">lower(str), upper(str) substring(str, start, length) trim(str), ltrim(str), rtrim(str) </code></pre></div>Temporal Functions: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">now(), timestamp() date('2024-01-01') duration({days: 7}) </code></pre></div>Spatial Functions: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">distance(point1, point2) point({latitude: 47.6, longitude: -122.3}) </code></pre></div>See <a href="/docs/reference/api-reference-complete/" >API Reference</a> for complete function list. <h4 id="common-operators" class="position-relative d-flex align-items-center group"> Common Operators <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-operators" aria-haspopup="dialog" aria-label="Share link: Common Operators"> Share link </button> </h4>Comparison: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">=, <>, <, <=, >, >= IS NULL, IS NOT NULL IN, NOT IN </code></pre></div>Arithmetic: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">+, -, *, /, % </code></pre></div>Logical: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">AND, OR, NOT, XOR </code></pre></div>Pattern: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">STARTS WITH, ENDS WITH, CONTAINS =~ -- Regular expression match </code></pre></div>See <a href="/docs/reference/operators/" >Operators</a> for complete reference. <h4 id="cli-commands" class="position-relative d-flex align-items-center group"> CLI Commands <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="cli-commands" aria-haspopup="dialog" aria-label="Share link: CLI Commands"> Share link </button> </h4>Server Management: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash">geode serve # Start server geode shell # Interactive shell geode --version # Show version </code></pre></div>Client Operations: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash">geode query "query" # Execute query geode query -f file.gql # Execute file geode query --format json "RETURN 1" # JSON output </code></pre></div>Administration: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash">geode backup # Create backup geode restore # Restore backup geode validate # Validate data </code></pre></div>See <a href="/docs/reference/cli-and-api/" >CLI and API</a> for complete CLI reference. <h3 id="error-code-categories" class="position-relative d-flex align-items-center group"> Error Code Categories <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-code-categories" aria-haspopup="dialog" aria-label="Share link: Error Code Categories"> Share link </button> </h3> <h4 id="client-errors-4xxxx" class="position-relative d-flex align-items-center group"> Client Errors (4xxxx) <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-errors-4xxxx" aria-haspopup="dialog" aria-label="Share link: Client Errors (4xxxx)"> Share link </button> </h4>Errors caused by client requests: <ul> <li>40001: Syntax error in query</li> <li>40002: Semantic error (invalid operation)</li> <li>40003: Parameter mismatch</li> <li>40004: Constraint violation</li> </ul> <h4 id="server-errors-5xxxx" class="position-relative d-flex align-items-center group"> Server Errors (5xxxx) <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="server-errors-5xxxx" aria-haspopup="dialog" aria-label="Share link: Server Errors (5xxxx)"> Share link </button> </h4>Errors caused by server issues: <ul> <li>50001: Internal server error</li> <li>50002: Storage error</li> <li>50003: Network error</li> <li>50004: Resource exhausted</li> </ul> <h4 id="security-errors-6xxxx" class="position-relative d-flex align-items-center group"> Security Errors (6xxxx) <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="security-errors-6xxxx" aria-haspopup="dialog" aria-label="Share link: Security Errors (6xxxx)"> Share link </button> </h4>Authentication and authorization errors: <ul> <li>60001: Authentication failed</li> <li>60002: Authorization denied</li> <li>60003: Session expired</li> <li>60004: Invalid credentials</li> </ul> See <a href="/docs/reference/error-codes/" >Error Codes</a> for complete list with resolution steps. <h3 id="status-codes-iso-gql" class="position-relative d-flex align-items-center group"> Status Codes (ISO GQL) <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="status-codes-iso-gql" aria-haspopup="dialog" aria-label="Share link: Status Codes (ISO GQL)"> Share link </button> </h3>GQL status codes following ISO/IEC 39075:2024: <ul> <li>00000: Successful completion</li> <li>01xxx: Warning conditions</li> <li>02xxx: No data (query returned empty)</li> <li>22xxx: Data exception</li> <li>23xxx: Integrity constraint violation</li> <li>42xxx: Syntax error or access violation</li> </ul> See <a href="/docs/reference/status-codes/" >Status Codes</a> for ISO compliance details. <h3 id="type-system-reference" class="position-relative d-flex align-items-center group"> Type System 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="type-system-reference" aria-haspopup="dialog" aria-label="Share link: Type System Reference"> Share link </button> </h3> <h4 id="core-types" class="position-relative d-flex align-items-center group"> Core 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="core-types" aria-haspopup="dialog" aria-label="Share link: Core Types"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-fallback" data-lang="fallback">NULL BOOLEAN INTEGER FLOAT STRING BYTES </code></pre></div> <h4 id="temporal-types" class="position-relative d-flex align-items-center group"> Temporal 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="temporal-types" aria-haspopup="dialog" aria-label="Share link: Temporal Types"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-fallback" data-lang="fallback">DATE TIME TIMESTAMP ZONED_DATETIME DURATION INTERVAL </code></pre></div> <h4 id="collection-types" class="position-relative d-flex align-items-center group"> Collection 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="collection-types" aria-haspopup="dialog" aria-label="Share link: Collection Types"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-fallback" data-lang="fallback">LIST<T> MAP<K, V> SET<T> </code></pre></div> <h4 id="advanced-types" class="position-relative d-flex align-items-center group"> Advanced 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="advanced-types" aria-haspopup="dialog" aria-label="Share link: Advanced Types"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-fallback" data-lang="fallback">VECTOR<T> POINT POLYGON UUID JSON BIGDECIMAL MONEY CIDR </code></pre></div>See <a href="/docs/reference/type-conversion/" >Type Conversion</a> for conversion rules. <h3 id="unicode-support" class="position-relative d-flex align-items-center group"> Unicode Support <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="unicode-support" aria-haspopup="dialog" aria-label="Share link: Unicode Support"> Share link </button> </h3>Geode provides comprehensive Unicode support: <ul> <li>Normalization: NFD, NFC, NFKD, NFKC</li> <li>Collation: Locale-aware string comparison</li> <li>Case Folding: Unicode case-insensitive comparison</li> <li>Grapheme Clusters: Proper string length and indexing</li> </ul> See <a href="/docs/reference/unicode-support/" >Unicode Support</a> for details. <h3 id="version-information" class="position-relative d-flex align-items-center group"> Version Information <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="version-information" aria-haspopup="dialog" aria-label="Share link: Version Information"> Share link </button> </h3>Current stable release: v0.2.18 Current development branch: main (unreleased) Key metrics: <ul> <li>Full geodetestlab audit: 3,847 passed, 70 failed, 35 skipped (3,952 total)</li> <li>Unit tests: 619/619 passing on the <code>v0.2.18</code> release line</li> <li>GQL Compliance: see conformance profile</li> <li>Known open gaps on main: CLI auth delegation, FLE role-semicolon sanitization, stdin bulk <code>MERGE</code> error surfacing</li> </ul> See <a href="/docs/reference/changelog/" >Changelog</a> for version history. <h3 id="api-categories" class="position-relative d-flex align-items-center group"> API Categories <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-categories" aria-haspopup="dialog" aria-label="Share link: API Categories"> Share link </button> </h3> <h4 id="query-execution-api" class="position-relative d-flex align-items-center group"> Query Execution 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="query-execution-api" aria-haspopup="dialog" aria-label="Share link: Query Execution API"> Share link </button> </h4>Execute GQL queries programmatically: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go">// Go client example result, err := client.Query(ctx, "MATCH (n) RETURN n LIMIT 10") </code></pre></div><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-python" data-lang="python"># Python client example from geode_client import Client client = Client(host="localhost", port=3141) async with client.connection() as conn: page, _ = await conn.query("MATCH (n) RETURN n LIMIT 10") for row in page.rows: print(row) </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>Manage transactions: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go">tx, err := db.BeginTx(ctx, nil) if err != nil { return err } defer tx.Rollback() _, err = tx.ExecContext(ctx, "CREATE (:Person {name: 'Alice'})") if err != nil { return err } return tx.Commit() </code></pre></div> <h4 id="schema-api" class="position-relative d-flex align-items-center group"> Schema 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="schema-api" aria-haspopup="dialog" aria-label="Share link: Schema API"> Share link </button> </h4>Manage indexes and constraints: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">-- Index management CREATE INDEX person_email ON :Person(email); DROP INDEX person_email; -- Constraint management CREATE CONSTRAINT person_email_unique FOR (p:Person) REQUIRE p.email IS UNIQUE; </code></pre></div> <h4 id="security-api" class="position-relative d-flex align-items-center group"> Security 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="security-api" aria-haspopup="dialog" aria-label="Share link: Security API"> Share link </button> </h4>Authentication and authorization: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-python" data-lang="python">from geode_client import AuthClient, Client client = Client(host="localhost", port=3141) async with client.connection() as conn: auth = AuthClient(conn) session = await auth.login("geode", "secret") print(session.token) </code></pre></div>See <a href="/docs/reference/api-reference-complete/" >API Reference</a> for complete API documentation. <h3 id="command-line-interface" class="position-relative d-flex align-items-center group"> Command-Line 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="command-line-interface" aria-haspopup="dialog" aria-label="Share link: Command-Line Interface"> Share link </button> </h3> <h4 id="server-commands" class="position-relative d-flex align-items-center group"> Server Commands <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="server-commands" aria-haspopup="dialog" aria-label="Share link: Server Commands"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash"># Start server geode serve [OPTIONS] --listen <address> # Listen address (default: 127.0.0.1:3141) --data-dir <path> # Data directory --cert <path> # TLS certificate --key <path> # TLS key --config <path> # Configuration file # Interactive shell geode shell [OPTIONS] --connect <uri> # Server URI --format <txt|json> # Output format --file <path> # Execute script </code></pre></div> <h4 id="client-commands" class="position-relative d-flex align-items-center group"> Client Commands <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-commands" aria-haspopup="dialog" aria-label="Share link: Client Commands"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash"># Execute query geode query [OPTIONS] <query> -f, --file <path> # Execute from file --format <txt|json> # Output format --params <json> # Query parameters # Examples geode query "RETURN 1 AS x" geode query -f queries.gql --format json geode query "MATCH (n) WHERE n.id = \$id RETURN n" --params '{"id": 123}' </code></pre></div>See <a href="/docs/reference/cli-and-api/" >CLI and API</a> for complete command reference. <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>Key configuration options: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-yaml" data-lang="yaml">server: listen: '0.0.0.0:3141' data_dir: '/var/lib/geode' tls: cert: '/etc/geode/certs/server-cert.pem' key: '/etc/geode/certs/server-key.pem' storage: page_size: 8192 page_cache_size: '16GB' query: max_concurrent_queries: 1000 query_timeout: 30s security: tde: enabled: true key_hex: '<32-byte-hex-key>' logging: level: 'info' format: 'json' </code></pre></div>See <a href="/docs/configuration/" >Configuration Reference</a> for all options. <h3 id="protocol-specification" class="position-relative d-flex align-items-center group"> Protocol Specification <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-specification" aria-haspopup="dialog" aria-label="Share link: Protocol Specification"> Share link </button> </h3> <h4 id="protobuf-wire-protocol" class="position-relative d-flex align-items-center group"> Protobuf Wire 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="protobuf-wire-protocol" aria-haspopup="dialog" aria-label="Share link: Protobuf Wire Protocol"> Share link </button> </h4>Geode uses length-prefixed Protobuf messages over QUIC (default) or gRPC. The full schema is defined in <code>src/proto/geode.proto</code>. Client Messages: <ul> <li><code>HelloRequest</code> / <code>PingRequest</code></li> <li><code>ExecuteRequest</code> (RUN_GQL)</li> <li><code>PullRequest</code></li> <li><code>BeginRequest</code> / <code>CommitRequest</code> / <code>RollbackRequest</code></li> </ul> Server Responses: <ul> <li><code>HelloResponse</code></li> <li><code>ExecutionResponse</code> (payloads: <code>SchemaDefinition</code>, <code>DataPage</code>, <code>Error</code>, <code>ExplainPayload</code>, <code>ProfilePayload</code>)</li> </ul> See <a href="/docs/protocol/" >Wire Protocol</a> for the full specification. <ul> <li>PROFILE: Performance metrics</li> </ul> <h3 id="performance-characteristics" class="position-relative d-flex align-items-center group"> Performance Characteristics <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-characteristics" aria-haspopup="dialog" aria-label="Share link: Performance Characteristics"> Share link </button> </h3>Reference performance metrics: Query Performance: <ul> <li>Point lookup: <1ms (typically 100-500us)</li> <li>Short path (1-2 hops): 1-5ms</li> <li>Multi-hop path (3-5 hops): 10-100ms</li> <li>Large aggregation (1M rows): 100-500ms</li> </ul> Architecture: <ul> <li>Vector similarity: HNSW indexes with SIMD acceleration</li> <li>Storage: Memory-mapped I/O with page-level caching</li> <li>Indexes: Six specialized index types for different workloads</li> </ul> Scalability: <ul> <li>Distributed deployment with up to 32 shards</li> <li>Connection pooling for concurrent clients</li> </ul> See <a href="/docs/guides/performance-benchmarking/" >Performance Benchmarking</a> for methodology. <h3 id="standards-compliance" class="position-relative d-flex align-items-center group"> Standards Compliance <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="standards-compliance" aria-haspopup="dialog" aria-label="Share link: Standards Compliance"> Share link </button> </h3> <h4 id="isoiec-390752024-gql" class="position-relative d-flex align-items-center group"> ISO/IEC 39075:2024 (GQL) <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="isoiec-390752024-gql" aria-haspopup="dialog" aria-label="Share link: ISO/IEC 39075:2024 (GQL)"> Share link </button> </h4><ul> <li>✅ Complete pattern matching syntax</li> <li>✅ All aggregation functions</li> <li>✅ Set operations (UNION, INTERSECT, EXCEPT)</li> <li>✅ Transaction semantics</li> <li>✅ Error handling with standard codes</li> <li>✅ 100% compliance; see conformance profile</li> </ul> <h4 id="other-standards" class="position-relative d-flex align-items-center group"> Other Standards <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="other-standards" aria-haspopup="dialog" aria-label="Share link: Other Standards"> Share link </button> </h4><ul> <li>QUIC: RFC 9000</li> <li>TLS 1.3: RFC 8446</li> <li>JSON: RFC 8259</li> <li>UUID: RFC 4122</li> <li>IPv6: RFC 4291</li> <li>CIDR: RFC 4632</li> </ul> <h3 id="learn-more" class="position-relative d-flex align-items-center group"> Learn More <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="learn-more" aria-haspopup="dialog" aria-label="Share link: Learn More"> Share link </button> </h3><ul> <li><a href="/docs/gql/guide/" >GQL Guide</a> - Query language guide</li> <li><a href="/docs/data-types/" >Data Types</a> - Type system reference</li> <li><a href="/docs/architecture/" >Architecture</a> - System architecture</li> <li><a href="/docs/client-libraries/" >Client Libraries</a> - Language-specific APIs</li> <li><a href="/docs/guides/troubleshooting/" >Troubleshooting</a> - Error resolution</li> </ul> <h3 id="contributing-to-documentation" class="position-relative d-flex align-items-center group"> Contributing to Documentation <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="contributing-to-documentation" aria-haspopup="dialog" aria-label="Share link: Contributing to Documentation"> Share link </button> </h3>Found an error or want to improve the reference docs? See <a href="/docs/contribute/" >Contributing Guide</a> for how to submit improvements.

Popular

Pages

Complete GQL API Reference

API Reference and CLI Manual

DSN (Data Source Name) Specification

GQL Operators Reference

Index Types Reference

Data Types Reference

Statistics and Metrics Reference

Error Codes Reference

ISO GQL Status Codes Reference

Changelog

Type Conversion Functions

Unicode Support and Text Processing