Category: Getting Started

The Getting Started category provides everything you need to begin working with Geode graph database. From installation and configuration to writing your first queries, these guides help you go from zero to productive in minutes. <h3 id="introduction-to-getting-started" class="position-relative d-flex align-items-center group"> Introduction to Getting Started <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="introduction-to-getting-started" aria-haspopup="dialog" aria-label="Share link: Introduction to Getting Started"> 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>Starting with a new database system can be daunting, but Geode makes it straightforward. Whether you’re completely new to graph databases or migrating from another system, these getting started guides provide a smooth onboarding experience with clear, actionable steps. This category covers the fundamentals: installing Geode, understanding core concepts, writing your first queries, and building simple applications. Each guide builds progressively, ensuring you have a solid foundation before moving to advanced topics. All examples are tested and production-ready. <h3 id="quick-start-5-minutes-to-your-first-graph" class="position-relative d-flex align-items-center group"> Quick Start: 5 Minutes to Your First Graph <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="quick-start-5-minutes-to-your-first-graph" aria-haspopup="dialog" aria-label="Share link: Quick Start: 5 Minutes to Your First Graph"> Share link </button> </h3> <h4 id="installation" class="position-relative d-flex align-items-center group"> Installation <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="installation" aria-haspopup="dialog" aria-label="Share link: Installation"> Share link </button> </h4>Using Docker (fastest method): <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash"># Pull the latest Geode image docker pull codepros/geode:latest # Run Geode server docker run -p 3141:3141 codepros/geode:latest # Access the shell docker exec -it <container_id> geode shell </code></pre></div>Building from Source (requires Zig 0.1.0+): <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash"># Clone repository git clone https://github.com/codeprosorg/geode cd geode # Build make build # Run ./zig-out/bin/geode serve </code></pre></div> <h4 id="your-first-query" class="position-relative d-flex align-items-center group"> Your First Query <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="your-first-query" aria-haspopup="dialog" aria-label="Share link: Your First Query"> Share link </button> </h4>Open the Geode shell: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash">geode shell </code></pre></div>Create your first graph: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">-- Create nodes CREATE (alice:Person {name: 'Alice', age: 30}); CREATE (bob:Person {name: 'Bob', age: 35}); -- Create relationship MATCH (a:Person {name: 'Alice'}), (b:Person {name: 'Bob'}) CREATE (a)-[:KNOWS {since: 2020}]->(b); -- Query the graph MATCH (p:Person)-[k:KNOWS]->(f:Person) RETURN p.name, k.since, f.name; </code></pre></div>Output: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-fallback" data-lang="fallback">| p.name | k.since | f.name | |--------|---------|--------| | Alice | 2020 | Bob | </code></pre></div>Congratulations! You’ve created and queried your first graph. <h3 id="understanding-core-concepts" class="position-relative d-flex align-items-center group"> Understanding Core Concepts <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="understanding-core-concepts" aria-haspopup="dialog" aria-label="Share link: Understanding Core Concepts"> Share link </button> </h3> <h4 id="what-is-a-graph-database" class="position-relative d-flex align-items-center group"> What is a Graph Database? <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="what-is-a-graph-database" aria-haspopup="dialog" aria-label="Share link: What is a Graph Database?"> Share link </button> </h4>A graph database stores data as nodes (entities) and relationships (connections): <ul> <li>Nodes: Represent entities like people, products, or locations</li> <li>Relationships: Connect nodes with typed, directed connections</li> <li>Properties: Key-value pairs stored on both nodes and relationships</li> <li>Labels: Categories or types for nodes</li> </ul> Example: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">-- Node with label and properties (alice:Person {name: 'Alice', email: 'alice@example.com'}) -- Relationship with type and properties -[:KNOWS {since: 2020, strength: 'strong'}]-> </code></pre></div> <h4 id="graph-vs-relational-databases" class="position-relative d-flex align-items-center group"> Graph vs. Relational Databases <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="graph-vs-relational-databases" aria-haspopup="dialog" aria-label="Share link: Graph vs. Relational Databases"> Share link </button> </h4>Relational Database (SQL): <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-sql" data-lang="sql">-- Three tables with foreign keys SELECT p1.name, p2.name FROM persons p1 JOIN friendships f ON p1.id = f.person1_id JOIN persons p2 ON f.person2_id = p2.id; </code></pre></div>Graph Database (GQL): <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">-- Natural pattern matching MATCH (p1:Person)-[:FRIENDS_WITH]->(p2:Person) RETURN p1.name, p2.name; </code></pre></div>Graphs excel at: <ul> <li>Relationship queries: Finding connections is natural and fast</li> <li>Variable-depth traversals: “Friends of friends” queries scale linearly</li> <li>Pattern matching: Complex patterns expressed simply</li> <li>Schema flexibility: Evolve your model without migrations</li> </ul> <h4 id="the-property-graph-model" class="position-relative d-flex align-items-center group"> The Property Graph Model <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="the-property-graph-model" aria-haspopup="dialog" aria-label="Share link: The Property Graph Model"> Share link </button> </h4>Geode implements the property graph model defined in ISO/IEC 39075:2024: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">-- Node: (label {properties}) (person:Person { name: 'Alice', age: 30, email: 'alice@example.com' }) -- Relationship: -[type {properties}]-> -[:WORKS_AT { since: 2020, position: 'Engineer' }]-> -- Complete pattern (alice:Person {name: 'Alice'}) -[:WORKS_AT {since: 2020, position: 'Engineer'}]-> (acme:Company {name: 'Acme Corp'}) </code></pre></div> <h3 id="step-by-step-tutorial" class="position-relative d-flex align-items-center group"> Step-by-Step Tutorial <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="step-by-step-tutorial" aria-haspopup="dialog" aria-label="Share link: Step-by-Step Tutorial"> Share link </button> </h3> <h4 id="step-1-set-up-your-environment" class="position-relative d-flex align-items-center group"> Step 1: Set Up Your Environment <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="step-1-set-up-your-environment" aria-haspopup="dialog" aria-label="Share link: Step 1: Set Up Your Environment"> Share link </button> </h4>Server Configuration (<code>geode.toml</code>): <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-toml" data-lang="toml">[server] listen = "0.0.0.0:3141" max_connections = 1000 [storage] data_dir = "./data" wal_dir = "./wal" [security] auth_enabled = false # Disable for local development </code></pre></div>Start the server: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash">geode serve --config geode.toml </code></pre></div>Verify it’s running: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash"># Should return PONG geode ping </code></pre></div> <h4 id="step-2-connect-with-a-client" class="position-relative d-flex align-items-center group"> Step 2: Connect with a Client <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="step-2-connect-with-a-client" aria-haspopup="dialog" aria-label="Share link: Step 2: Connect with a Client"> Share link </button> </h4>Python: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-python" data-lang="python">import asyncio from geode_client import Client async def main(): client = Client(host="localhost", port=3141) async with client.connection() as conn: result, _ = await conn.query("RETURN 'Hello, Geode!' as message") for row in result.rows: print(row["message"]) asyncio.run(main()) </code></pre></div>Go: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go">package main import ( "context" "database/sql" "fmt" "log" _ "geodedb.com/geode/driver" ) func main() { db, err := sql.Open("geode", "quic://localhost:3141") if err != nil { log.Fatal(err) } defer db.Close() var message string err = db.QueryRowContext(context.Background(), "RETURN 'Hello, Geode!' as message").Scan(&message) if err != nil { log.Fatal(err) } fmt.Println(message) } </code></pre></div> <h4 id="step-3-build-a-simple-social-network" class="position-relative d-flex align-items-center group"> Step 3: Build a Simple Social Network <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="step-3-build-a-simple-social-network" aria-haspopup="dialog" aria-label="Share link: Step 3: Build a Simple Social Network"> Share link </button> </h4>Create users: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">CREATE (alice:User { id: 'user1', name: 'Alice Anderson', email: 'alice@example.com', joined: datetime('2024-01-15') }); CREATE (bob:User { id: 'user2', name: 'Bob Brown', email: 'bob@example.com', joined: datetime('2024-02-20') }); CREATE (charlie:User { id: 'user3', name: 'Charlie Chen', email: 'charlie@example.com', joined: datetime('2024-03-10') }); </code></pre></div>Create friendships: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">MATCH (a:User {id: 'user1'}), (b:User {id: 'user2'}) CREATE (a)-[:FRIENDS_WITH {since: datetime('2024-03-01')}]->(b); MATCH (b:User {id: 'user2'}), (c:User {id: 'user3'}) CREATE (b)-[:FRIENDS_WITH {since: datetime('2024-03-15')}]->(c); </code></pre></div>Query friends: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">MATCH (u:User {id: 'user1'})-[:FRIENDS_WITH]->(friend) RETURN friend.name, friend.email; </code></pre></div>Find friends of friends: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">MATCH (u:User {id: 'user1'})-[:FRIENDS_WITH*1..2]->(connection) WHERE connection.id <> 'user1' RETURN DISTINCT connection.name; </code></pre></div> <h4 id="step-4-add-posts-and-interactions" class="position-relative d-flex align-items-center group"> Step 4: Add Posts and Interactions <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="step-4-add-posts-and-interactions" aria-haspopup="dialog" aria-label="Share link: Step 4: Add Posts and Interactions"> Share link </button> </h4>Create posts: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">MATCH (u:User {id: 'user1'}) CREATE (u)-[:POSTED]->(p:Post { id: 'post1', content: 'Hello from Geode!', timestamp: datetime('2024-03-15T10:30:00'), likes: 0 }); </code></pre></div>Like a post: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">MATCH (u:User {id: 'user2'}), (p:Post {id: 'post1'}) CREATE (u)-[:LIKES {timestamp: datetime()}]->(p) SET p.likes = p.likes + 1; </code></pre></div>Build a news feed: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">MATCH (u:User {id: 'user2'})-[:FRIENDS_WITH]->(friend)-[:POSTED]->(post) RETURN friend.name, post.content, post.timestamp, post.likes ORDER BY post.timestamp DESC LIMIT 10; </code></pre></div> <h4 id="step-5-add-indexes-for-performance" class="position-relative d-flex align-items-center group"> Step 5: Add Indexes for Performance <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="step-5-add-indexes-for-performance" aria-haspopup="dialog" aria-label="Share link: Step 5: Add Indexes for Performance"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">-- Unique constraint on email CREATE CONSTRAINT unique_email ON :User(email); -- Index on frequently queried fields CREATE INDEX user_name ON :User(name); CREATE INDEX post_timestamp ON :Post(timestamp); -- Verify indexes SHOW INDEXES; </code></pre></div> <h3 id="essential-gql-patterns" class="position-relative d-flex align-items-center group"> Essential GQL 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="essential-gql-patterns" aria-haspopup="dialog" aria-label="Share link: Essential GQL Patterns"> Share link </button> </h3> <h4 id="creating-data" class="position-relative d-flex align-items-center group"> Creating Data <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="creating-data" aria-haspopup="dialog" aria-label="Share link: Creating Data"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">-- Single node CREATE (n:Label {property: 'value'}); -- Multiple nodes CREATE (n1:Label1), (n2:Label2); -- Node and relationship in one statement CREATE (a:Person {name: 'Alice'})-[:KNOWS]->(b:Person {name: 'Bob'}); -- Using MERGE for upsert MERGE (p:Person {email: 'alice@example.com'}) ON CREATE SET p.name = 'Alice', p.created = datetime() ON MATCH SET p.last_seen = datetime(); </code></pre></div> <h4 id="querying-data" class="position-relative d-flex align-items-center group"> Querying Data <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="querying-data" aria-haspopup="dialog" aria-label="Share link: Querying Data"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">-- Match all nodes with a label MATCH (p:Person) RETURN p; -- Match with properties MATCH (p:Person {name: 'Alice'}) RETURN p; -- Match with WHERE clause MATCH (p:Person) WHERE p.age > 30 RETURN p.name, p.age; -- Match relationships MATCH (p:Person)-[r:KNOWS]->(f:Person) RETURN p.name, type(r), f.name; -- Variable-length paths MATCH (p:Person)-[:KNOWS*1..3]->(connection) RETURN DISTINCT connection.name; </code></pre></div> <h4 id="updating-data" class="position-relative d-flex align-items-center group"> Updating Data <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="updating-data" aria-haspopup="dialog" aria-label="Share link: Updating Data"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">-- Set properties MATCH (p:Person {name: 'Alice'}) SET p.age = 31, p.updated = datetime(); -- Remove properties MATCH (p:Person {name: 'Alice'}) REMOVE p.age; -- Add labels MATCH (p:Person {name: 'Alice'}) SET p:VIP; </code></pre></div> <h4 id="deleting-data" class="position-relative d-flex align-items-center group"> Deleting Data <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="deleting-data" aria-haspopup="dialog" aria-label="Share link: Deleting Data"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">-- Delete relationships MATCH (p:Person {name: 'Alice'})-[r:KNOWS]->() DELETE r; -- Delete nodes (must delete relationships first) MATCH (p:Person {name: 'Alice'}) DELETE p; -- Delete node and all relationships MATCH (p:Person {name: 'Alice'}) DETACH DELETE p; -- Delete all data (careful!) MATCH (n) DETACH DELETE n; </code></pre></div> <h3 id="working-with-parameters" class="position-relative d-flex align-items-center group"> Working with Parameters <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="working-with-parameters" aria-haspopup="dialog" aria-label="Share link: Working with Parameters"> Share link </button> </h3>Parameterized queries are safer and more efficient: Python: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-python" data-lang="python">result, _ = await client.query(""" MATCH (p:Person {name: $name}) RETURN p """, {"name": "Alice"}) </code></pre></div>Go: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go">rows, err := db.QueryContext(ctx, "MATCH (p:Person {name: $1}) RETURN p", "Alice") </code></pre></div>In GQL Shell (less common): <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">-- Parameters set via shell command :param name => 'Alice' MATCH (p:Person {name: $name}) RETURN p; </code></pre></div> <h3 id="common-beginner-mistakes" class="position-relative d-flex align-items-center group"> Common Beginner Mistakes <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="common-beginner-mistakes" aria-haspopup="dialog" aria-label="Share link: Common Beginner Mistakes"> Share link </button> </h3> <h4 id="mistake-1-not-using-indexes" class="position-relative d-flex align-items-center group"> Mistake 1: Not Using 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="mistake-1-not-using-indexes" aria-haspopup="dialog" aria-label="Share link: Mistake 1: Not Using Indexes"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">-- Slow: Full graph scan MATCH (p:Person {email: 'alice@example.com'}) RETURN p; -- Fast: Create index first CREATE INDEX person_email ON :Person(email); MATCH (p:Person {email: 'alice@example.com'}) RETURN p; </code></pre></div> <h4 id="mistake-2-cartesian-products" class="position-relative d-flex align-items-center group"> Mistake 2: Cartesian Products <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="mistake-2-cartesian-products" aria-haspopup="dialog" aria-label="Share link: Mistake 2: Cartesian Products"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">-- Bad: Cartesian product (N×M complexity) MATCH (p:Person), (c:Company) WHERE p.company_id = c.id RETURN p.name, c.name; -- Good: Use relationships MATCH (p:Person)-[:WORKS_AT]->(c:Company) RETURN p.name, c.name; </code></pre></div> <h4 id="mistake-3-not-deleting-relationships" class="position-relative d-flex align-items-center group"> Mistake 3: Not Deleting Relationships <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="mistake-3-not-deleting-relationships" aria-haspopup="dialog" aria-label="Share link: Mistake 3: Not Deleting Relationships"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">-- Error: Cannot delete node with relationships MATCH (p:Person {name: 'Alice'}) DELETE p; -- Fails if Alice has relationships -- Correct: Delete relationships first MATCH (p:Person {name: 'Alice'}) DETACH DELETE p; -- Deletes node and all relationships </code></pre></div> <h4 id="mistake-4-ignoring-transactions" class="position-relative d-flex align-items-center group"> Mistake 4: Ignoring Transactions <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="mistake-4-ignoring-transactions" aria-haspopup="dialog" aria-label="Share link: Mistake 4: Ignoring Transactions"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-python" data-lang="python"># Bad: No transaction for multi-step operation await tx.execute("CREATE (p:Person {id: 'user1'})") await tx.execute("CREATE (p:Person {id: 'user2'})") # If second fails, first is still committed # Good: Use transaction async with client.connection() as tx: await tx.begin() await tx.execute("CREATE (p:Person {id: 'user1'})") await tx.execute("CREATE (p:Person {id: 'user2'})") await tx.commit() # Both or neither </code></pre></div> <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> <h4 id="learn-more-about-gql" class="position-relative d-flex align-items-center group"> Learn More About GQL <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="learn-more-about-gql" aria-haspopup="dialog" aria-label="Share link: Learn More About GQL"> Share link </button> </h4><ul> <li>Pattern Matching: Advanced query patterns</li> <li>Aggregations: GROUP BY, COUNT, SUM, AVG</li> <li>Subqueries: Nested queries and EXISTS</li> <li>Functions: String, math, datetime, list functions</li> </ul> <h4 id="explore-features" class="position-relative d-flex align-items-center group"> Explore Features <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="explore-features" aria-haspopup="dialog" aria-label="Share link: Explore Features"> Share link </button> </h4><ul> <li>Indexes: Unique constraints, composite indexes, vector indexes</li> <li>Transactions: ACID guarantees, isolation levels</li> <li>Security: Authentication, authorization, row-level security</li> <li>Full-Text Search: BM25 ranking and text analysis</li> <li>Vector Search: Semantic search with embeddings</li> </ul> <h4 id="build-applications" class="position-relative d-flex align-items-center group"> Build Applications <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="build-applications" aria-haspopup="dialog" aria-label="Share link: Build Applications"> Share link </button> </h4><ul> <li>REST APIs: Integrate Geode with web frameworks</li> <li>Real-Time Apps: WebSocket streaming and change data capture</li> <li>Analytics: Graph algorithms and machine learning</li> <li>Microservices: Distributed system patterns</li> </ul> <h3 id="development-workflow" class="position-relative d-flex align-items-center group"> Development Workflow <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="development-workflow" aria-haspopup="dialog" aria-label="Share link: Development Workflow"> Share link </button> </h3> <h4 id="local-development-setup" class="position-relative d-flex align-items-center group"> Local Development Setup <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="local-development-setup" aria-haspopup="dialog" aria-label="Share link: Local Development Setup"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash"># 1. Clone repository git clone https://github.com/codeprosorg/geode cd geode # 2. Build make build # 3. Run tests make test # 4. Start development server geode serve --dev # 5. Open shell in another terminal geode shell </code></pre></div> <h4 id="configuration-for-development" class="position-relative d-flex align-items-center group"> Configuration for Development <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-for-development" aria-haspopup="dialog" aria-label="Share link: Configuration for Development"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-toml" data-lang="toml">[server] listen = "127.0.0.1:3141" log_level = "debug" [storage] data_dir = "./dev-data" wal_dir = "./dev-wal" [security] auth_enabled = false # Easier for local dev [development] auto_reload = true query_logging = true </code></pre></div> <h4 id="using-docker-compose" class="position-relative d-flex align-items-center group"> Using Docker Compose <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="using-docker-compose" aria-haspopup="dialog" aria-label="Share link: Using Docker Compose"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-yaml" data-lang="yaml">version: '3.8' services: geode: image: codepros/geode:latest ports: - "3141:3141" volumes: - ./data:/var/lib/geode/data - ./config:/etc/geode environment: - GEODE_LOG_LEVEL=debug </code></pre></div> <h3 id="troubleshooting-common-issues" class="position-relative d-flex align-items-center group"> Troubleshooting Common Issues <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="troubleshooting-common-issues" aria-haspopup="dialog" aria-label="Share link: Troubleshooting Common Issues"> Share link </button> </h3> <h4 id="server-wont-start" class="position-relative d-flex align-items-center group"> Server Won&rsquo;t Start <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-wont-start" aria-haspopup="dialog" aria-label="Share link: Server Wont Start"> Share link </button> </h4>Issue: “Address already in use” Solution: Check if another process is using port 3141 <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash">lsof -i :3141 kill <pid> # If found </code></pre></div> <h4 id="connection-refused" class="position-relative d-flex align-items-center group"> Connection Refused <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="connection-refused" aria-haspopup="dialog" aria-label="Share link: Connection Refused"> Share link </button> </h4>Issue: Client can’t connect to server Solution: <ol> <li>Verify server is running: <code>geode ping</code></li> <li>Check firewall allows port 3141</li> <li>Verify connection string matches server address</li> </ol> <h4 id="query-returns-no-results" class="position-relative d-flex align-items-center group"> Query Returns No Results <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="query-returns-no-results" aria-haspopup="dialog" aria-label="Share link: Query Returns No Results"> Share link </button> </h4>Issue: Expected data not returned Solution: <ol> <li>Verify data exists: <code>MATCH (n) RETURN count(n);</code></li> <li>Check label spelling: Labels are case-sensitive</li> <li>Use EXPLAIN to see execution plan</li> </ol> <h4 id="performance-issues" class="position-relative d-flex align-items-center group"> Performance Issues <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-issues" aria-haspopup="dialog" aria-label="Share link: Performance Issues"> Share link </button> </h4>Issue: Queries running slowly Solution: <ol> <li>Add indexes on frequently queried properties</li> <li>Use EXPLAIN PROFILE to identify bottlenecks</li> <li>Avoid Cartesian products</li> <li>Use specific labels in MATCH patterns</li> </ol> <h3 id="resources-for-learning" class="position-relative d-flex align-items-center group"> Resources for Learning <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="resources-for-learning" aria-haspopup="dialog" aria-label="Share link: Resources for Learning"> Share link </button> </h3> <h4 id="official-documentation" class="position-relative d-flex align-items-center group"> Official Documentation <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="official-documentation" aria-haspopup="dialog" aria-label="Share link: Official Documentation"> Share link </button> </h4><ul> <li>API Reference: Complete client library documentation</li> <li>GQL Language Guide: Comprehensive syntax reference</li> <li>Architecture Docs: How Geode works internally</li> <li>Examples: Sample applications and code snippets</li> </ul> <h4 id="interactive-learning" class="position-relative d-flex align-items-center group"> Interactive Learning <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="interactive-learning" aria-haspopup="dialog" aria-label="Share link: Interactive Learning"> Share link </button> </h4><ul> <li>Geode Shell: Interactive REPL for experimentation</li> <li>Tutorials: Step-by-step guided projects</li> <li>Sandbox: Try Geode online without installation</li> <li>Video Courses: Visual learning resources</li> </ul> <h4 id="community" class="position-relative d-flex align-items-center group"> Community <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="community" aria-haspopup="dialog" aria-label="Share link: Community"> Share link </button> </h4><ul> <li>GitHub Discussions: Ask questions and share experiences</li> <li>Discord Channel: Real-time chat with other users</li> <li>Stack Overflow: Tagged questions and answers</li> <li>Blog: Technical articles and best practices</li> </ul> <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>Examples: Practical code samples and applications</li> <li>Query Language: Deep dive into GQL syntax</li> <li>Client Libraries: Language-specific integration guides</li> <li>Best Practices: Production deployment recommendations</li> <li>Performance: Optimization and tuning strategies</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>Graph Database Fundamentals: Core concepts and theory</li> <li>GQL vs. Cypher: Comparing graph query languages</li> <li>Migration Guides: Moving from other databases</li> <li>Architecture Overview: Understanding Geode’s design</li> <li>Advanced Features: Vector search, full-text, and more</li> </ul> <hr> Getting started with Geode is straightforward: install the server, run your first queries, and build from there. The combination of ISO-standard GQL, comprehensive client libraries, and production-ready features makes Geode an excellent choice for graph database applications of any scale.

Popular

Related Articles

Quick Start Guide

Installation Guide

Building Your First Application

Overview

Installation and Quick Start

Introduction and Key Features

Installation

Tutorials