GQL Syntax Guide

Complete syntax guide for GQL (Graph Query Language) as implemented in Geode. This guide provides detailed grammar, syntax rules, and examples for writing correct GQL queries. <h3 id="lexical-structure" class="position-relative d-flex align-items-center group"> Lexical Structure <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="lexical-structure" aria-haspopup="dialog" aria-label="Share link: Lexical Structure"> 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="identifiers" class="position-relative d-flex align-items-center group"> Identifiers <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="identifiers" aria-haspopup="dialog" aria-label="Share link: Identifiers"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">// Simple identifiers (alphanumeric, underscore) user, user_name, userName, user123 // Quoted identifiers (any characters) `user-name`, `user.name`, `my identifier with spaces` // Case sensitivity User ≠ user ≠ USER // Identifiers are case-sensitive </code></pre></div> <h4 id="keywords" class="position-relative d-flex align-items-center group"> Keywords <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="keywords" aria-haspopup="dialog" aria-label="Share link: Keywords"> Share link </button> </h4>Reserved words (case-insensitive): <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-fallback" data-lang="fallback">MATCH, CREATE, DELETE, SET, REMOVE, MERGE, RETURN, WHERE, WITH, ORDER, BY, LIMIT, OFFSET, SKIP, ASC, DESC, AS, DISTINCT, UNION, OPTIONAL, CASE, WHEN, THEN, ELSE, END, AND, OR, NOT, XOR, IN, STARTS, WITH, ENDS, CONTAINS, IS, NULL, EXISTS, ALL, ANY, NONE, SINGLE, TRUE, FALSE, COUNT, SUM, AVG, MIN, MAX, COLLECT, BEGIN, COMMIT, ROLLBACK, TRANSACTION, SAVEPOINT, INDEX, CONSTRAINT, UNIQUE, ON, ASSERT, DROP, SHOW, EXPLAIN, PROFILE </code></pre></div> <h4 id="literals" class="position-relative d-flex align-items-center group"> Literals <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="literals" aria-haspopup="dialog" aria-label="Share link: Literals"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">// Integer 42, -17, 0, 9223372036854775807 // Float 3.14, -0.5, 1.23e10, 6.022e23 // String (single or double quotes) 'hello', "world", 'it\'s', "say \"hi\"" // Boolean true, false, TRUE, FALSE // Null null, NULL // List [], [1, 2, 3], ['a', 'b', 'c'], [1, 'mixed', true] // Map {}, {key: 'value'}, {name: 'Alice', age: 30} </code></pre></div> <h4 id="comments" class="position-relative d-flex align-items-center group"> Comments <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="comments" aria-haspopup="dialog" aria-label="Share link: Comments"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">// Single-line comment /* Multi-line comment */ /* Nested /* comments */ are not supported */ </code></pre></div> <h3 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> </h3> <h4 id="node-patterns" class="position-relative d-flex align-items-center group"> Node 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="node-patterns" aria-haspopup="dialog" aria-label="Share link: Node Patterns"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">// Grammar (variable? labels? properties? where_clause?) // Examples () // Anonymous (n) // Named variable (n:User) // With label (n:User:Admin) // Multiple labels (n {age: 30}) // With properties (n:User {age: 30}) // Label and properties (n WHERE n.age > 25) // With WHERE clause (n:User {city: 'NYC'} WHERE n.age > 25) // Complete pattern </code></pre></div> <h4 id="relationship-patterns" class="position-relative d-flex align-items-center group"> Relationship 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="relationship-patterns" aria-haspopup="dialog" aria-label="Share link: Relationship Patterns"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">// Grammar -[variable? types? properties? where_clause?]-> // Directed right <-[variable? types? properties? where_clause?]- // Directed left -[variable? types? properties? where_clause?]- // Undirected // Examples --> // Anonymous directed -[r]-> // Named -[r:KNOWS]-> // With type -[r:KNOWS|FOLLOWS]-> // Multiple types -[r {since: 2020}]-> // With properties -[r:KNOWS {since: 2020}]-> // Type and properties -[r WHERE r.strength > 0.5]-> // With WHERE clause // Variable-length -[*]-> // Any length -[*1..3]-> // 1 to 3 hops -[*..5]-> // Up to 5 hops -[*3..]-> // 3 or more hops -[:KNOWS*2..4]-> // With type and bounds </code></pre></div> <h4 id="path-patterns" class="position-relative d-flex align-items-center group"> 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="path-patterns" aria-haspopup="dialog" aria-label="Share link: Path Patterns"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">// Grammar variable = (pattern_element)+ // Examples path = (a)-[:KNOWS]->(b) path = (a)-[:KNOWS*]->(b)-[:LIVES_IN]->(c) path = (a)-[:KNOWS*1..3]-(b) // Shortest path path = SHORTEST (a)-[:KNOWS*]-(b) paths = ALL SHORTEST (a)-[:KNOWS*]-(b) </code></pre></div> <h3 id="query-clauses" class="position-relative d-flex align-items-center group"> Query Clauses <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-clauses" aria-haspopup="dialog" aria-label="Share link: Query Clauses"> Share link </button> </h3> <h4 id="match" class="position-relative d-flex align-items-center group"> MATCH <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="match" aria-haspopup="dialog" aria-label="Share link: MATCH"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">// Syntax MATCH pattern [WHERE condition] // Examples MATCH (n:User) MATCH (a:User)-[r:KNOWS]->(b:User) MATCH (a)-[:KNOWS*1..3]-(b) MATCH (n) WHERE n.age > 25 </code></pre></div> <h4 id="optional-match" class="position-relative d-flex align-items-center group"> OPTIONAL MATCH <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="optional-match" aria-haspopup="dialog" aria-label="Share link: OPTIONAL MATCH"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">// Syntax OPTIONAL MATCH pattern [WHERE condition] // Example MATCH (u:User) OPTIONAL MATCH (u)-[:HAS_PROFILE]->(p:Profile) RETURN u.name, p.bio // p.bio is null if no profile </code></pre></div> <h4 id="where" class="position-relative d-flex align-items-center group"> WHERE <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="where" aria-haspopup="dialog" aria-label="Share link: WHERE"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">// Syntax WHERE condition // Examples WHERE n.age > 25 WHERE n.age >= 18 AND n.age <= 65 WHERE n.email IS NOT NULL WHERE n.role IN ['admin', 'moderator'] WHERE n.name STARTS WITH 'A' WHERE n.email =~ '.*@example\\.com$' WHERE EXISTS { (n)-[:FRIEND]->(:User) } </code></pre></div> <h4 id="return" class="position-relative d-flex align-items-center group"> RETURN <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="return" aria-haspopup="dialog" aria-label="Share link: RETURN"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">// Syntax RETURN [DISTINCT] expression [AS alias] [, ...] // Examples RETURN n RETURN n.name, n.age RETURN n.name AS name, n.age AS age RETURN DISTINCT n.role RETURN COUNT(*) AS total RETURN n, COLLECT(m) AS friends </code></pre></div> <h4 id="with" class="position-relative d-flex align-items-center group"> WITH <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="with" aria-haspopup="dialog" aria-label="Share link: WITH"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">// Syntax WITH [DISTINCT] expression [AS alias] [, ...] [ORDER BY expression [ASC|DESC] [, ...]] [LIMIT number] // Examples MATCH (u:User)-[:FRIEND]->(f) WITH u, COUNT(f) AS friend_count WHERE friend_count > 10 RETURN u.name, friend_count // Chaining MATCH (u:User) WITH u, SIZE((u)-[:FRIEND]->()) AS friends WHERE friends > 5 WITH u, friends, u.age / 10 AS age_group RETURN age_group, AVG(friends) AS avg_friends </code></pre></div> <h4 id="order-by" class="position-relative d-flex align-items-center group"> ORDER BY <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="order-by" aria-haspopup="dialog" aria-label="Share link: ORDER BY"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">// Syntax ORDER BY expression [ASC|DESC] [NULLS FIRST|LAST] [, ...] // Examples ORDER BY n.age ORDER BY n.age DESC ORDER BY n.last_name ASC, n.first_name ASC ORDER BY n.created_at DESC NULLS LAST </code></pre></div> <h4 id="limit-and-offset" class="position-relative d-flex align-items-center group"> LIMIT and OFFSET <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="limit-and-offset" aria-haspopup="dialog" aria-label="Share link: LIMIT and OFFSET"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">// Syntax LIMIT number OFFSET number // or SKIP number // Examples LIMIT 10 LIMIT 20 OFFSET 40 // Pagination: page 3 (20 per page) LIMIT $pageSize OFFSET $offset // Parameterized </code></pre></div> <h4 id="union" class="position-relative d-flex align-items-center group"> UNION <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="union" aria-haspopup="dialog" aria-label="Share link: UNION"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">// Syntax query UNION [ALL] query // Examples MATCH (u:User) RETURN u.email UNION MATCH (a:Admin) RETURN a.email // UNION ALL (keeps duplicates) MATCH (u:User) RETURN u.email UNION ALL MATCH (a:Admin) RETURN a.email </code></pre></div> <h3 id="data-modification-clauses" class="position-relative d-flex align-items-center group"> Data Modification Clauses <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="data-modification-clauses" aria-haspopup="dialog" aria-label="Share link: Data Modification Clauses"> Share link </button> </h3> <h4 id="create" class="position-relative d-flex align-items-center group"> CREATE <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" aria-haspopup="dialog" aria-label="Share link: CREATE"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">// Syntax CREATE pattern // Examples CREATE (n:User {name: 'Alice', age: 30}) CREATE (a:User)-[r:KNOWS {since: 2024}]->(b:User) CREATE (a)-[:FRIEND]->(b), (a)-[:COLLEAGUE]->(c) </code></pre></div> <h4 id="delete" class="position-relative d-flex align-items-center group"> DELETE <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="delete" aria-haspopup="dialog" aria-label="Share link: DELETE"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">// Syntax DELETE expression [, ...] DETACH DELETE expression [, ...] // Examples DELETE r // Delete relationship DELETE n // Delete node (if no relationships) DETACH DELETE n // Delete node and all relationships </code></pre></div> <h4 id="set" class="position-relative d-flex align-items-center group"> SET <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="set" aria-haspopup="dialog" aria-label="Share link: SET"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">// Syntax SET variable.property = expression SET variable = map SET variable += map SET variable:Label // Examples SET n.name = 'New Name' SET n.age = n.age + 1 SET n = {name: 'Alice', age: 30} // Replace all properties SET n += {city: 'NYC', verified: true} // Add/update properties SET n:Admin // Add label SET n:Admin:Verified // Add multiple labels </code></pre></div> <h4 id="remove" class="position-relative d-flex align-items-center group"> REMOVE <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="remove" aria-haspopup="dialog" aria-label="Share link: REMOVE"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">// Syntax REMOVE variable.property REMOVE variable:Label // Examples REMOVE n.temporary_field REMOVE n:Deprecated </code></pre></div> <h4 id="merge" class="position-relative d-flex align-items-center group"> MERGE <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="merge" aria-haspopup="dialog" aria-label="Share link: MERGE"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">// Syntax MERGE pattern [ON CREATE SET property = value] [ON MATCH SET property = value] // Examples MERGE (u:User {email: 'alice@example.com'}) ON CREATE SET u.created_at = NOW() ON MATCH SET u.last_seen = NOW() RETURN u </code></pre></div> <h3 id="expressions" class="position-relative d-flex align-items-center group"> Expressions <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="expressions" aria-haspopup="dialog" aria-label="Share link: Expressions"> Share link </button> </h3> <h4 id="comparison" class="position-relative d-flex align-items-center group"> Comparison <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="comparison" aria-haspopup="dialog" aria-label="Share link: Comparison"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">n.age = 30 n.age <> 30 // or != n.age < 30 n.age > 30 n.age <= 30 n.age >= 30 n.email IS NULL n.email IS NOT NULL n.role IN ['admin', 'moderator'] n.age BETWEEN 18 AND 65 </code></pre></div> <h4 id="logical" class="position-relative d-flex align-items-center group"> Logical <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="logical" aria-haspopup="dialog" aria-label="Share link: Logical"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">condition1 AND condition2 condition1 OR condition2 NOT condition condition1 XOR condition2 </code></pre></div> <h4 id="string" class="position-relative d-flex align-items-center group"> String <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" aria-haspopup="dialog" aria-label="Share link: String"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">n.name STARTS WITH 'A' n.name ENDS WITH 'son' n.name CONTAINS 'alice' n.email =~ '^[a-z]+@example\\.com$' // Regex </code></pre></div> <h4 id="arithmetic" class="position-relative d-flex align-items-center group"> Arithmetic <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="arithmetic" aria-haspopup="dialog" aria-label="Share link: Arithmetic"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">n.age + 10 n.price * 1.08 // Add 8% tax n.balance - 100 n.total / n.count n.value % 10 // Modulo 2 ^ 10 // Power </code></pre></div> <h4 id="list" class="position-relative d-flex align-items-center group"> List <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="list" aria-haspopup="dialog" aria-label="Share link: List"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">[1, 2, 3] list[0] // First element list[-1] // Last element list[1..3] // Slice list + [4, 5] // Concatenation x IN list // Membership SIZE(list) </code></pre></div> <h4 id="map" class="position-relative d-flex align-items-center group"> Map <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="map" aria-haspopup="dialog" aria-label="Share link: Map"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">{key: 'value', number: 42} map.key map['key'] KEYS(map) VALUES(map) </code></pre></div> <h4 id="case" class="position-relative d-flex align-items-center group"> CASE <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="case" aria-haspopup="dialog" aria-label="Share link: CASE"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">CASE WHEN condition1 THEN result1 WHEN condition2 THEN result2 ELSE default_result END // Simple CASE CASE expression WHEN value1 THEN result1 WHEN value2 THEN result2 ELSE default_result END </code></pre></div> <h3 id="function-call-syntax" class="position-relative d-flex align-items-center group"> Function Call 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="function-call-syntax" aria-haspopup="dialog" aria-label="Share link: Function Call Syntax"> Share link </button> </h3><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">// Function call function_name(argument1, argument2, ...) // Examples COUNT(*) SUM(n.amount) UPPER(n.name) SUBSTRING(n.email, 0, POSITION('@', n.email)) COALESCE(n.nickname, n.username, 'Anonymous') </code></pre></div> <h3 id="subquery-syntax" class="position-relative d-flex align-items-center group"> Subquery 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="subquery-syntax" aria-haspopup="dialog" aria-label="Share link: Subquery Syntax"> Share link </button> </h3><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">// EXISTS WHERE EXISTS { pattern [WHERE condition] } // COUNT COUNT { pattern [WHERE condition] } // Example MATCH (u:User) WHERE EXISTS { MATCH (u)-[:PURCHASED]->(p:Product) WHERE p.price > 1000 } RETURN u </code></pre></div> <h3 id="parameter-syntax" class="position-relative d-flex align-items-center group"> Parameter 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="parameter-syntax" aria-haspopup="dialog" aria-label="Share link: Parameter Syntax"> Share link </button> </h3><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">// Parameter placeholder $parameter_name // Examples MATCH (u:User {id: $user_id}) RETURN u WHERE u.age > $min_age AND u.age < $max_age CREATE (u:User $user_properties) </code></pre></div> <h3 id="schema-syntax" class="position-relative d-flex align-items-center group"> Schema 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="schema-syntax" aria-haspopup="dialog" aria-label="Share link: Schema Syntax"> Share link </button> </h3> <h4 id="index" class="position-relative d-flex align-items-center group"> 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="index" aria-haspopup="dialog" aria-label="Share link: Index"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">CREATE [index_type] INDEX [index_name] FOR (variable:Label) ON (variable.property [, variable.property, ...]) [OPTIONS {option: value, ...}] // Examples CREATE INDEX FOR (u:User) ON (u.email) CREATE INDEX user_name_idx FOR (u:User) ON (u.name) CREATE VECTOR INDEX FOR (d:Doc) ON (d.embedding) OPTIONS {metric: 'cosine'} </code></pre></div> <h4 id="constraint" class="position-relative d-flex align-items-center group"> Constraint <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="constraint" aria-haspopup="dialog" aria-label="Share link: Constraint"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">CREATE CONSTRAINT [constraint_name] ON (variable:Label) ASSERT constraint_type // Examples CREATE CONSTRAINT ON (u:User) ASSERT u.email IS UNIQUE CREATE CONSTRAINT ON (u:User) ASSERT EXISTS(u.email) CREATE CONSTRAINT ON (p:Product) ASSERT p.price IS :: FLOAT </code></pre></div> <h3 id="transaction-syntax" class="position-relative d-flex align-items-center group"> Transaction 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="transaction-syntax" aria-haspopup="dialog" aria-label="Share link: Transaction Syntax"> Share link </button> </h3><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">BEGIN [TRANSACTION] [ISOLATION LEVEL {SERIALIZABLE|READ COMMITTED|READ UNCOMMITTED}] COMMIT [TRANSACTION] ROLLBACK [TRANSACTION] SAVEPOINT savepoint_name ROLLBACK TO SAVEPOINT savepoint_name </code></pre></div> <h3 id="grammar-summary" class="position-relative d-flex align-items-center group"> Grammar Summary <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="grammar-summary" aria-haspopup="dialog" aria-label="Share link: Grammar Summary"> Share link </button> </h3><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gdscript3" data-lang="gdscript3">query: single_query | query UNION [ALL] single_query ; single_query: clause+ ; clause: MATCH pattern [WHERE condition] | OPTIONAL MATCH pattern [WHERE condition] | CREATE pattern | MERGE pattern [ON CREATE SET ...] [ON MATCH SET ...] | DELETE expression | SET assignment | REMOVE removal | RETURN return_items [ORDER BY ...] [LIMIT ...] [OFFSET ...] | WITH with_items [WHERE condition] [ORDER BY ...] [LIMIT ...] ; pattern: pattern_element [, pattern_element]* ; pattern_element: node_pattern | node_pattern relationship_pattern node_pattern | path_variable = pattern_path ; node_pattern: '(' [variable] [label_expression] [properties] [WHERE condition] ')' ; relationship_pattern: '-[' [variable] [type_expression] [properties] [variable_length] [WHERE condition] ']->' | '<-[' [variable] [type_expression] [properties] [variable_length] [WHERE condition] ']-' | '-[' [variable] [type_expression] [properties] [variable_length] [WHERE condition] ']-' ; </code></pre></div> <h3 id="best-practices" class="position-relative d-flex align-items-center group"> Best Practices <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="best-practices" aria-haspopup="dialog" aria-label="Share link: Best Practices"> Share link </button> </h3><ol> <li>Consistent Formatting: Use consistent indentation and spacing</li> <li>Meaningful Names: Choose descriptive variable names</li> <li>Quote Special Characters: Use backticks for identifiers with special characters</li> <li>Parameterize Queries: Use parameters instead of string concatenation</li> <li>Comment Complex Queries: Add comments explaining business logic</li> <li>Break Long Queries: Use WITH to create logical query stages</li> <li>Validate Syntax: Test queries incrementally while building</li> </ol> <h3 id="related-topics" class="position-relative d-flex align-items-center group"> Related Topics <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="related-topics" aria-haspopup="dialog" aria-label="Share link: Related Topics"> Share link </button> </h3><ul> <li>GQL Reference: Complete language reference</li> <li>GQL Operators: Operator documentation</li> <li>GQL Functions: Function reference</li> <li>Data Types: Type system</li> <li>Query Optimization: Performance tuning</li> </ul> <h3 id="further-reading" class="position-relative d-flex align-items-center group"> Further Reading <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="further-reading" aria-haspopup="dialog" aria-label="Share link: Further Reading"> Share link </button> </h3><ul> <li><a href="/tags/gql-reference/" >GQL Reference</a> - Complete language documentation</li> <li><a href="/tags/operators/" >GQL Operators</a> - Operator reference</li> <li><a href="/tags/functions/" >Built-in Functions</a> - Function catalog</li> <li><a href="/tags/types/" >Data Types</a> - Type system</li> <li><a href="/tags/performance/" >Query Performance</a> - Optimization guide</li> </ul> This syntax guide provides the complete grammatical reference for writing correct GQL queries in Geode, from basic patterns to advanced language features.

Popular

Related Articles

Vim Plugin

GQL Operators Reference