Development Guide

<h2 id="development-guide" class="position-relative d-flex align-items-center group"> Development 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="development-guide" aria-haspopup="dialog" aria-label="Share link: Development 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>This comprehensive guide covers everything developers need to build applications with Geode, from initial setup through testing, debugging, and deployment. Whether you’re building web applications, microservices, or data pipelines, this guide provides the foundation for successful Geode integration. <h3 id="getting-started" class="position-relative d-flex align-items-center group"> 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="getting-started" aria-haspopup="dialog" aria-label="Share link: Getting Started"> 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>System Requirements: <ul> <li>Linux, macOS, or Windows (WSL2)</li> <li>4GB RAM minimum (8GB+ recommended)</li> <li>2GB free disk space</li> <li>Modern compiler toolchain</li> </ul> For Server Development: <ul> <li>Zig 0.1.0+ (for building from source)</li> <li>Git</li> </ul> For Client Development: <ul> <li>Go 1.24+ (for Go client)</li> <li>Python 3.9+ (for Python client)</li> <li>Rust 1.70+ (for Rust client)</li> <li>Node.js 18+ (if building JavaScript client)</li> </ul> <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>Option 1: Docker (Fastest): <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash"># Pull and run Geode docker pull geodedb/geode:latest docker run -d -p 3141:3141 --name geode geodedb/geode:latest # Verify docker logs geode </code></pre></div>Option 2: Build from Source: <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 server ./zig-out/bin/geode serve --listen 127.0.0.1:3141 # In another terminal ./zig-out/bin/geode shell </code></pre></div>Option 3: Package Manager (coming soon): <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash"># Homebrew (macOS/Linux) brew install geodedb/geode/geode # APT (Debian/Ubuntu) sudo apt install geode # Snap (Linux) sudo snap install geode </code></pre></div> <h3 id="development-environment-setup" class="position-relative d-flex align-items-center group"> Development Environment 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="development-environment-setup" aria-haspopup="dialog" aria-label="Share link: Development Environment Setup"> Share link </button> </h3> <h4 id="local-development-server" class="position-relative d-flex align-items-center group"> Local Development Server <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-server" aria-haspopup="dialog" aria-label="Share link: Local Development Server"> Share link </button> </h4>Create a development configuration: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-yaml" data-lang="yaml"># config/dev.yaml server: listen: "127.0.0.1:3141" log_level: "debug" storage: data_dir: "./data/dev" wal_dir: "./data/wal" security: tls_enabled: false # Disable for local dev only performance: query_timeout: 30s max_connections: 100 </code></pre></div>Start server: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash">./geode serve --config config/dev.yaml </code></pre></div> <h4 id="database-shell" class="position-relative d-flex align-items-center group"> Database Shell <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="database-shell" aria-haspopup="dialog" aria-label="Share link: Database Shell"> Share link </button> </h4>The interactive shell is essential for development: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash"># Connect to local server ./geode shell # Or specify remote server ./geode shell --host geode.example.com:3141 </code></pre></div>Shell commands: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">-- Execute queries MATCH (p:Person) RETURN p.name LIMIT 10; -- Show schema SHOW LABELS; SHOW INDEXES; -- Measure timing .timer on MATCH (p:Person)-[:KNOWS*2..3]->(friend) RETURN count(friend); -- Export results .output results.json MATCH (p:Person) RETURN p; -- Help .help </code></pre></div> <h3 id="client-library-integration" class="position-relative d-flex align-items-center group"> Client Library Integration <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="client-library-integration" aria-haspopup="dialog" aria-label="Share link: Client Library Integration"> Share link </button> </h3> <h4 id="go-client" class="position-relative d-flex align-items-center group"> Go 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="go-client" aria-haspopup="dialog" aria-label="Share link: Go Client"> Share link </button> </h4>Installation: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash">go get geodedb.com/geode </code></pre></div>Basic Usage: <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" ) func main() { // Connect db, err := sql.Open("geode", "quic://localhost:3141") if err != nil { log.Fatal(err) } defer db.Close() // Ping to verify connection if err := db.PingContext(context.Background()); err != nil { log.Fatal(err) } // Execute query rows, err := db.QueryContext( context.Background(), "MATCH (p:Person) WHERE p.age > $age RETURN p.name, p.city", sql.Named("age", 30), ) if err != nil { log.Fatal(err) } defer rows.Close() // Process results for rows.Next() { var name, city string if err := rows.Scan(&name, &city); err != nil { log.Fatal(err) } fmt.Printf("%s from %s\n", name, city) } } </code></pre></div>Advanced Features: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go">// Transactions tx, err := db.BeginTx(context.Background(), nil) if err != nil { return err } defer tx.Rollback() _, err = tx.ExecContext(ctx, "INSERT (u:User {name: $name})", sql.Named("name", "Alice")) if err != nil { return err } if err := tx.Commit(); err != nil { return err } // Prepared statements stmt, err := db.PrepareContext(ctx, "MATCH (p:Person {id: $id}) RETURN p.name") defer stmt.Close() for _, id := range userIDs { var name string err := stmt.QueryRowContext(ctx, sql.Named("id", id)).Scan(&name) // ... } </code></pre></div> <h4 id="python-client" class="position-relative d-flex align-items-center group"> Python 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="python-client" aria-haspopup="dialog" aria-label="Share link: Python Client"> Share link </button> </h4>Installation: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash">pip install geode-client </code></pre></div>Basic Usage: <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(): # Connect client = Client(host="localhost", port=3141) async with client.connection() as conn: # Execute query result, _ = await conn.query( "MATCH (p:Person) WHERE p.age > $age RETURN p.name, p.city", parameters={"age": 30} ) # Process results for row in result.rows: print(f"{row['p.name']} from {row['p.city']}") asyncio.run(main()) </code></pre></div>Advanced Features: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-python" data-lang="python"># Transactions async with client.connection() as tx: await tx.begin() await tx.execute( "INSERT (u:User {name: $name})", {"name": "Alice"} ) await tx.execute( "INSERT (u:User {name: $name})", {"name": "Bob"} ) await tx.commit() # Connection pooling client = Client( "localhost:3141", pool_size=20, max_overflow=10 ) # Query builder from geode_client import QueryBuilder query = ( QueryBuilder() .match("(p:Person)") .where("p.age > $age") .return_("p.name", "p.city") .order_by("p.name") .limit(10) ) result, _ = await tx.query(query.build(), {"age": 30}) </code></pre></div> <h4 id="rust-client" class="position-relative d-flex align-items-center group"> Rust 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="rust-client" aria-haspopup="dialog" aria-label="Share link: Rust Client"> Share link </button> </h4>Installation: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-toml" data-lang="toml">[dependencies] geode-client = "0.1" tokio = { version = "1", features = ["full"] } </code></pre></div>Basic Usage: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-rust" data-lang="rust">use geode_client::{Client, Error, Value}; use std::collections::HashMap; #[tokio::main] async fn main() -> Result<(), Error> { // Connect let client = Client::from_dsn("localhost:3141")?; let mut conn = client.connect().await?; // Execute query let mut params = HashMap::new(); params.insert("age".to_string(), Value::int(30)); let (page, _) = conn .query_with_params( "MATCH (p:Person) WHERE p.age > $age RETURN p.name, p.city", &params, ) .await?; // Process results for row in &page.rows { println!( \"{} from {}\", row.get(\"p.name\").unwrap().as_string()?, row.get(\"p.city\").unwrap().as_string()? ); } Ok(()) } </code></pre></div>Advanced Features: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-rust" data-lang="rust">// Transactions use geode_client::Value; use std::collections::HashMap; let mut conn = client.connect().await?; conn.begin().await?; let mut params = HashMap::new(); params.insert("name".to_string(), Value::string("Alice")); conn.query_with_params("CREATE (u:User {name: $name})", &params).await?; conn.commit().await?; // Concurrent queries use futures::future::join_all; let queries: Vec<_> = user_ids.iter().map(|id| { client.query( "MATCH (u:User {id: $id}) RETURN u.name", &[("id", id.into())] ) }).collect(); let results = join_all(queries).await; </code></pre></div> <h3 id="development-workflows" class="position-relative d-flex align-items-center group"> Development Workflows <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-workflows" aria-haspopup="dialog" aria-label="Share link: Development Workflows"> Share link </button> </h3> <h4 id="local-development-loop" class="position-relative d-flex align-items-center group"> Local Development Loop <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-loop" aria-haspopup="dialog" aria-label="Share link: Local Development Loop"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash"># 1. Start Geode in one terminal ./geode serve --config config/dev.yaml # 2. Run application in another terminal # Go go run main.go # Python python app.py # Rust cargo run # 3. Use shell for ad-hoc queries ./geode shell </code></pre></div> <h4 id="hot-reload-for-application-code" class="position-relative d-flex align-items-center group"> Hot Reload (for application code) <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="hot-reload-for-application-code" aria-haspopup="dialog" aria-label="Share link: Hot Reload (for application code)"> Share link </button> </h4>Go with Air: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-yaml" data-lang="yaml"># .air.toml [build] cmd = "go build -o ./tmp/main ." bin = "tmp/main" include_ext = ["go"] exclude_dir = ["tmp", "vendor"] </code></pre></div>Python with watchdog: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-python" data-lang="python"># run_dev.py from watchdog.observers import Observer from watchdog.events import FileSystemEventHandler import subprocess class ChangeHandler(FileSystemEventHandler): def on_modified(self, event): subprocess.run(["python", "app.py"]) observer = Observer() observer.schedule(ChangeHandler(), path='.', recursive=True) observer.start() </code></pre></div> <h4 id="testing-strategy" class="position-relative d-flex align-items-center group"> Testing Strategy <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="testing-strategy" aria-haspopup="dialog" aria-label="Share link: Testing Strategy"> Share link </button> </h4>Unit Tests (test queries in isolation): <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-python" data-lang="python">import pytest from geode_client import Client @pytest.fixture async def client(): client = Client("localhost:3141") async with client.connection() as c: yield c @pytest.mark.asyncio async def test_create_user(client): # Setup await c.query("DELETE (u:User {email: '[email protected]'})") # Execute await c.query( "INSERT (u:User {email: $email, name: $name})", {"email": "[email protected]", "name": "Test User"} ) # Verify result, _ = await c.query( "MATCH (u:User {email: $email}) RETURN u.name", {"email": "[email protected]"} ) rows = [row for row in result.rows] assert len(rows) == 1 assert rows[0]['u.name'] == "Test User" </code></pre></div>Integration Tests (test complete workflows): <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-python" data-lang="python">@pytest.mark.integration async def test_order_creation_workflow(client): # Create test data await tx.query( "INSERT (u:User {id: 'test_user', name: 'Test'})" ) await tx.query( "INSERT (p:Product {id: 'test_prod', price: 99.99})" ) # Execute workflow async with client.connection() as tx: await tx.begin() await tx.execute( "INSERT (o:Order {id: 'test_order', total: 99.99})" ) await tx.execute( "MATCH (u:User {id: 'test_user'}), (o:Order {id: 'test_order'}) " "INSERT (u)-[:PLACED]->(o)" ) await tx.commit() # Verify result, _ = await tx.query( "MATCH (u:User {id: 'test_user'})-[:PLACED]->(o:Order) " "RETURN o.id, o.total" ) rows = [row for row in result.rows] assert len(rows) == 1 assert rows[0]['o.total'] == 99.99 </code></pre></div>Load Tests (test performance): <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-python" data-lang="python">import asyncio from time import time async def load_test(client, num_queries=1000): start = time() tasks = [ client.query("MATCH (p:Person) RETURN p.name LIMIT 1") for _ in range(num_queries) ] results = await asyncio.gather(*tasks) duration = time() - start qps = num_queries / duration print(f"Executed {num_queries} queries in {duration:.2f}s ({qps:.0f} QPS)") </code></pre></div> <h3 id="debugging" class="position-relative d-flex align-items-center group"> Debugging <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="debugging" aria-haspopup="dialog" aria-label="Share link: Debugging"> Share link </button> </h3> <h4 id="enable-debug-logging" class="position-relative d-flex align-items-center group"> Enable Debug Logging <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="enable-debug-logging" aria-haspopup="dialog" aria-label="Share link: Enable Debug Logging"> Share link </button> </h4>Server-side: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-yaml" data-lang="yaml"># config/dev.yaml server: log_level: "debug" </code></pre></div>Client-side (Python): <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-python" data-lang="python">import logging logging.basicConfig(level=logging.DEBUG) # Client will log all queries client = Client("localhost:3141") </code></pre></div> <h4 id="profile-queries" class="position-relative d-flex align-items-center group"> Profile Queries <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="profile-queries" aria-haspopup="dialog" aria-label="Share link: Profile Queries"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">-- Profile query execution PROFILE MATCH (p:Person)-[:KNOWS*2..3]->(friend) WHERE p.city = 'San Francisco' RETURN friend.name; </code></pre></div>Analyze output: <ul> <li>Execution plan</li> <li>Operator costs</li> <li>Index usage</li> <li>Rows processed</li> </ul> <h4 id="monitor-server-metrics" class="position-relative d-flex align-items-center group"> Monitor Server Metrics <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="monitor-server-metrics" aria-haspopup="dialog" aria-label="Share link: Monitor Server Metrics"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash"># Check server logs tail -f /var/log/geode/server.log # Monitor resource usage docker stats geode # Or with native installation top -p $(pidof geode) </code></pre></div> <h4 id="common-issues" class="position-relative d-flex align-items-center group"> 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="common-issues" aria-haspopup="dialog" aria-label="Share link: Common Issues"> Share link </button> </h4>Connection refused: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash"># Check server is running ps aux | grep geode # Check port is open netstat -an | grep 3141 # Check firewall sudo ufw status </code></pre></div>Slow queries: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">-- Check for missing indexes PROFILE MATCH (p:Person {email: $email}) RETURN p; -- If no index used, create one CREATE INDEX person_email ON Person(email); </code></pre></div>Out of memory: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-yaml" data-lang="yaml"># Increase memory limit (config/dev.yaml) performance: max_memory: "4GB" query_memory_limit: "512MB" </code></pre></div> <h3 id="sample-application" class="position-relative d-flex align-items-center group"> Sample Application <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="sample-application" aria-haspopup="dialog" aria-label="Share link: Sample Application"> Share link </button> </h3>Here’s a complete example - a social network API: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-python" data-lang="python"># app.py from fastapi import FastAPI, HTTPException from geode_client import Client from pydantic import BaseModel app = FastAPI() client = Client("localhost:3141", pool_size=20) class User(BaseModel): id: str name: str email: str class Post(BaseModel): id: str user_id: str content: str @app.post("/users") async def create_user(user: User): try: await client.query( "INSERT (u:User {id: $id, name: $name, email: $email})", {"id": user.id, "name": user.name, "email": user.email} ) return {"status": "created", "user": user} except Exception as e: raise HTTPException(status_code=500, detail=str(e)) @app.get("/users/{user_id}/friends") async def get_friends(user_id: str): result, _ = await client.query( "MATCH (u:User {id: $id})-[:FRIENDS_WITH]->(friend:User) " "RETURN friend.id, friend.name", {"id": user_id} ) friends = [ {"id": row['friend.id'], "name": row['friend.name']} for row in result.rows ] return {"friends": friends} @app.get("/users/{user_id}/recommendations") async def get_friend_recommendations(user_id: str): result, _ = await client.query( "MATCH (u:User {id: $id})-[:FRIENDS_WITH]->(f1)-[:FRIENDS_WITH]->(f2) " "WHERE f2 <> u AND NOT EXISTS { MATCH (u)-[:FRIENDS_WITH]->(f2) } " "RETURN f2.id, f2.name, count(f1) AS mutual_friends " "ORDER BY mutual_friends DESC " "LIMIT 10", {"id": user_id} ) recommendations = [ { "id": row['f2.id'], "name": row['f2.name'], "mutual_friends": row['mutual_friends'] } for row in result.rows ] return {"recommendations": recommendations} if __name__ == "__main__": import uvicorn uvicorn.run(app, host="0.0.0.0", port=8000) </code></pre></div>Run: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash"># Install dependencies pip install fastapi uvicorn geode-client # Run application python app.py </code></pre></div>Test: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash"># Create users curl -X POST http://localhost:8000/users \ -H "Content-Type: application/json" \ -d '{"id": "u1", "name": "Alice", "email": "[email protected]"}' # Get friend recommendations curl http://localhost:8000/users/u1/recommendations </code></pre></div> <h3 id="contributing-to-geode" class="position-relative d-flex align-items-center group"> Contributing to 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="contributing-to-geode" aria-haspopup="dialog" aria-label="Share link: Contributing to Geode"> Share link </button> </h3> <h4 id="development-setup" class="position-relative d-flex align-items-center group"> 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="development-setup" aria-haspopup="dialog" aria-label="Share link: Development Setup"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash"># Fork and clone git clone https://gitlab.com/YOUR_USERNAME/geode.git cd geode # Build make build # Run tests make test # Run comprehensive test suite make geodetestlab-comprehensive </code></pre></div> <h4 id="code-style" class="position-relative d-flex align-items-center group"> Code Style <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="code-style" aria-haspopup="dialog" aria-label="Share link: Code Style"> Share link </button> </h4>Follow existing patterns: <ul> <li>Zig: Standard Zig formatting (<code>zig fmt</code>)</li> <li>Go: <code>gofmt</code> and <code>golint</code></li> <li>Python: <code>black</code> and <code>pylint</code></li> <li>Rust: <code>rustfmt</code> and <code>clippy</code></li> </ul> <h4 id="submitting-changes" class="position-relative d-flex align-items-center group"> Submitting Changes <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="submitting-changes" aria-haspopup="dialog" aria-label="Share link: Submitting Changes"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash"># Create feature branch git checkout -b feature/my-feature # Make changes, commit git add . git commit -m "feat: Add new feature" # Push git push origin feature/my-feature # Create merge request on GitLab </code></pre></div> <h3 id="resources" class="position-relative d-flex align-items-center group"> 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="resources" aria-haspopup="dialog" aria-label="Share link: Resources"> Share link </button> </h3> <h4 id="documentation" class="position-relative d-flex align-items-center group"> 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="documentation" aria-haspopup="dialog" aria-label="Share link: Documentation"> Share link </button> </h4><ul> <li>API Reference: <a href="https://geodedb.com/docs/api/" >https://geodedb.com/docs/api/</a> </li> <li>GQL Syntax: <a href="https://geodedb.com/docs/gql/" >https://geodedb.com/docs/gql/</a> </li> <li>Client Libraries: <a href="https://geodedb.com/docs/clients/" >https://geodedb.com/docs/clients/</a> </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>Forum: <a href="https://forum.geodedb.com" aria-label="https://forum.geodedb.com – opens in new window" target="_blank" rel="noopener noreferrer" >https://forum.geodedb.com ↗ </a> </li> <li>Chat: <a href="https://discord.gg/geodedb" aria-label="https://discord.gg/geodedb – opens in new window" target="_blank" rel="noopener noreferrer" >https://discord.gg/geodedb ↗ </a> </li> <li>Issue Tracker: <a href="https://gitlab.com/devnw/codepros/geode/issues" aria-label="https://gitlab.com/devnw/codepros/geode/issues – opens in new window" target="_blank" rel="noopener noreferrer" >https://gitlab.com/devnw/codepros/geode/issues ↗ </a> </li> </ul> <h4 id="examples" class="position-relative d-flex align-items-center group"> Examples <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="examples" aria-haspopup="dialog" aria-label="Share link: Examples"> Share link </button> </h4><ul> <li>Sample Applications: <a href="https://github.com/geodedb/examples" aria-label="https://github.com/geodedb/examples – opens in new window" target="_blank" rel="noopener noreferrer" >https://github.com/geodedb/examples ↗ </a> </li> <li>Client Examples: Each client repo includes examples/</li> <li>Tutorial Series: <a href="https://geodedb.com/tutorials/" >https://geodedb.com/tutorials/</a> </li> </ul> <h3 id="conclusion" class="position-relative d-flex align-items-center group"> Conclusion <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="conclusion" aria-haspopup="dialog" aria-label="Share link: Conclusion"> Share link </button> </h3>This guide provides the foundation for developing applications with Geode. Key takeaways: <ol> <li>Setup: Docker for quick start, build from source for development</li> <li>Client Libraries: Choose Go, Python, Rust, or Zig based on your stack</li> <li>Testing: Comprehensive unit, integration, and load tests</li> <li>Debugging: Use PROFILE, logs, and metrics to diagnose issues</li> <li>Best Practices: Connection pooling, parameterized queries, proper error handling</li> </ol> Explore the documentation for advanced topics, optimization techniques, and deployment strategies. Happy coding!

Popular

Related Articles

GQL Language Server Protocol Implementation Guide

Advanced REPL Features Guide

Development

Governance and Requirements Tracking