API Reference | Geode Database

<h2 id="api-reference" class="position-relative d-flex align-items-center group"> API Reference <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="api-reference" aria-haspopup="dialog" aria-label="Share link: API Reference"> Share link </button> </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>Complete reference documentation for Geode’s query language, functions, operators, and system procedures. <h3 id="index-operations" class="position-relative d-flex align-items-center group"> Index 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="index-operations" aria-haspopup="dialog" aria-label="Share link: Index Operations"> Share link </button> </h3> <h4 id="create-index" class="position-relative d-flex align-items-center group"> CREATE INDEX <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="create-index" aria-haspopup="dialog" aria-label="Share link: CREATE INDEX"> Share link </button> </h4>Creates an index on node properties for improved query performance. Syntax: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">CREATE [UNIQUE] INDEX [IF NOT EXISTS] index_name ON label(property[, ...]) [USING {btree | hash | fulltext | spatial | vector}] </code></pre></div>Index Types: <ul> <li>btree (Default) - B-tree index for range queries and sorted access</li> <li>hash - Hash index for exact match lookups</li> <li>fulltext - Full-text search with tokenization and ranking</li> <li>spatial - R-tree index for geographic and spatial data</li> <li>vector - HNSW index for vector similarity search</li> <li>patricia_trie - IP prefix matching and CIDR queries</li> </ul> Examples: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">-- B-tree index for range queries CREATE INDEX person_age_idx ON Person(age) USING btree; -- Hash index for exact matches CREATE INDEX person_email_idx ON Person(email) USING hash; -- Full-text search index CREATE INDEX article_content_idx ON Article(content) USING fulltext; -- Spatial index for geographic queries CREATE INDEX location_coords_idx ON Location(coordinates) USING spatial; -- Vector index for similarity search CREATE INDEX embedding_idx ON Document(embedding) USING vector; -- Unique constraint CREATE UNIQUE INDEX person_email_unique ON Person(email); </code></pre></div> <h4 id="drop-index" class="position-relative d-flex align-items-center group"> DROP INDEX <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="drop-index" aria-haspopup="dialog" aria-label="Share link: DROP INDEX"> Share link </button> </h4>Removes an existing index. Syntax: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">DROP INDEX [IF EXISTS] index_name </code></pre></div>Example: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">DROP INDEX IF EXISTS person_age_idx; </code></pre></div> <h4 id="show-indexes" class="position-relative d-flex align-items-center group"> SHOW INDEXES <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="show-indexes" aria-haspopup="dialog" aria-label="Share link: SHOW INDEXES"> Share link </button> </h4>Lists all indexes in the database. Syntax: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">SHOW INDEXES; </code></pre></div>Returns: <ul> <li>Index name</li> <li>Label</li> <li>Properties</li> <li>Type (btree, hash, fulltext, spatial, vector)</li> <li>Unique constraint</li> <li>Statistics (entries, size, last updated)</li> </ul> <h3 id="variable-length-path-patterns" class="position-relative d-flex align-items-center group"> Variable-Length Path 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="variable-length-path-patterns" aria-haspopup="dialog" aria-label="Share link: Variable-Length Path Patterns"> Share link </button> </h3> <h4 id="path-pattern-syntax" class="position-relative d-flex align-items-center group"> Path 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="path-pattern-syntax" aria-haspopup="dialog" aria-label="Share link: Path Pattern Syntax"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">(start)-[relationship*min..max]->(end) </code></pre></div> <h4 id="patterns" class="position-relative d-flex align-items-center group"> 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="patterns" aria-haspopup="dialog" aria-label="Share link: Patterns"> Share link </button> </h4>Any Length (<code>*</code>): <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">MATCH (a:Person)-[*]->(b:Company) RETURN b; </code></pre></div>Exact Length (<code>*n</code>): <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">MATCH (a:Person)-[*2]->(b:Person) RETURN b; </code></pre></div>Range (<code>*min..max</code>): <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">MATCH (a:Person)-[*1..3]->(b:Person) RETURN b; </code></pre></div>Up To (<code>*..max</code>): <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">MATCH (a:Person)-[*..5]->(b:Person) RETURN b; </code></pre></div>At Least (<code>*min..</code>): <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">MATCH (a:Person)-[*2..]->(b:Person) RETURN b; </code></pre></div> <h4 id="path-functions" class="position-relative d-flex align-items-center group"> Path 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="path-functions" aria-haspopup="dialog" aria-label="Share link: Path Functions"> Share link </button> </h4>length(path) - Returns path length: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">MATCH path = (a)-[*]->(b) RETURN length(path); </code></pre></div>nodes(path) - Returns all nodes in path: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">MATCH path = (a)-[*]->(b) RETURN nodes(path); </code></pre></div>relationships(path) - Returns all relationships in path: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">MATCH path = (a)-[*]->(b) RETURN relationships(path); </code></pre></div>shortestPath() - Finds shortest path: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">MATCH path = shortestPath((a:Person)-[*]->(b:Company)) RETURN path; </code></pre></div>allShortestPaths() - Finds all shortest paths: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">MATCH path = allShortestPaths((a:Person)-[*]->(b:Company)) RETURN path; </code></pre></div> <h3 id="vector-operations" class="position-relative d-flex align-items-center group"> Vector 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="vector-operations" aria-haspopup="dialog" aria-label="Share link: Vector Operations"> Share link </button> </h3> <h4 id="vector-search-functions" class="position-relative d-flex align-items-center group"> Vector Search 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="vector-search-functions" aria-haspopup="dialog" aria-label="Share link: Vector Search Functions"> Share link </button> </h4>similarity(vector1, vector2) - Calculates similarity (0-1, higher is more similar): <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">MATCH (d:Document) WHERE similarity(d.embedding, VectorF32('[0.1, 0.2, 0.3]')) > 0.8 RETURN d; </code></pre></div>distance(vector1, vector2, metric) - Calculates distance using specified metric: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">MATCH (d:Document) WHERE distance(d.embedding, VectorF32('[0.1, 0.2, 0.3]'), 'l2') < 0.5 RETURN d; </code></pre></div>Supported Metrics: <ul> <li><code>'l2'</code> - Euclidean distance</li> <li><code>'cosine'</code> - Cosine distance (1 - cosine similarity)</li> <li><code>'dot'</code> - Negative dot product</li> <li><code>'manhattan'</code> - L1 distance</li> <li><code>'hamming'</code> - Hamming distance (integer vectors)</li> <li><code>'jaccard'</code> - Jaccard distance (set similarity)</li> </ul> knn(property, query_vector, k) - Returns k nearest neighbors: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">MATCH (d:Document) WITH d, knn(d.embedding, VectorF32('[0.1, 0.2, 0.3]'), 10) AS neighbors RETURN neighbors; </code></pre></div>cosineSimilarity(v1, v2) - Cosine similarity [-1, 1]: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">MATCH (d:Document) RETURN d.title, cosineSimilarity(d.embedding, VectorF32('[0.1, 0.2, 0.3]')) AS similarity ORDER BY similarity DESC; </code></pre></div>dotProduct(v1, v2) - Dot product: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">RETURN dotProduct(VectorF32('[1, 2, 3]'), VectorF32('[4, 5, 6]')) AS dot; </code></pre></div>norm(vector) - L2 norm (magnitude): <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">RETURN norm(VectorF32('[3, 4]')) AS magnitude; -- Returns 5.0 </code></pre></div>normalize(vector) - Unit vector normalization: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">MATCH (d:Document) SET d.embedding = normalize(d.embedding); </code></pre></div> <h3 id="spatial-operations" class="position-relative d-flex align-items-center group"> Spatial 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="spatial-operations" aria-haspopup="dialog" aria-label="Share link: Spatial Operations"> Share link </button> </h3> <h4 id="spatial-functions" class="position-relative d-flex align-items-center group"> Spatial 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="spatial-functions" aria-haspopup="dialog" aria-label="Share link: Spatial Functions"> Share link </button> </h4>LatLon(string) - Creates geographic coordinate: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">CREATE (l:Location {coords: LatLon('40.7128,-74.0060'), name: 'NYC'}); </code></pre></div>distanceKm(point1, point2) - Haversine distance in kilometers: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">MATCH (l:Location) WHERE distanceKm(l.coords, LatLon('40.0,-74.0')) < 100 RETURN l; </code></pre></div>bearingTo(point1, point2) - Initial bearing in degrees [0, 360): <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">MATCH (a:Location), (b:Location) RETURN bearingTo(a.coords, b.coords) AS bearing; </code></pre></div>within(geometry, boundary) - Tests if geometry is within boundary: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">MATCH (l:Location) WHERE within(l.coords, polygon(...)) RETURN l; </code></pre></div>bbox(min_x, min_y, max_x, max_y) - Creates bounding box: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">MATCH (l:Location) WHERE intersects(l.area, bbox(40.0, -75.0, 41.0, -73.0)) RETURN l; </code></pre></div> <h3 id="full-text-search" class="position-relative d-flex align-items-center group"> Full-Text Search <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="full-text-search" aria-haspopup="dialog" aria-label="Share link: Full-Text Search"> Share link </button> </h3> <h4 id="text-search-functions" class="position-relative d-flex align-items-center group"> Text Search 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="text-search-functions" aria-haspopup="dialog" aria-label="Share link: Text Search Functions"> Share link </button> </h4>CONTAINS - Searches for text within property: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">MATCH (a:Article) WHERE a.content CONTAINS 'graph database' RETURN a; </code></pre></div>STARTS WITH - Matches text at beginning: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">MATCH (p:Person) WHERE p.name STARTS WITH 'John' RETURN p; </code></pre></div>ENDS WITH - Matches text at end: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">MATCH (e:Email) WHERE e.address ENDS WITH '@example.com' RETURN e; </code></pre></div>REGEX - Matches using regular expressions: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">MATCH (p:Product) WHERE p.code =~ '^SKU-[0-9]{4}$' RETURN p; </code></pre></div>score() - Returns relevance score for full-text results: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">MATCH (a:Article) WHERE a.content CONTAINS 'machine learning' RETURN a, score() AS relevance ORDER BY relevance DESC; </code></pre></div> <h3 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> </h3> <h4 id="basic-aggregations" class="position-relative d-flex align-items-center group"> Basic Aggregations <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="basic-aggregations" aria-haspopup="dialog" aria-label="Share link: Basic Aggregations"> Share link </button> </h4>count() - Count rows: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">MATCH (n:Person) RETURN count(*) AS total; MATCH (n:Person) RETURN count(n.email) AS with_email; </code></pre></div>sum() - Sum values: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">MATCH (o:Order) RETURN sum(o.total) AS revenue; </code></pre></div>avg() - Average value: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">MATCH (p:Person) RETURN avg(p.age) AS average_age; </code></pre></div>min() - Minimum value: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">MATCH (p:Product) RETURN min(p.price) AS cheapest; </code></pre></div>max() - Maximum value: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">MATCH (p:Product) RETURN max(p.price) AS most_expensive; </code></pre></div> <h4 id="collection-functions" class="position-relative d-flex align-items-center group"> Collection 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="collection-functions" aria-haspopup="dialog" aria-label="Share link: Collection Functions"> Share link </button> </h4>collect() - Collect values into array: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">MATCH (p:Person)-[:KNOWS]->(f) RETURN p.name, collect(f.name) AS friends; </code></pre></div>collect(DISTINCT) - Collect unique values: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">MATCH (p:Person) RETURN p.city, collect(DISTINCT p.country) AS countries; </code></pre></div> <h3 id="transaction-control" class="position-relative d-flex align-items-center group"> Transaction Control <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-control" aria-haspopup="dialog" aria-label="Share link: Transaction Control"> Share link </button> </h3> <h4 id="begin" class="position-relative d-flex align-items-center group"> BEGIN <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="begin" aria-haspopup="dialog" aria-label="Share link: BEGIN"> Share link </button> </h4>Starts a new transaction: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">BEGIN; </code></pre></div> <h4 id="commit" class="position-relative d-flex align-items-center group"> COMMIT <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="commit" aria-haspopup="dialog" aria-label="Share link: COMMIT"> Share link </button> </h4>Commits the current transaction: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">COMMIT; </code></pre></div> <h4 id="rollback" class="position-relative d-flex align-items-center group"> ROLLBACK <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="rollback" aria-haspopup="dialog" aria-label="Share link: ROLLBACK"> Share link </button> </h4>Rolls back the current transaction: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">ROLLBACK; </code></pre></div> <h4 id="savepoint" class="position-relative d-flex align-items-center group"> SAVEPOINT <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="savepoint" aria-haspopup="dialog" aria-label="Share link: SAVEPOINT"> Share link </button> </h4>Creates a savepoint within a transaction: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">SAVEPOINT my_savepoint; </code></pre></div> <h4 id="rollback-to" class="position-relative d-flex align-items-center group"> ROLLBACK TO <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="rollback-to" aria-haspopup="dialog" aria-label="Share link: ROLLBACK TO"> Share link </button> </h4>Rolls back to a specific savepoint: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">ROLLBACK TO my_savepoint; </code></pre></div> <h3 id="system-functions" class="position-relative d-flex align-items-center group"> System 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="system-functions" aria-haspopup="dialog" aria-label="Share link: System Functions"> Share link </button> </h3> <h4 id="database-information" class="position-relative d-flex align-items-center group"> Database 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="database-information" aria-haspopup="dialog" aria-label="Share link: Database Information"> Share link </button> </h4>db.info() - Returns database information: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">RETURN db.info(); </code></pre></div>db.stats() - Returns database statistics: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">RETURN db.stats(); </code></pre></div>db.indexes() - Returns index information: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">RETURN db.indexes(); </code></pre></div>db.constraints() - Returns constraint information: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">RETURN db.constraints(); </code></pre></div> <h4 id="temporal-functions" class="position-relative d-flex align-items-center group"> Temporal 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="temporal-functions" aria-haspopup="dialog" aria-label="Share link: Temporal Functions"> Share link </button> </h4>now() - Current timestamp with microseconds: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">RETURN now() AS current_time; </code></pre></div>current_date - Today’s date: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">RETURN current_date AS today; </code></pre></div>current_time - Current time: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">RETURN current_time AS now; </code></pre></div>date_add(date, interval) - Add interval to date: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">RETURN date_add(Date('2024-01-01'), Interval('P1M')) AS next_month; </code></pre></div>date_sub(date, interval) - Subtract interval: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">RETURN date_sub(now(), Interval('P7D')) AS week_ago; </code></pre></div>date_part(part, datetime) - Extract date/time part: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">RETURN date_part('year', now()) AS current_year; </code></pre></div> <h4 id="type-conversion-functions" class="position-relative d-flex align-items-center group"> Type Conversion 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="type-conversion-functions" aria-haspopup="dialog" aria-label="Share link: Type Conversion Functions"> Share link </button> </h4>to_int(value) - Convert to integer: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">RETURN to_int('42') AS num; </code></pre></div>to_float(value) - Convert to float: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">RETURN to_float('3.14') AS pi; </code></pre></div>to_string(value) - Convert to string: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">RETURN to_string(42) AS str; </code></pre></div>to_boolean(value) - Convert to boolean: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">RETURN to_boolean('true') AS bool; </code></pre></div> <h3 id="type-constructors" class="position-relative d-flex align-items-center group"> Type Constructors <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-constructors" aria-haspopup="dialog" aria-label="Share link: Type Constructors"> Share link </button> </h3> <h4 id="numeric-types" class="position-relative d-flex align-items-center group"> Numeric 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="numeric-types" aria-haspopup="dialog" aria-label="Share link: Numeric Types"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">SmallInt(42) -- i16 Int(1000) -- i32 BigInt(9999999) -- i64 Real(3.14) -- f32 Double(3.14159) -- f64 Decimal(123.45, 2) -- Decimal with scale </code></pre></div> <h4 id="string-types" class="position-relative d-flex align-items-center group"> String 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="string-types" aria-haspopup="dialog" aria-label="Share link: String Types"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">Char('Hello', 10) -- Fixed length Varchar('World', 50) -- Variable length Text('Long text...') -- Unlimited </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-gql" data-lang="gql">Date('2024-12-25') Time('14:30:00.123456') TimeTZ('14:30:00', -28800) Timestamp('2024-12-25 14:30:00') TimestampTZ('2024-12-25 14:30:00 -08:00') Interval('P1Y2M3DT4H5M6S') </code></pre></div> <h4 id="network-types" class="position-relative d-flex align-items-center group"> Network 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="network-types" aria-haspopup="dialog" aria-label="Share link: Network Types"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">IpAddr('192.168.1.1') IpAddr('2001:db8::1') Subnet('192.168.0.0/24') Mac('00:11:22:33:44:55') </code></pre></div> <h4 id="geographic-types" class="position-relative d-flex align-items-center group"> Geographic 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="geographic-types" aria-haspopup="dialog" aria-label="Share link: Geographic Types"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">LatLon('40.7128,-74.0060') LatLonAlt('40.7128,-74.0060,100.0') GeoPoint('37.7749,-122.4194') </code></pre></div> <h4 id="vector-types" class="position-relative d-flex align-items-center group"> Vector 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="vector-types" aria-haspopup="dialog" aria-label="Share link: Vector Types"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">VectorF32('[1.0, 2.0, 3.0]') VectorI32('[1, 2, 3]') </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-gql" data-lang="gql">UUID('550e8400-e29b-41d4-a716-446655440000') Json('{"key": "value"}') Jsonb('{"key": "value"}') Xml('<root><child/></root>') Bytea('\\xDEADBEEF') URL('https://example.com') </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 follows ISO/IEC SQL error code standards: <table> <thead> <tr> <th>Code</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td><code>00000</code></td> <td>Success</td> </tr> <tr> <td><code>0A000</code></td> <td>Feature not supported</td> </tr> <tr> <td><code>22000</code></td> <td>Data exception</td> </tr> <tr> <td><code>23000</code></td> <td>Integrity constraint violation</td> </tr> <tr> <td><code>42000</code></td> <td>Syntax error or access rule violation</td> </tr> <tr> <td><code>42P01</code></td> <td>Undefined table</td> </tr> <tr> <td><code>42P07</code></td> <td>Duplicate table/index</td> </tr> <tr> <td><code>53000</code></td> <td>Insufficient resources</td> </tr> <tr> <td><code>58000</code></td> <td>System error</td> </tr> <tr> <td><code>XX000</code></td> <td>Internal error</td> </tr> </tbody> </table> <h3 id="performance-tips" class="position-relative d-flex align-items-center group"> Performance Tips <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-tips" aria-haspopup="dialog" aria-label="Share link: Performance Tips"> Share link </button> </h3> <h4 id="index-usage" class="position-relative d-flex align-items-center group"> Index 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="index-usage" aria-haspopup="dialog" aria-label="Share link: Index Usage"> Share link </button> </h4><ol> <li>Create indexes on frequently queried properties</li> <li>Use unique indexes for high cardinality properties</li> <li>Use hash indexes for exact match queries only</li> <li>Use btree indexes for range queries and sorting</li> <li>Use vector indexes for similarity search</li> <li>Use spatial indexes for geographic queries</li> </ol> <h4 id="query-optimization" class="position-relative d-flex align-items-center group"> Query Optimization <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-optimization" aria-haspopup="dialog" aria-label="Share link: Query Optimization"> Share link </button> </h4><ol> <li>Use EXPLAIN to understand query plans</li> <li>Limit result sets with LIMIT clause</li> <li>Filter early with WHERE clauses</li> <li>Use index hints when necessary</li> <li>Avoid cartesian products without filters</li> <li>Always use ORDER BY with LIMIT for deterministic results</li> </ol> <h3 id="next-steps" class="position-relative d-flex align-items-center group"> Next Steps <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="next-steps" aria-haspopup="dialog" aria-label="Share link: Next Steps"> Share link </button> </h3><ul> <li><a href="../gql-reference/" >GQL Reference</a> - Query language syntax</li> <li><a href="../data-types/" >Data Types</a> - Complete type system reference</li> <li><a href="../performance/" >Performance Tuning</a> - Optimize queries</li> </ul>