Category: API and Technical Reference

The API and Technical Reference category provides authoritative, detailed documentation on every aspect of Geode’s interfaces, syntax, and configuration. This is your go-to resource for precise specifications, function signatures, parameter details, and technical specifications. <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="syntax-overview" class="position-relative d-flex align-items-center group"> Syntax 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="syntax-overview" aria-haspopup="dialog" aria-label="Share link: Syntax Overview"> Share link </button> </h4>Geode implements ISO/IEC 39075:2024 Graph Query Language aligned to the full GQL conformance profile. The GQL syntax includes: Data Manipulation Language (DML): <ul> <li><code>MATCH</code> - Pattern matching to find graph elements</li> <li><code>CREATE</code> - Create new nodes and relationships</li> <li><code>SET</code> - Update properties and labels</li> <li><code>REMOVE</code> - Delete properties and labels</li> <li><code>DELETE</code> - Remove nodes and relationships</li> <li><code>MERGE</code> - Match or create pattern</li> <li><code>RETURN</code> - Specify result projection</li> <li><code>WITH</code> - Pipeline query parts</li> </ul> Data Definition Language (DDL): <ul> <li><code>CREATE INDEX</code> - Create property indexes</li> <li><code>DROP INDEX</code> - Remove indexes</li> <li><code>CREATE CONSTRAINT</code> - Define data constraints</li> <li><code>DROP CONSTRAINT</code> - Remove constraints</li> <li><code>ANALYZE</code> - Update statistics</li> </ul> Transaction Control: <ul> <li><code>BEGIN</code> - Start transaction</li> <li><code>COMMIT</code> - Commit transaction</li> <li><code>ROLLBACK</code> - Abort transaction</li> <li><code>SAVEPOINT</code> - Create savepoint</li> <li><code>RELEASE</code> - Release savepoint</li> </ul> Query Analysis: <ul> <li><code>EXPLAIN</code> - Show execution plan</li> <li><code>PROFILE</code> - Execute with performance metrics</li> </ul> <h4 id="pattern-syntax" class="position-relative d-flex align-items-center group"> Pattern 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="pattern-syntax" aria-haspopup="dialog" aria-label="Share link: Pattern Syntax"> Share link </button> </h4>Node Patterns: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">() -- Anonymous node (n) -- Node bound to variable n (n:Label) -- Node with label (n:Label1:Label2) -- Node with multiple labels (n {prop: value}) -- Node with properties (n:Label {prop: value}) -- Combined </code></pre></div>Relationship Patterns: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">-[r]-> -- Directed relationship -[r]- -- Undirected relationship <-[r]- -- Directed (opposite direction) -[r:TYPE]-> -- Relationship with type -[r:TYPE1|TYPE2]-> -- Multiple types (OR) -[r:TYPE {prop: value}]-> -- With properties -[r:TYPE*]-> -- Variable length (any) -[r:TYPE*1..5]-> -- Variable length (bounded) -[r:TYPE*..3]-> -- Up to 3 hops -[r:TYPE*2..]-> -- At least 2 hops </code></pre></div>Path Patterns: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">path = (a)-[*]->(b) -- Bind entire path SHORTEST (a)-[*]->(b) -- Shortest path ALL SHORTEST (a)-[*]->(b) -- All shortest paths </code></pre></div> <h4 id="data-types" class="position-relative d-flex align-items-center group"> Data 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="data-types" aria-haspopup="dialog" aria-label="Share link: Data Types"> Share link </button> </h4>Primitive Types: <ul> <li><code>BOOLEAN</code> - true/false values</li> <li><code>INTEGER</code> - 64-bit signed integers (-2^63 to 2^63-1)</li> <li><code>FLOAT</code> - 64-bit IEEE 754 floating point</li> <li><code>STRING</code> - UTF-8 encoded text</li> <li><code>NULL</code> - Absence of value</li> </ul> Temporal Types: <ul> <li><code>DATE</code> - Calendar date (YYYY-MM-DD)</li> <li><code>TIME</code> - Time of day with timezone</li> <li><code>TIMESTAMP</code> - Date and time with timezone</li> <li><code>DURATION</code> - Time interval (ISO 8601 format)</li> </ul> Structured Types: <ul> <li><code>LIST</code> - Ordered collection: <code>[1, 2, 3]</code></li> <li><code>MAP</code> - Key-value pairs: <code>{name: 'Alice', age: 30}</code></li> </ul> Graph Types: <ul> <li><code>NODE</code> - Graph node</li> <li><code>RELATIONSHIP</code> - Graph edge</li> <li><code>PATH</code> - Sequence of nodes and relationships</li> </ul> Spatial Types (extension): <ul> <li><code>POINT</code> - Geographic or Cartesian coordinate</li> </ul> Vector Types (extension): <ul> <li><code>VECTOR</code> - Fixed-dimension numeric array for embeddings</li> </ul> <h4 id="built-in-functions" class="position-relative d-flex align-items-center group"> Built-in 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="built-in-functions" aria-haspopup="dialog" aria-label="Share link: Built-in Functions"> Share link </button> </h4>Scalar Functions: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">-- String functions lower(string) -> string upper(string) -> string substring(string, start, length) -> string trim(string) -> string replace(string, search, replacement) -> string length(string) -> integer starts_with(string, prefix) -> boolean ends_with(string, suffix) -> boolean contains(string, substring) -> boolean -- Numeric functions abs(number) -> number ceil(number) -> integer floor(number) -> integer round(number, precision) -> number sqrt(number) -> float power(base, exponent) -> number log(number) -> float exp(number) -> float sin(number), cos(number), tan(number) -> float -- Temporal functions current_date() -> date current_time() -> time current_timestamp() -> timestamp date(year, month, day) -> date timestamp(string) -> timestamp duration(string) -> duration </code></pre></div>Aggregation Functions: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">count(expression) -> integer sum(expression) -> number avg(expression) -> float min(expression) -> any max(expression) -> any collect(expression) -> list count{pattern} -> integer -- Count matching patterns </code></pre></div>List Functions: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">size(list) -> integer head(list) -> any -- First element last(list) -> any -- Last element tail(list) -> list -- All but first reverse(list) -> list range(start, end, step) -> list </code></pre></div>Path Functions: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">length(path) -> integer -- Number of relationships nodes(path) -> list<node> -- All nodes in path relationships(path) -> list<relationship> </code></pre></div>Predicate Functions: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">exists(pattern) -> boolean all(var IN list WHERE predicate) -> boolean any(var IN list WHERE predicate) -> boolean none(var IN list WHERE predicate) -> boolean single(var IN list WHERE predicate) -> boolean </code></pre></div>Type Functions: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">type(relationship) -> string -- Relationship type labels(node) -> list<string> -- Node labels properties(element) -> map -- All properties keys(element) -> list<string> -- Property names </code></pre></div> <h3 id="client-library-apis" class="position-relative d-flex align-items-center group"> Client Library APIs <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-apis" aria-haspopup="dialog" aria-label="Share link: Client Library APIs"> Share link </button> </h3> <h4 id="python-api-reference" class="position-relative d-flex align-items-center group"> Python API Reference <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="python-api-reference" aria-haspopup="dialog" aria-label="Share link: Python API Reference"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-python" data-lang="python">import geode_client # Connection async def connect( host: str, port: int = 3141, *, username: str | None = None, password: str | None = None, tls: bool = True, verify_cert: bool = True, timeout: float = 30.0 ) -> Connection # Connection methods class Connection: async def execute( self, query: str, parameters: dict[str, Any] | None = None, *, timeout: float | None = None ) -> ResultSet async def prepare( self, query: str ) -> PreparedStatement async def transaction( self, *, isolation: IsolationLevel = IsolationLevel.SERIALIZABLE ) -> Transaction async def close() -> None # Transaction methods class Transaction: async def execute( self, query: str, parameters: dict[str, Any] | None = None ) -> ResultSet async def commit() -> None async def rollback() -> None async def savepoint(name: str) -> Savepoint </code></pre></div> <h4 id="go-api-reference" class="position-relative d-flex align-items-center group"> Go API Reference <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="go-api-reference" aria-haspopup="dialog" aria-label="Share link: Go API Reference"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go">package geode // Connect to Geode server func Connect(ctx context.Context, dsn string) (*DB, error) // DB represents a connection pool type DB struct { // Query executes a query with optional parameters func (db *DB) Query(ctx context.Context, query string, args ...any) (*Rows, error) // Exec executes a query without returning rows func (db *DB) Exec(ctx context.Context, query string, args ...any) (Result, error) // Begin starts a new transaction func (db *DB) Begin(ctx context.Context) (*Tx, error) // Prepare creates a prepared statement func (db *DB) Prepare(ctx context.Context, query string) (*Stmt, error) // Close closes all connections func (db *DB) Close() error } // Tx represents a transaction type Tx struct { func (tx *Tx) Query(ctx context.Context, query string, args ...any) (*Rows, error) func (tx *Tx) Exec(ctx context.Context, query string, args ...any) (Result, error) func (tx *Tx) Commit() error func (tx *Tx) Rollback() error } </code></pre></div> <h4 id="rust-api-reference" class="position-relative d-flex align-items-center group"> Rust API Reference <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="rust-api-reference" aria-haspopup="dialog" aria-label="Share link: Rust API Reference"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-rust" data-lang="rust">// Connection pub async fn connect(config: ConnectionConfig) -> Result<Connection> impl Connection { // Execute query pub async fn execute( &self, query: &str, params: &[(&str, Value)] ) -> Result<ResultSet> // Prepare statement pub async fn prepare(&self, query: &str) -> Result<PreparedStatement> // Begin transaction pub async fn transaction(&self) -> Result<Transaction> } impl Transaction { pub async fn execute( &self, query: &str, params: &[(&str, Value)] ) -> Result<ResultSet> pub async fn commit(self) -> Result<()> pub async fn rollback(self) -> Result<()> pub async fn savepoint(&self, name: &str) -> Result<Savepoint> } </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> <h4 id="server-configuration" class="position-relative d-flex align-items-center group"> Server 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="server-configuration" aria-haspopup="dialog" aria-label="Share link: Server Configuration"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash">geode serve [OPTIONS] Options: --listen <ADDR> Listen address [default: 127.0.0.1:3141] --data-dir <PATH> Data directory [default: ./data] --wal-dir <PATH> WAL directory [default: <data-dir>/wal] --log-level <LEVEL> Log level: error|warn|info|debug|trace --max-connections <N> Maximum concurrent connections [default: 1000] --query-timeout <DURATION> Default query timeout [default: 30s] --tls-cert <PATH> TLS certificate file --tls-key <PATH> TLS private key file --index-cache-size <SIZE> Index cache size [default: 1GB] --data-cache-size <SIZE> Data cache size [default: 4GB] --checkpoint-interval <DUR> Checkpoint interval [default: 5m] --metrics-port <PORT> Prometheus metrics port [default: 9090] --enable-audit-log Enable audit logging --audit-log-path <PATH> Audit log file path </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-bash" data-lang="bash">GEODE_DATA_DIR=/var/lib/geode GEODE_LOG_LEVEL=info GEODE_MAX_CONNECTIONS=2000 GEODE_TLS_CERT=/etc/geode/tls/cert.pem GEODE_TLS_KEY=/etc/geode/tls/key.pem GEODE_INDEX_CACHE_SIZE=2GB GEODE_DATA_CACHE_SIZE=8GB </code></pre></div> <h4 id="configuration-file" class="position-relative d-flex align-items-center group"> Configuration 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="configuration-file" aria-haspopup="dialog" aria-label="Share link: Configuration File"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-yaml" data-lang="yaml"># geode.yaml server: listen: "0.0.0.0:3141" max_connections: 1000 query_timeout: 30s storage: data_dir: "/var/lib/geode" wal_dir: "/var/lib/geode/wal" cache: index_cache_size: "2GB" data_cache_size: "8GB" query_plan_cache_size: "256MB" security: tls: enabled: true cert: "/etc/geode/tls/cert.pem" key: "/etc/geode/tls/key.pem" audit_log: enabled: true path: "/var/log/geode/audit.log" performance: checkpoint_interval: "5m" max_wal_size: "1GB" worker_threads: 0 # 0 = number of CPUs metrics: enabled: true port: 9090 path: "/metrics" </code></pre></div> <h3 id="system-tables-and-metadata" class="position-relative d-flex align-items-center group"> System Tables and Metadata <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="system-tables-and-metadata" aria-haspopup="dialog" aria-label="Share link: System Tables and Metadata"> Share link </button> </h3> <h4 id="system-catalog" class="position-relative d-flex align-items-center group"> System Catalog <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="system-catalog" aria-haspopup="dialog" aria-label="Share link: System Catalog"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">-- View all indexes SELECT * FROM system.indexes; -- View index statistics SELECT * FROM system.index_statistics; -- View query log SELECT * FROM system.query_log ORDER BY execution_time_ms DESC LIMIT 20; -- View cache statistics SELECT * FROM system.cache_statistics; -- View active sessions SELECT * FROM system.sessions; -- View transaction status SELECT * FROM system.transactions; </code></pre></div> <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>Geode uses ISO-standard GQL error codes: <ul> <li><code>00000</code> - Success</li> <li><code>22000</code> - Data exception</li> <li><code>23000</code> - Integrity constraint violation</li> <li><code>42000</code> - Syntax error or access violation</li> <li><code>40000</code> - Transaction rollback</li> <li><code>40001</code> - Serialization failure</li> <li><code>42P01</code> - Undefined table/label</li> <li><code>42703</code> - Undefined property</li> </ul> <h3 id="best-practices-for-api-usage" class="position-relative d-flex align-items-center group"> Best Practices for API Usage <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-for-api-usage" aria-haspopup="dialog" aria-label="Share link: Best Practices for API Usage"> Share link </button> </h3><ol> <li>Use prepared statements: For queries executed repeatedly with different parameters</li> <li>Enable connection pooling: Reuse connections for better performance</li> <li>Handle errors appropriately: Implement retry logic for transient failures</li> <li>Use async APIs: Take advantage of concurrent query execution</li> <li>Close resources: Always close connections and transactions</li> <li>Monitor performance: Track query execution times and cache hit rates</li> <li>Leverage type safety: Use strongly-typed client library features</li> <li>Document parameter types: Ensure parameter values match expected GQL types</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><a href="/tags/gql-syntax/" >GQL Syntax</a> - Query language syntax details</li> <li><a href="/docs/client-libraries/" >Client Libraries</a> - Language-specific SDKs</li> <li><a href="/docs/configuration/" >Configuration</a> - Server setup and tuning</li> <li><a href="/docs/data-types/" >Data Types</a> - Type system details</li> <li><a href="/tags/functions/" >Functions</a> - Built-in function reference</li> <li><a href="/tags/api-reference/" >API Documentation</a> - Additional API details</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/iso-gql/" >ISO GQL Specification</a> - Official standard</li> <li><a href="/tags/protocol/" >Protocol Specification</a> - Wire protocol details</li> <li><a href="/docs/reference/types/" >Type System</a> - Complete type documentation</li> <li><a href="/guides/error-handling/" >Error Handling</a> - Error management patterns</li> <li><a href="/docs/performance/" >Performance Tuning</a> - Optimization techniques</li> </ul>

Popular

Related Articles

Pattern Matching in GQL

Complete GQL API Reference

API Reference and CLI Manual

DSN (Data Source Name) Specification

Aggregation Functions

GQL Operators Reference

Index Types Reference

Data Model

GQL Quick Reference

Data Types Reference

Statistics and Metrics Reference

EXPLAIN Command