Quick Start Guide

<h2 id="quick-start-guide" class="position-relative d-flex align-items-center group"> Quick Start Guide <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-guide" aria-haspopup="dialog" aria-label="Share link: Quick Start Guide"> 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>Get Geode graph database running and execute your first queries in under 10 minutes. This streamlined guide delivers exactly what you need to move from installation to production-ready queries, with copy-paste examples for Python, Go, Rust, and Zig developers. <h3 id="why-choose-geode-30-seconds" class="position-relative d-flex align-items-center group"> Why Choose Geode? (30 seconds) <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="why-choose-geode-30-seconds" aria-haspopup="dialog" aria-label="Share link: Why Choose Geode? (30 seconds)"> Share link </button> </h3>Before we dive into installation, understand what makes Geode the right choice for your graph data needs. Standards-Based: Geode implements ISO/IEC 39075:2024 GQL standard, ensuring your queries are portable and future-proof. Learn GQL once, use it across compliant graph databases. Production-Ready: With 97.4% test coverage, 100% GQL compliance, and battle-tested client libraries, Geode handles production workloads from day one. No “beta” disclaimers or experimental warnings. Modern Architecture: QUIC-based transport with TLS 1.3, memory-mapped I/O, and six specialized index types provide a solid foundation for graph workloads. Enterprise Security: Row-level security, field-level encryption, transparent data encryption, and comprehensive audit logging meet compliance requirements for regulated industries. Developer-Friendly: Natural graph query language, comprehensive documentation, and client libraries in your preferred language make Geode easy to adopt and maintain. Now let’s get you up and running. <h3 id="install-geode-2-minutes" class="position-relative d-flex align-items-center group"> Install Geode (2 minutes) <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="install-geode-2-minutes" aria-haspopup="dialog" aria-label="Share link: Install Geode (2 minutes)"> Share link </button> </h3> <h4 id="option-1-build-from-source" class="position-relative d-flex align-items-center group"> Option 1: Build from Source <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="option-1-build-from-source" aria-haspopup="dialog" aria-label="Share link: Option 1: Build from Source"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash">git clone https://github.com/codeprosorg/geode cd geode make build ./zig-out/bin/geode serve --listen 0.0.0.0:3141 </code></pre></div> <h4 id="option-2-docker" class="position-relative d-flex align-items-center group"> Option 2: Docker <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="option-2-docker" aria-haspopup="dialog" aria-label="Share link: Option 2: Docker"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash">docker run -p 3141:3141 geodedb/geode:latest </code></pre></div>Server is now running on port 3141. <h3 id="install-client-library-1-minute" class="position-relative d-flex align-items-center group"> Install Client Library (1 minute) <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="install-client-library-1-minute" aria-haspopup="dialog" aria-label="Share link: Install Client Library (1 minute)"> Share link </button> </h3>Choose your language: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash"># Python pip install geode-client # Go go get geodedb.com/geode # Rust cargo add geode-client # Zig (use vendored client in repo) </code></pre></div> <h3 id="first-queries-5-minutes" class="position-relative d-flex align-items-center group"> First Queries (5 minutes) <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="first-queries-5-minutes" aria-haspopup="dialog" aria-label="Share link: First Queries (5 minutes)"> Share link </button> </h3> <h4 id="python-quick-start" class="position-relative d-flex align-items-center group"> Python Quick 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="python-quick-start" aria-haspopup="dialog" aria-label="Share link: Python Quick Start"> Share link </button> </h4><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: # Create nodes await conn.execute(""" CREATE (alice:Person {name: 'Alice', age: 30}) CREATE (bob:Person {name: 'Bob', age: 25}) CREATE (alice)-[:KNOWS]->(bob) """) # Query result, _ = await conn.query(""" MATCH (a:Person)-[:KNOWS]->(b:Person) RETURN a.name, b.name """) for row in result.rows: print(f"{row['a.name']} knows {row['b.name']}") asyncio.run(main()) </code></pre></div> <h4 id="go-quick-start" class="position-relative d-flex align-items-center group"> Go Quick 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="go-quick-start" aria-haspopup="dialog" aria-label="Share link: Go Quick Start"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go">package main import ( "database/sql" "fmt" _ "geodedb.com/geode" ) func main() { db, _ := sql.Open("geode", "quic://localhost:3141") defer db.Close() // Create db.Exec(`CREATE (p:Person {name: $name})`, sql.Named("name", "Alice")) // Query rows, _ := db.Query("MATCH (p:Person) RETURN p.name") defer rows.Close() for rows.Next() { var name string rows.Scan(&name) fmt.Println(name) } } </code></pre></div> <h4 id="rust-quick-start" class="position-relative d-flex align-items-center group"> Rust Quick 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="rust-quick-start" aria-haspopup="dialog" aria-label="Share link: Rust Quick Start"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-rust" data-lang="rust">use geode_client::{Client, Result, Value}; use std::collections::HashMap; #[tokio::main] async fn main() -> Result<()> { let client = Client::new("localhost", 3141).skip_verify(true); let mut conn = client.connect().await?; let mut params = HashMap::new(); params.insert("name".to_string(), Value::string("Alice")); conn.query_with_params("CREATE (p:Person {name: $name})", &params) .await?; let (page, _) = conn.query("MATCH (p:Person) RETURN p.name AS name").await?; for row in &page.rows { println!("{}", row.get("name").unwrap().as_string()?); } Ok(()) } </code></pre></div> <h3 id="essential-gql-commands" class="position-relative d-flex align-items-center group"> Essential GQL Commands <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="essential-gql-commands" aria-haspopup="dialog" aria-label="Share link: Essential GQL Commands"> 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">-- Create single node CREATE (p:Person {name: 'Alice', age: 30}) -- Create with relationship CREATE (a:Person {name: 'Alice'})-[:KNOWS]->(b:Person {name: 'Bob'}) </code></pre></div> <h4 id="read" class="position-relative d-flex align-items-center group"> Read <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="read" aria-haspopup="dialog" aria-label="Share link: Read"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">-- Match all MATCH (p:Person) RETURN p -- Match with filter MATCH (p:Person) WHERE p.age > 25 RETURN p.name -- Match relationships MATCH (a:Person)-[:KNOWS]->(b:Person) RETURN a.name, b.name </code></pre></div> <h4 id="update" class="position-relative d-flex align-items-center group"> Update <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="update" aria-haspopup="dialog" aria-label="Share link: Update"> 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.city = 'NYC' </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">-- Delete node and relationships MATCH (p:Person {name: 'Alice'}) DETACH DELETE p </code></pre></div> <h3 id="common-patterns" class="position-relative d-flex align-items-center group"> Common 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="common-patterns" aria-haspopup="dialog" aria-label="Share link: Common Patterns"> Share link </button> </h3> <h4 id="friends-of-friends" class="position-relative d-flex align-items-center group"> Friends of Friends <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="friends-of-friends" aria-haspopup="dialog" aria-label="Share link: Friends of Friends"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">MATCH (me:Person {name: 'Alice'})-[:KNOWS*2]->(friend) WHERE NOT (me)-[:KNOWS]->(friend) RETURN DISTINCT friend.name </code></pre></div> <h4 id="recommendations" class="position-relative d-flex align-items-center group"> Recommendations <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="recommendations" aria-haspopup="dialog" aria-label="Share link: Recommendations"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">MATCH (me:User)-[:PURCHASED]->(p:Product) <-[:PURCHASED]-(other)-[:PURCHASED]->(rec) WHERE NOT (me)-[:PURCHASED]->(rec) RETURN rec.name, COUNT(*) as score ORDER BY score DESC LIMIT 5 </code></pre></div> <h4 id="shortest-path" class="position-relative d-flex align-items-center group"> Shortest Path <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="shortest-path" aria-haspopup="dialog" aria-label="Share link: Shortest Path"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">MATCH path = shortestPath((a:Person {name: 'Alice'}) -[:KNOWS*]-(b:Person {name: 'Zoe'})) RETURN length(path) </code></pre></div> <h3 id="using-transactions" class="position-relative d-flex align-items-center group"> Using 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="using-transactions" aria-haspopup="dialog" aria-label="Share link: Using Transactions"> Share link </button> </h3><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-python" data-lang="python">async with client.connection() as conn: await conn.begin() try: await conn.execute("CREATE (p:Person {name: 'Alice'})") await conn.execute("CREATE (p:Person {name: 'Bob'})") await conn.commit() except Exception: await conn.rollback() raise </code></pre></div> <h3 id="next-steps-2-minutes" class="position-relative d-flex align-items-center group"> Next Steps (2 minutes) <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-2-minutes" aria-haspopup="dialog" aria-label="Share link: Next Steps (2 minutes)"> Share link </button> </h3>Interactive Shell: Test queries instantly <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash">./zig-out/bin/geode shell </code></pre></div>Profile Queries: Understand performance <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">PROFILE MATCH (p:Person) RETURN p </code></pre></div>Create Index: Speed up queries <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">CREATE INDEX ON Person(name) </code></pre></div>Use Transactions: Ensure consistency <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-python" data-lang="python">async with client.connection() as conn: await conn.begin() try: # multiple operations await conn.commit() except Exception: await conn.rollback() raise </code></pre></div> <h3 id="key-concepts" class="position-relative d-flex align-items-center group"> Key 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="key-concepts" aria-haspopup="dialog" aria-label="Share link: Key Concepts"> Share link </button> </h3>Nodes: Entities (Person, Product, Location) Relationships: Connections (KNOWS, PURCHASED, LOCATED_IN) Properties: Attributes ({name: ‘Alice’, age: 30}) Labels: Node categories (Person, User, Admin) Patterns: Query structures (a)-[:KNOWS]->(b) <h3 id="common-gotchas" class="position-relative d-flex align-items-center group"> Common Gotchas <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-gotchas" aria-haspopup="dialog" aria-label="Share link: Common Gotchas"> Share link </button> </h3><ol> <li> Always parameterize queries to prevent injection <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-python" data-lang="python"># Bad: query = f"MATCH (p {{name: '{name}'}})" # Good: query = "MATCH (p {name: $name})", name=name </code></pre></div></li> <li> DETACH DELETE removes relationships automatically <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">DETACH DELETE p -- Safe, removes relationships too DELETE p -- Error if p has relationships </code></pre></div></li> <li> Relationship direction matters in creation, flexible in queries <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">CREATE (a)-[:KNOWS]->(b) -- Directed MATCH (a)-[:KNOWS]-(b) -- Query either direction </code></pre></div></li> <li> Variable-length paths need bounds <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">-[:KNOWS*1..5]-> -- Good: bounded -[:KNOWS*]-> -- Risky: unbounded </code></pre></div></li> </ol> <h3 id="help-resources" class="position-relative d-flex align-items-center group"> Help Resources <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="help-resources" aria-haspopup="dialog" aria-label="Share link: Help Resources"> Share link </button> </h3>Documentation: Full guides and API reference at geodedb.com Examples: Working code in /examples directory Community: Questions and discussions on GitHub Interactive Shell: Built-in help with <code>help</code> command <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><ul> <li>Create indexes for frequently queried properties</li> <li>Use PROFILE to understand query execution</li> <li>Keep transactions short and focused</li> <li>Use connection pooling (automatic in clients)</li> <li>Parameterize queries for prepared statement caching</li> </ul> <h3 id="production-checklist" class="position-relative d-flex align-items-center group"> Production Checklist <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="production-checklist" aria-haspopup="dialog" aria-label="Share link: Production Checklist"> Share link </button> </h3><ul> <li><input disabled="" type="checkbox"> Enable TLS certificates for encryption</li> <li><input disabled="" type="checkbox"> Configure connection pool sizes</li> <li><input disabled="" type="checkbox"> Set up monitoring and alerts</li> <li><input disabled="" type="checkbox"> Implement backup strategy</li> <li><input disabled="" type="checkbox"> Create indexes for common queries</li> <li><input disabled="" type="checkbox"> Test transaction retry logic</li> <li><input disabled="" type="checkbox"> Configure row-level security policies</li> <li><input disabled="" type="checkbox"> Set up health check endpoints</li> </ul> <h3 id="real-world-quick-start-patterns" class="position-relative d-flex align-items-center group"> Real-World Quick Start 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="real-world-quick-start-patterns" aria-haspopup="dialog" aria-label="Share link: Real-World Quick Start Patterns"> Share link </button> </h3> <h4 id="social-network-5-minutes" class="position-relative d-flex align-items-center group"> Social Network (5 minutes) <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="social-network-5-minutes" aria-haspopup="dialog" aria-label="Share link: Social Network (5 minutes)"> Share link </button> </h4>Build a basic social network: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-python" data-lang="python">async def build_social_network(): client = Client(host="localhost", port=3141) async with client.connection() as conn: # Create users await conn.execute(""" CREATE (alice:User {id: 'u1', name: 'Alice', age: 30}) CREATE (bob:User {id: 'u2', name: 'Bob', age: 25}) CREATE (carol:User {id: 'u3', name: 'Carol', age: 28}) CREATE (dave:User {id: 'u4', name: 'Dave', age: 32}) """) # Create friendships await conn.execute(""" MATCH (alice:User {id: 'u1'}) MATCH (bob:User {id: 'u2'}) MATCH (carol:User {id: 'u3'}) MATCH (dave:User {id: 'u4'}) CREATE (alice)-[:KNOWS {since: '2020-01-15'}]->(bob) CREATE (bob)-[:KNOWS {since: '2021-03-20'}]->(carol) CREATE (carol)-[:KNOWS {since: '2019-11-10'}]->(dave) CREATE (alice)-[:KNOWS {since: '2022-06-05'}]->(dave) """) # Find friends of friends result, _ = await conn.query(""" MATCH (me:User {id: 'u1'})-[:KNOWS*2]->(fof:User) WHERE NOT (me)-[:KNOWS]->(fof) RETURN DISTINCT fof.name AS friend_suggestion """) for row in result.rows: print(f"Suggested friend: {row['friend_suggestion']}") </code></pre></div> <h4 id="e-commerce-recommendations-5-minutes" class="position-relative d-flex align-items-center group"> E-Commerce Recommendations (5 minutes) <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="e-commerce-recommendations-5-minutes" aria-haspopup="dialog" aria-label="Share link: E-Commerce Recommendations (5 minutes)"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-python" data-lang="python">async def build_recommendation_engine(): client = Client(host="localhost", port=3141) async with client.connection() as conn: # Create products and purchases await conn.execute(""" CREATE (u1:User {id: 'user1', name: 'Alice'}) CREATE (u2:User {id: 'user2', name: 'Bob'}) CREATE (u3:User {id: 'user3', name: 'Carol'}) CREATE (p1:Product {id: 'prod1', name: 'Laptop', price: 999}) CREATE (p2:Product {id: 'prod2', name: 'Mouse', price: 29}) CREATE (p3:Product {id: 'prod3', name: 'Keyboard', price: 79}) CREATE (p4:Product {id: 'prod4', name: 'Monitor', price: 299}) CREATE (u1)-[:PURCHASED]->(p1) CREATE (u1)-[:PURCHASED]->(p2) CREATE (u2)-[:PURCHASED]->(p1) CREATE (u2)-[:PURCHASED]->(p3) CREATE (u3)-[:PURCHASED]->(p2) CREATE (u3)-[:PURCHASED]->(p3) """) # Get recommendations for Alice result, _ = await conn.query(""" MATCH (me:User {id: 'user1'})-[:PURCHASED]->(p:Product) <-[:PURCHASED]-(other:User)-[:PURCHASED]->(rec:Product) WHERE NOT (me)-[:PURCHASED]->(rec) RETURN rec.name, rec.price, COUNT(*) as score ORDER BY score DESC, rec.price ASC LIMIT 3 """) print("Recommended products:") for row in result.rows: print(f" {row['rec.name']} (${row['rec.price']}) - Score: {row['score']}") </code></pre></div> <h4 id="knowledge-graph-5-minutes" class="position-relative d-flex align-items-center group"> Knowledge Graph (5 minutes) <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="knowledge-graph-5-minutes" aria-haspopup="dialog" aria-label="Share link: Knowledge Graph (5 minutes)"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-python" data-lang="python">async def build_knowledge_graph(): client = Client(host="localhost", port=3141) async with client.connection() as conn: # Create concepts and relationships await conn.execute(""" CREATE (db:Concept {id: 'c1', name: 'Database'}) CREATE (graph:Concept {id: 'c2', name: 'Graph Database'}) CREATE (geode:Concept {id: 'c3', name: 'Geode'}) CREATE (gql:Concept {id: 'c4', name: 'GQL'}) CREATE (query:Concept {id: 'c5', name: 'Query Language'}) CREATE (graph)-[:IS_A]->(db) CREATE (geode)-[:IS_A]->(graph) CREATE (geode)-[:IMPLEMENTS]->(gql) CREATE (gql)-[:IS_A]->(query) """) # Find all ancestors of Geode result, _ = await conn.query(""" MATCH path = (geode:Concept {id: 'c3'})-[:IS_A*]->(ancestor:Concept) RETURN ancestor.name, length(path) as distance ORDER BY distance """) print("Geode is a:") for row in result.rows: print(f" {' ' * row['distance']}{row['ancestor.name']}") </code></pre></div> <h3 id="performance-tuning-quick-wins" class="position-relative d-flex align-items-center group"> Performance Tuning Quick Wins <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-tuning-quick-wins" aria-haspopup="dialog" aria-label="Share link: Performance Tuning Quick Wins"> Share link </button> </h3> <h4 id="create-indexes-1-minute" class="position-relative d-flex align-items-center group"> Create Indexes (1 minute) <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-indexes-1-minute" aria-haspopup="dialog" aria-label="Share link: Create Indexes (1 minute)"> Share link </button> </h4>Dramatically improve query performance: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">-- Index frequently queried properties CREATE INDEX ON User(email); CREATE INDEX ON Product(sku); CREATE INDEX ON Transaction(timestamp); -- Verify index usage PROFILE MATCH (u:User {email: 'alice@example.com'}) RETURN u; </code></pre></div>Index creation typically improves lookup queries significantly. <h4 id="use-connection-pooling" class="position-relative d-flex align-items-center group"> Use Connection Pooling <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="use-connection-pooling" aria-haspopup="dialog" aria-label="Share link: Use Connection Pooling"> Share link </button> </h4>Pooling is explicit in Python and Rust, built into <code>database/sql</code> for Go, and enabled by default in Node.js. Enable it when you need higher concurrency. <h4 id="batch-operations-2-minutes" class="position-relative d-flex align-items-center group"> Batch Operations (2 minutes) <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="batch-operations-2-minutes" aria-haspopup="dialog" aria-label="Share link: Batch Operations (2 minutes)"> Share link </button> </h4>Process multiple operations efficiently: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-python" data-lang="python"># Instead of individual inserts async with client.connection() as conn: for user in users: await conn.execute("CREATE (:User {name: $name})", {"name": user["name"]}) # Use batch operations async with client.connection() as conn: await conn.batch([ ("CREATE (:User {name: $name})", {"name": user["name"]}) for user in users ]) </code></pre></div>Batching reduces network roundtrips and improves throughput by 5-10x. <h3 id="quick-troubleshooting-guide" class="position-relative d-flex align-items-center group"> Quick Troubleshooting Guide <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-troubleshooting-guide" aria-haspopup="dialog" aria-label="Share link: Quick Troubleshooting Guide"> Share link </button> </h3>Can’t Connect to Server: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash"># Check if server is running ps aux | grep geode # Check port netstat -tulpn | grep 3141 # Test connectivity telnet localhost 3141 </code></pre></div>Slow Queries: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">-- Profile the query to see execution plan PROFILE MATCH (p:Person) WHERE p.age > 25 RETURN p.name -- Check if indexes exist SHOW INDEXES; -- Create missing indexes CREATE INDEX ON Person(age); </code></pre></div>Memory Issues: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash"># Check Geode memory usage docker stats geode # If using Docker # Or ps aux | grep geode # Increase if needed in geode.yaml: max_memory: 16GB </code></pre></div>Authentication Errors: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-python" data-lang="python"># Ensure you're using correct credentials client = Client("localhost:3141", username="admin", password="password") # Or with token client = Client("localhost:3141", token="your-api-token") </code></pre></div> <h3 id="production-readiness-checklist-5-minutes" class="position-relative d-flex align-items-center group"> Production Readiness Checklist (5 minutes) <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="production-readiness-checklist-5-minutes" aria-haspopup="dialog" aria-label="Share link: Production Readiness Checklist (5 minutes)"> Share link </button> </h3>Before deploying to production, ensure you’ve covered these basics: <ul> <li><input disabled="" type="checkbox"> Enable TLS: Configure certificates for encrypted connections</li> <li><input disabled="" type="checkbox"> Set Up Backups: Schedule automated daily backups</li> <li><input disabled="" type="checkbox"> Configure Monitoring: Set up Prometheus metrics export</li> <li><input disabled="" type="checkbox"> Create Indexes: Index frequently queried properties</li> <li><input disabled="" type="checkbox"> Set Resource Limits: Configure max memory and connections</li> <li><input disabled="" type="checkbox"> Enable Audit Logging: Track all database operations</li> <li><input disabled="" type="checkbox"> Test Failover: Verify backup restore procedures</li> <li><input disabled="" type="checkbox"> Document Queries: Keep a query library for your team</li> <li><input disabled="" type="checkbox"> Set Up Alerts: Configure alerts for high CPU/memory/latency</li> <li><input disabled="" type="checkbox"> Load Test: Verify performance under expected load</li> </ul> <h3 id="whats-next" class="position-relative d-flex align-items-center group"> What&rsquo;s Next? <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="whats-next" aria-haspopup="dialog" aria-label="Share link: Whats Next?"> Share link </button> </h3>You’ve successfully installed Geode, executed queries, and learned the fundamentals. Here’s your roadmap for continued learning: Immediate Next Steps (Today): <ul> <li>Read the <a href="/tags/getting-started/" >Getting Started Guide</a> for deeper understanding</li> <li>Explore <a href="/tags/examples/" >Example Code</a> in your preferred language</li> <li>Try the <a href="/tags/repl/" >Interactive REPL</a> for ad-hoc queries</li> </ul> This Week: <ul> <li>Learn <a href="/tags/transactions/" >Transaction Management</a> for ACID guarantees</li> <li>Understand <a href="/tags/authentication/" >Security Features</a> for production deployment</li> <li>Practice <a href="/tags/performance/" >Performance Optimization</a> techniques</li> </ul> This Month: <ul> <li>Master <a href="/tags/advanced/" >Advanced GQL Patterns</a> for complex queries</li> <li>Implement <a href="/tags/row-level-security/" >Row-Level Security</a> for multi-tenancy</li> <li>Set Up <a href="/tags/high-availability/" >High Availability</a> for production resilience</li> </ul> <h3 id="quick-reference-card" class="position-relative d-flex align-items-center group"> Quick Reference Card <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="quick-reference-card" aria-haspopup="dialog" aria-label="Share link: Quick Reference Card"> Share link </button> </h3><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">-- Create CREATE (:Label {property: 'value'}) CREATE (:Person {name: 'Alice', age: 30}) CREATE (a)-[:RELATIONSHIP]->(b) -- Read MATCH (n:Label) RETURN n MATCH (a)-[:REL]->(b) RETURN a, b MATCH (n) WHERE n.property = 'value' RETURN n -- Update MATCH (n) SET n.property = 'new_value' MATCH (n) SET n.prop1 = 'a', n.prop2 = 'b' -- Delete MATCH (n) DELETE n -- Error if has relationships MATCH (n) DETACH DELETE n -- Safe, removes relationships -- Aggregation MATCH (n:Label) RETURN COUNT(n) MATCH (n:Person) RETURN AVG(n.age) MATCH (n) RETURN n.category, COUNT(n) GROUP BY n.category -- Path Finding MATCH path = shortestPath((a)-[*]-(b)) RETURN path MATCH (a)-[:KNOWS*1..3]->(b) RETURN b </code></pre></div> <h3 id="community-and-support" class="position-relative d-flex align-items-center group"> Community and Support <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="community-and-support" aria-haspopup="dialog" aria-label="Share link: Community and Support"> Share link </button> </h3>Questions? The Geode community is here to help: <ul> <li>Documentation: geodedb.com/docs</li> <li>GitHub Issues: github.com/geodedb/geode/issues</li> <li>Discord Chat: discord.gg/geode</li> <li>Stack Overflow: Tag questions with <code>geode-db</code></li> </ul> Found a Bug? Report it on GitHub with: <ul> <li>Geode version (<code>geode version</code>)</li> <li>Query that caused the issue</li> <li>Expected vs actual behavior</li> <li>Error messages and logs</li> </ul> You’re now ready to build production graph applications with Geode. Happy coding! <h3 id="related-topics" class="position-relative d-flex align-items-center group"> Related Topics <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="related-topics" aria-haspopup="dialog" aria-label="Share link: Related Topics"> Share link </button> </h3><ul> <li><a href="/tags/getting-started/" >Getting Started</a> : Detailed beginner guide</li> <li><a href="/tags/tutorials/" >Tutorials</a> : Step-by-step learning paths</li> <li><a href="/tags/examples/" >Examples</a> : Code samples in all languages</li> <li><a href="/tags/installation/" >Installation</a> : Complete setup instructions</li> <li><a href="/tags/developer-guide/" >Developer Guide</a> : Full API documentation</li> <li><a href="/tags/client-library/" >Client Libraries</a> : Language-specific guides</li> <li><a href="/tags/performance/" >Performance</a> : Optimization techniques</li> <li><a href="/tags/security/" >Security</a> : Production security practices</li> </ul>

Popular

Related Articles

Installation and Quick Start