Getting Started with Geode

<h2 id="getting-started-with-geode" class="position-relative d-flex align-items-center group"> Getting Started with Geode <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="getting-started-with-geode" aria-haspopup="dialog" aria-label="Share link: Getting Started with Geode"> 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>Welcome to Geode, an enterprise-ready graph database implementing the ISO/IEC 39075:2024 GQL standard. This guide helps you install Geode, execute your first queries, and understand fundamental graph database concepts within 30 minutes. <h3 id="what-is-geode" class="position-relative d-flex align-items-center group"> What is Geode? <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-geode" aria-haspopup="dialog" aria-label="Share link: What is Geode?"> Share link </button> </h3>Geode is a production-ready graph database that stores data as nodes (entities) and relationships (connections) rather than tables and rows. This natural representation of connected data makes Geode ideal for social networks, recommendation engines, knowledge graphs, fraud detection, and any domain where relationships are as important as the entities themselves. <h4 id="why-choose-geode" class="position-relative d-flex align-items-center group"> Why Choose Geode? <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" aria-haspopup="dialog" aria-label="Share link: Why Choose Geode?"> Share link </button> </h4>Standards-Based: Geode implements the ISO/IEC 39075:2024 Graph Query Language (GQL) standard, ensuring your queries remain portable and future-proof as the graph ecosystem evolves. Production-Ready: With 97.4% test coverage, 100% GQL compliance, and comprehensive client libraries in Python, Go, Rust, and Zig, Geode is battle-tested for demanding production workloads. Modern Architecture: QUIC-based transport with TLS 1.3 encryption, memory-mapped I/O, and six specialized index types. ACID Transactions: Full transactional consistency ensures your data integrity is never compromised, with support for savepoints and isolated concurrent access. Row-Level Security: Fine-grained access control at the database level eliminates complex application-layer authorization logic, simplifying multi-tenant architectures. <h3 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> </h3> <h4 id="prerequisites" class="position-relative d-flex align-items-center group"> Prerequisites <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="prerequisites" aria-haspopup="dialog" aria-label="Share link: Prerequisites"> Share link </button> </h4><ul> <li>Zig 0.1.0+ (for server compilation)</li> <li>Git (for cloning the repository)</li> <li>Linux, macOS, or Windows (with WSL2 for Windows users)</li> </ul> <h4 id="quick-installation" class="position-relative d-flex align-items-center group"> Quick 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="quick-installation" aria-haspopup="dialog" aria-label="Share link: Quick Installation"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash"># Clone the repository git clone https://github.com/codeprosorg/geode cd geode # Build the server (debug mode) make build # Or build optimized release version make release # Start the server geode serve --listen 0.0.0.0:3141 </code></pre></div>The server is now running on port 3141, ready to accept connections. <h4 id="docker-installation" class="position-relative d-flex align-items-center group"> Docker 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="docker-installation" aria-haspopup="dialog" aria-label="Share link: Docker Installation"> Share link </button> </h4>For containerized deployments: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash"># Pull the official image docker pull geodedb/geode:latest # Run the server docker run -p 3141:3141 -v geode-data:/data geodedb/geode:latest # With persistent storage docker run -d \ --name geode \ -p 3141:3141 \ -v $(pwd)/data:/data \ geodedb/geode:latest serve </code></pre></div> <h4 id="verifying-installation" class="position-relative d-flex align-items-center group"> Verifying 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="verifying-installation" aria-haspopup="dialog" aria-label="Share link: Verifying Installation"> Share link </button> </h4>Check that Geode is running: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash"># Using the built-in shell geode shell # Should display: # Geode Shell v0.2.18 # Connected to localhost:3141 # Type 'help' for available commands </code></pre></div> <h3 id="your-first-graph" class="position-relative d-flex align-items-center group"> 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="your-first-graph" aria-haspopup="dialog" aria-label="Share link: Your First Graph"> Share link </button> </h3>Let’s create a simple social network to understand graph fundamentals. <h4 id="connecting-with-python" class="position-relative d-flex align-items-center group"> Connecting with Python <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="connecting-with-python" aria-haspopup="dialog" aria-label="Share link: Connecting with Python"> Share link </button> </h4>Install the Python client: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash">pip install geode-client </code></pre></div>Create your first nodes and relationships: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-python" data-lang="python">import asyncio from geode_client import Client async def first_graph(): # Connect to Geode client = Client(host="localhost", port=3141) async with client.connection() as conn: # Create people await conn.execute(""" CREATE (alice:Person {name: 'Alice', age: 30}) CREATE (bob:Person {name: 'Bob', age: 25}) CREATE (carol:Person {name: 'Carol', age: 28}) """) # Create friendships await conn.execute(""" MATCH (alice:Person {name: 'Alice'}) MATCH (bob:Person {name: 'Bob'}) MATCH (carol:Person {name: 'Carol'}) CREATE (alice)-[:KNOWS {since: 2020}]->(bob) CREATE (bob)-[:KNOWS {since: 2021}]->(carol) """) # Query: Find Alice's friends result, _ = await conn.query(""" MATCH (alice:Person {name: 'Alice'})-[:KNOWS]->(friend) RETURN friend.name, friend.age """) for row in result.rows: print(f"Alice knows {row['friend.name']}, age {row['friend.age']}") asyncio.run(first_graph()) </code></pre></div> <h4 id="connecting-with-go" class="position-relative d-flex align-items-center group"> Connecting with Go <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="connecting-with-go" aria-haspopup="dialog" aria-label="Share link: Connecting with Go"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go">package main import ( "context" "database/sql" "fmt" _ "geodedb.com/geode" ) func main() { db, err := sql.Open("geode", "quic://localhost:3141") if err != nil { panic(err) } defer db.Close() // Create a person _, err = db.Exec(` CREATE (p:Person {name: $name, age: $age}) `, sql.Named("name", "Alice"), sql.Named("age", 30)) // Query people rows, err := db.Query("MATCH (p:Person) RETURN p.name, p.age") defer rows.Close() for rows.Next() { var name string var age int rows.Scan(&name, &age) fmt.Printf("%s is %d years old\n", name, age) } } </code></pre></div> <h4 id="connecting-with-rust" class="position-relative d-flex align-items-center group"> Connecting with Rust <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="connecting-with-rust" aria-haspopup="dialog" aria-label="Share link: Connecting with Rust"> 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<()> { // Connect to Geode let client = Client::new("localhost", 3141).skip_verify(true); let mut conn = client.connect().await?; // Create a node let mut params = HashMap::new(); params.insert("name".to_string(), Value::string("Alice")); params.insert("age".to_string(), Value::int(30)); conn.query_with_params( "CREATE (p:Person {name: $name, age: $age})", &params, ).await?; // Query nodes let (page, _) = conn.query("MATCH (p:Person) RETURN p.name AS name, p.age AS age").await?; for row in &page.rows { let name = row.get("name").unwrap().as_string()?; let age = row.get("age").unwrap().as_int()?; println!("{} is {} years old", name, age); } Ok(()) } </code></pre></div> <h3 id="understanding-graph-concepts" class="position-relative d-flex align-items-center group"> Understanding Graph 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-graph-concepts" aria-haspopup="dialog" aria-label="Share link: Understanding Graph Concepts"> Share link </button> </h3> <h4 id="nodes" class="position-relative d-flex align-items-center group"> Nodes <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="nodes" aria-haspopup="dialog" aria-label="Share link: Nodes"> Share link </button> </h4>Nodes represent entities—people, products, locations, events. Each node can have: <ul> <li>Labels: Categories like <code>Person</code>, <code>Product</code>, <code>Location</code></li> <li>Properties: Attributes like <code>{name: 'Alice', age: 30}</code></li> <li>Unique ID: Automatically assigned by Geode</li> </ul> <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">CREATE (alice:Person {name: 'Alice', email: 'alice@example.com'}) </code></pre></div> <h4 id="relationships" class="position-relative d-flex align-items-center group"> 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="relationships" aria-haspopup="dialog" aria-label="Share link: Relationships"> Share link </button> </h4>Relationships connect nodes and can have: <ul> <li>Type: Describes the connection like <code>KNOWS</code>, <code>PURCHASED</code>, <code>LOCATED_IN</code></li> <li>Direction: From source to target (though queries can traverse either way)</li> <li>Properties: Metadata like <code>{since: 2020, strength: 0.9}</code></li> </ul> <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">MATCH (alice:Person {name: 'Alice'}) MATCH (bob:Person {name: 'Bob'}) CREATE (alice)-[:KNOWS {since: 2020}]->(bob) </code></pre></div> <h4 id="patterns" class="position-relative d-flex align-items-center group"> Patterns <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="patterns" aria-haspopup="dialog" aria-label="Share link: Patterns"> Share link </button> </h4>GQL queries express graph patterns declaratively. The database finds all matches: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">-- Find friends of friends MATCH (me:Person {name: 'Alice'})-[:KNOWS]->(friend)-[:KNOWS]->(fof) RETURN DISTINCT fof.name -- Variable-length paths (1 to 3 hops) MATCH (me:Person {name: 'Alice'})-[:KNOWS*1..3]->(connected) RETURN connected.name </code></pre></div> <h3 id="basic-operations" class="position-relative d-flex align-items-center group"> Basic Operations <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="basic-operations" aria-haspopup="dialog" aria-label="Share link: Basic Operations"> 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">-- Create a single node CREATE (p:Product {id: 'prod123', name: 'Widget', price: 29.99}) -- Create multiple nodes CREATE (u:User {id: 'user1', name: 'Alice'}) CREATE (u2:User {id: 'user2', name: 'Bob'}) -- Create nodes with relationship CREATE (alice:User {name: 'Alice'}) -[:PURCHASED {at: '2025-01-24T10:00:00Z'}]-> (widget:Product {name: 'Widget', price: 29.99}) </code></pre></div> <h4 id="reading-data" class="position-relative d-flex align-items-center group"> Reading 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="reading-data" aria-haspopup="dialog" aria-label="Share link: Reading Data"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">-- Find all products MATCH (p:Product) RETURN p.name, p.price -- Find with conditions MATCH (p:Product) WHERE p.price < 50.00 RETURN p.name, p.price ORDER BY p.price DESC -- Pattern matching with relationships MATCH (u:User)-[:PURCHASED]->(p:Product) RETURN u.name, p.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">-- Update properties MATCH (u:User {id: 'user123'}) SET u.last_login = '2025-01-24T15:30:00Z' -- Add new properties MATCH (p:Product {id: 'prod123'}) SET p.discount = 0.15, p.on_sale = true </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 a node (must have no relationships) MATCH (u:User {id: 'user123'}) DELETE u -- Delete node and its relationships MATCH (u:User {id: 'user123'}) DETACH DELETE u -- Delete specific relationships MATCH (u:User)-[r:PURCHASED]->(p:Product {id: 'prod123'}) DELETE r </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>Group operations for consistency: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-python" data-lang="python"># Python: Atomic multi-step operation async with client.connection() as conn: await conn.begin() try: # Create order await conn.execute( """ CREATE (o:Order {id: $order_id, total: $total}) """, {"order_id": "order123", "total": 59.98}, ) # Link to user await conn.execute( """ MATCH (u:User {id: $user_id}) MATCH (o:Order {id: $order_id}) CREATE (u)-[:PLACED]->(o) """, {"user_id": "user123", "order_id": "order123"}, ) await conn.commit() except Exception: await conn.rollback() raise </code></pre></div> <h3 id="common-beginner-patterns" class="position-relative d-flex align-items-center group"> Common Beginner 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-beginner-patterns" aria-haspopup="dialog" aria-label="Share link: Common Beginner Patterns"> Share link </button> </h3> <h4 id="social-network-query" class="position-relative d-flex align-items-center group"> Social Network 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="social-network-query" aria-haspopup="dialog" aria-label="Share link: Social Network Query"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">-- Find mutual friends MATCH (me:Person {name: 'Alice'})-[:KNOWS]->(friend) -[:KNOWS]->(other:Person) WHERE (me)-[:KNOWS]->(other) RETURN friend.name, other.name </code></pre></div> <h4 id="recommendation-query" class="position-relative d-flex align-items-center group"> Recommendation 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="recommendation-query" aria-haspopup="dialog" aria-label="Share link: Recommendation Query"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">-- Recommend products based on similar purchases MATCH (me:User {id: 'user123'})-[:PURCHASED]->(p:Product) <-[:PURCHASED]-(other:User)-[:PURCHASED]->(rec:Product) WHERE NOT EXISTS { MATCH (me)-[:PURCHASED]->(rec) } RETURN rec.name, COUNT(*) as recommendations ORDER BY recommendations DESC LIMIT 5 </code></pre></div> <h4 id="path-finding" class="position-relative d-flex align-items-center group"> Path Finding <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-finding" aria-haspopup="dialog" aria-label="Share link: Path Finding"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">-- Find shortest path between two people MATCH path = shortestPath( (a:Person {name: 'Alice'})-[:KNOWS*]-(b:Person {name: 'Zoe'}) ) RETURN length(path) as degrees, [n IN nodes(path) | n.name] as path </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>Now that you’ve installed Geode and created your first graph, explore: Tutorials: Step-by-step guides for specific features like transactions, security policies, and performance optimization. Examples: Copy-paste ready code snippets for common operations across all supported languages. Developer Guide: Complete API reference, query syntax documentation, and architectural patterns. Client Documentation: Language-specific integration guides for Python, Go, Rust, and Zig. <h3 id="common-beginner-questions" class="position-relative d-flex align-items-center group"> Common Beginner Questions <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-questions" aria-haspopup="dialog" aria-label="Share link: Common Beginner Questions"> Share link </button> </h3>Q: How do I choose between nodes and relationships? A: Entities become nodes (users, products). Connections become relationships (purchased, knows). If it has independent existence, it’s probably a node. Q: Should I create indexes? A: Yes, for properties you frequently filter on. Start without indexes, profile queries, then add indexes where needed. Q: How do transactions affect performance? A: Transactions add slight overhead but ensure consistency. Keep them short and focused for best performance. Q: Can I query in both directions? A: Yes! Relationships have direction but queries can traverse either way. Use <code>-[:KNOWS]-</code> for undirected matching. <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>Quick Start: Condensed getting started guide</li> <li>Tutorials: In-depth learning paths</li> <li>Examples: Working code samples</li> <li>Installation: Detailed setup instructions</li> <li>Client Libraries: Language-specific integration guides</li> </ul> <h3 id="advanced-getting-started-topics" class="position-relative d-flex align-items-center group"> Advanced Getting Started 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="advanced-getting-started-topics" aria-haspopup="dialog" aria-label="Share link: Advanced Getting Started Topics"> Share link </button> </h3> <h4 id="working-with-indexes-for-performance" class="position-relative d-flex align-items-center group"> Working with 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="working-with-indexes-for-performance" aria-haspopup="dialog" aria-label="Share link: Working with Indexes for Performance"> Share link </button> </h4>Indexes dramatically improve query performance by enabling fast lookups instead of full scans: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">-- Create single-property index CREATE INDEX ON Person(email); -- Create composite index CREATE INDEX ON Transaction(user_id, timestamp); -- Create unique constraint (automatically creates index) CREATE UNIQUE CONSTRAINT ON Person(ssn); -- View existing indexes SHOW INDEXES; -- Query using index PROFILE MATCH (p:Person {email: 'alice@example.com'}) RETURN p; </code></pre></div>Without indexes, <code>MATCH (p:Person {email: '[email protected]'})</code> scans every Person node. With an index, Geode jumps directly to matching nodes—significantly faster for large datasets. <h4 id="transaction-patterns-for-data-consistency" class="position-relative d-flex align-items-center group"> Transaction Patterns for Data Consistency <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-patterns-for-data-consistency" aria-haspopup="dialog" aria-label="Share link: Transaction Patterns for Data Consistency"> Share link </button> </h4>Transactions ensure atomic, consistent operations: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-python" data-lang="python"># Python transaction example async def transfer_funds(from_account, to_account, amount): async with client.connection() as conn: await conn.begin() try: # Read balances result, _ = await conn.query( """ MATCH (from:Account {id: $from_id}) MATCH (to:Account {id: $to_id}) RETURN from.balance AS from_balance, to.balance AS to_balance """, {"from_id": from_account, "to_id": to_account}, ) row = result.rows[0] if result.rows else None if row and row["from_balance"].as_int < amount: raise ValueError("Insufficient funds") # Update balances atomically await conn.execute( """ MATCH (from:Account {id: $from_id}) SET from.balance = from.balance - $amount """, {"from_id": from_account, "amount": amount}, ) await conn.execute( """ MATCH (to:Account {id: $to_id}) SET to.balance = to.balance + $amount """, {"to_id": to_account, "amount": amount}, ) await conn.commit() except Exception: await conn.rollback() raise </code></pre></div>Transactions prevent race conditions, partial updates, and data inconsistencies. <h4 id="connection-pool-configuration" class="position-relative d-flex align-items-center group"> Connection Pool Configuration <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="connection-pool-configuration" aria-haspopup="dialog" aria-label="Share link: Connection Pool Configuration"> 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. Tune pools for your workload: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-python" data-lang="python"># Python - explicit pool configuration client = Client( "localhost:3141", pool_size=50, # Maximum concurrent connections pool_timeout=30, # Seconds to wait for available connection max_overflow=10, # Allow temporary connections beyond pool_size pool_recycle=3600 # Recycle connections after 1 hour ) </code></pre></div><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go">// Go - database/sql automatically pools db, err := sql.Open("geode", "quic://localhost:3141") db.SetMaxOpenConns(50) db.SetMaxIdleConns(10) </code></pre></div><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-rust" data-lang="rust">// Rust - configure pool size use geode_client::ConnectionPool; let pool = ConnectionPool::new("localhost", 3141, 50); </code></pre></div>Proper pool configuration prevents connection exhaustion and improves throughput. <h4 id="error-handling-patterns" class="position-relative d-flex align-items-center group"> Error Handling 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="error-handling-patterns" aria-haspopup="dialog" aria-label="Share link: Error Handling Patterns"> Share link </button> </h4>Handle Geode errors gracefully: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-python" data-lang="python">from geode_client import QueryError async def safe_insert(client, data): max_retries = 3 for attempt in range(max_retries): async with client.connection() as conn: try: await conn.execute( "CREATE (:User {id: $id, email: $email})", data, ) return True except QueryError as exc: # Constraint violation - don't retry if "CONSTRAINT" in str(exc): logger.error(f"Duplicate user: {exc}") return False # Retryable failures if attempt < max_retries - 1: await asyncio.sleep(2 ** attempt) # Exponential backoff continue raise </code></pre></div>Appropriate error handling makes your application resilient to transient failures. <h4 id="monitoring-query-performance" class="position-relative d-flex align-items-center group"> Monitoring Query 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="monitoring-query-performance" aria-haspopup="dialog" aria-label="Share link: Monitoring Query Performance"> Share link </button> </h4>Profile queries to understand execution: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">-- Profile shows execution plan and timing PROFILE MATCH (p:Person)-[:KNOWS*2..3]->(friend) WHERE p.age > 25 RETURN friend.name, COUNT(*) as mutual_friends ORDER BY mutual_friends DESC LIMIT 10; </code></pre></div>Output shows: <ul> <li>Execution steps (scans, lookups, filters, sorts)</li> <li>Rows processed at each step</li> <li>Time spent in each operation</li> <li>Index usage</li> </ul> Use profiling to identify slow operations and add appropriate indexes. <h4 id="data-modeling-best-practices" class="position-relative d-flex align-items-center group"> Data Modeling 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="data-modeling-best-practices" aria-haspopup="dialog" aria-label="Share link: Data Modeling Best Practices"> Share link </button> </h4>Effective graph modeling makes queries natural and efficient: Favor Relationships Over Properties: Instead of storing related IDs as properties, use relationships: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">-- Bad: Store related IDs as properties CREATE (:Order {id: 'o1', user_id: 'u1', product_ids: ['p1', 'p2', 'p3']}) -- Good: Use relationships CREATE (user:User {id: 'u1'}) CREATE (order:Order {id: 'o1'}) CREATE (p1:Product {id: 'p1'}) CREATE (p2:Product {id: 'p2'}) CREATE (p3:Product {id: 'p3'}) CREATE (user)-[:PLACED]->(order) CREATE (order)-[:CONTAINS]->(p1) CREATE (order)-[:CONTAINS]->(p2) CREATE (order)-[:CONTAINS]->(p3) </code></pre></div>Relationships make queries simpler and enable graph traversal. Use Appropriate Labels: Labels categorize nodes for efficient filtering: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">-- Good: Specific labels CREATE (:Admin {name: 'Alice'}) CREATE (:Customer {name: 'Bob'}) -- Better: Multiple labels for inheritance CREATE (:User:Admin {name: 'Alice'}) CREATE (:User:Customer {name: 'Bob'}) -- Query specific type MATCH (admin:Admin) RETURN admin.name -- Query all users MATCH (user:User) RETURN user.name </code></pre></div>Model Time-Series Data Appropriately: For timestamped events, consider bucketing: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">-- Create time buckets CREATE (:TimeBucket {date: '2026-01-24'}) -[:CONTAINS]->(:Event {timestamp: '2026-01-24T10:30:00Z'}) -- Query recent events efficiently MATCH (bucket:TimeBucket)-[:CONTAINS]->(event:Event) WHERE bucket.date >= '2026-01-20' AND event.timestamp > '2026-01-23T00:00:00Z' RETURN event </code></pre></div>Bucketing prevents unlimited graph expansion and improves query performance. <h4 id="security-basics-for-production" class="position-relative d-flex align-items-center group"> Security Basics for Production <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="security-basics-for-production" aria-haspopup="dialog" aria-label="Share link: Security Basics for Production"> Share link </button> </h4>Secure your Geode deployment from the start: Enable TLS: Always use encryption for client-server communication: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash"># Generate self-signed certificate for testing openssl req -x509 -newkey rsa:4096 -keyout key.pem -out cert.pem -days 365 -nodes # Start server with TLS geode serve --tls-cert cert.pem --tls-key key.pem </code></pre></div>Use Authentication: Require credentials for database access: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">-- Create users with limited privileges CREATE USER analyst PASSWORD 'secure_password_here'; GRANT SELECT ON GRAPH analytics TO analyst; -- Create admin user CREATE USER admin PASSWORD 'very_secure_password'; GRANT ALL ON GRAPH * TO admin; </code></pre></div>Implement Row-Level Security: Restrict data access by user: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">-- Multi-tenant data isolation CREATE POLICY tenant_isolation ON :Document FOR ALL TO analyst USING (tenant_id = current_user_property('tenant_id')); </code></pre></div>Enable Audit Logging: Track all database operations: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-yaml" data-lang="yaml"># geode.yaml audit: enabled: true log_queries: true log_auth_events: true output: /var/log/geode/audit.log </code></pre></div> <h4 id="common-mistakes-to-avoid" class="position-relative d-flex align-items-center group"> Common Mistakes to Avoid <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-mistakes-to-avoid" aria-haspopup="dialog" aria-label="Share link: Common Mistakes to Avoid"> Share link </button> </h4>Unbounded Pattern Matching: Always limit variable-length paths: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">-- Dangerous: Could traverse entire graph MATCH path = (a:Person)-[:KNOWS*]->(b:Person) RETURN path -- Safe: Bounded depth MATCH path = (a:Person)-[:KNOWS*1..5]->(b:Person) RETURN path </code></pre></div>N+1 Query Pattern: Fetch related data in single query: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-python" data-lang="python"># Bad: N+1 queries async with client.connection() as conn: users_page, _ = await conn.query("MATCH (u:User) RETURN u.id AS id") for user in users_page.rows: # Separate query for each user's orders orders_page, _ = await conn.query( "MATCH (:User {id: $id})-[:PLACED]->(o:Order) RETURN o", {"id": user["id"].as_string}, ) # Good: Single query result, _ = await conn.query( """ MATCH (u:User)-[:PLACED]->(o:Order) RETURN u.id AS id, COLLECT(o) AS orders """ ) </code></pre></div>Forgetting to Parameterize: Always use parameters to prevent injection: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-python" data-lang="python"># Dangerous: SQL injection equivalent user_email = request.form['email'] query = f"MATCH (u:User {{email: '{user_email}'}}) RETURN u" # DON'T! # Safe: Parameterized result, _ = await client.query( "MATCH (u:User {email: $email}) RETURN u", email=request.form['email'] ) </code></pre></div> <h4 id="scaling-from-development-to-production" class="position-relative d-flex align-items-center group"> Scaling from Development to Production <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="scaling-from-development-to-production" aria-haspopup="dialog" aria-label="Share link: Scaling from Development to Production"> Share link </button> </h4>Development (single instance): <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash">geode serve --data /tmp/geode-dev </code></pre></div>Staging (HA setup): <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-yaml" data-lang="yaml"># docker-compose.yml services: geode-1: image: codepros/geode:v0.2.18 volumes: - geode-data-1:/var/lib/geode geode-2: image: codepros/geode:v0.2.18 volumes: - geode-data-2:/var/lib/geode geode-3: image: codepros/geode:v0.2.18 volumes: - geode-data-3:/var/lib/geode </code></pre></div>Production (cloud-native): <ul> <li>Deploy to Kubernetes with StatefulSets</li> <li>Configure persistent volumes for data</li> <li>Set up automated backups to S3/GCS</li> <li>Enable monitoring with Prometheus</li> <li>Configure auto-scaling based on load</li> <li>Implement disaster recovery procedures</li> </ul> <h4 id="learning-path-recommendations" class="position-relative d-flex align-items-center group"> Learning Path 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="learning-path-recommendations" aria-haspopup="dialog" aria-label="Share link: Learning Path Recommendations"> Share link </button> </h4>Week 1: Master basic CRUD operations, understand nodes and relationships, practice pattern matching Week 2: Learn transactions, implement error handling, understand connection pooling Week 3: Optimize with indexes, profile queries, model your domain effectively Week 4: Implement security features, set up monitoring, configure backups Month 2: Advanced patterns (aggregations, path finding, recommendations), performance tuning, high availability Month 3: Production deployment, disaster recovery, compliance requirements <h3 id="beyond-getting-started" class="position-relative d-flex align-items-center group"> Beyond 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="beyond-getting-started" aria-haspopup="dialog" aria-label="Share link: Beyond Getting Started"> Share link </button> </h3>You now understand Geode fundamentals. Continue your journey: <ul> <li><a href="/tags/query-optimization/" >Query Optimization</a> : Complex pattern matching and optimization</li> <li><a href="/tags/performance/" >Performance Tuning</a> : Maximize throughput and minimize latency</li> <li><a href="/tags/security/" >Security</a> : Enterprise security features</li> <li><a href="/tags/deployment/" >Production Deployment</a> : High availability architectures</li> <li><a href="/tags/monitoring/" >Monitoring</a> : Observability and alerting</li> </ul> Welcome to the Geode community. Happy graph building!

Popular

Related Articles

Getting Started

Overview

Installation and Quick Start

GQL Tutorial

Installation

Tutorials

REPL Interactive Shell Basics