Category: Development & Developer Tools

The Development & Developer Tools category encompasses comprehensive resources for building applications with Geode graph database. From initial setup through production deployment, these resources cover the complete development lifecycle with practical guides, API references, and tooling documentation. <h3 id="introduction" class="position-relative d-flex align-items-center group"> Introduction <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="introduction" aria-haspopup="dialog" aria-label="Share link: Introduction"> Share link </button> </h3><div id="headingShareModal" class="heading-share-modal" role="dialog" aria-modal="true" aria-labelledby="headingShareTitle" hidden> <div class="hsm-dialog" role="document"> <div class="hsm-header"> <h2 id="headingShareTitle" class="h6 mb-0 fw-bold">Share this section</h2> <button type="button" class="hsm-close" aria-label="Close"> </button> </div> <div class="hsm-body"> <label for="headingShareInput" class="form-label small text-muted mb-1 text-uppercase fw-bold" style="font-size: 0.7rem; letter-spacing: 0.5px;">Permalink</label> <div class="input-group mb-4 hsm-url-group"> <input id="headingShareInput" type="text" class="form-control font-monospace" readonly aria-readonly="true" style="font-size: 0.85rem;" /> <button class="btn btn-primary hsm-copy" type="button" aria-label="Copy" title="Copy"> </button> </div> <div class="small fw-bold mb-2 text-muted text-uppercase" style="font-size: 0.7rem; letter-spacing: 0.5px;">Share via</div> <div class="hsm-share-grid"> <a id="share-twitter" class="btn btn-outline-secondary w-100" target="_blank" rel="noopener noreferrer"> Twitter </a> <a id="share-linkedin" class="btn btn-outline-secondary w-100" target="_blank" rel="noopener noreferrer"> LinkedIn </a> <a id="share-facebook" class="btn btn-outline-secondary w-100" target="_blank" rel="noopener noreferrer"> Facebook </a> </div> </div> </div> </div> <style> .heading-share-modal { position: fixed; inset: 0; display: flex; justify-content: center; align-items: center; background: rgba(0, 0, 0, 0.6); z-index: 1050; padding: 1rem; backdrop-filter: blur(4px); -webkit-backdrop-filter: blur(4px); } .heading-share-modal[hidden] { display: none !important; } .hsm-dialog { max-width: 420px; width: 100%; background: var(--bs-body-bg, #fff); color: var(--bs-body-color, #212529); border: 1px solid var(--bs-border-color, rgba(0,0,0,0.1)); border-radius: 1rem; box-shadow: 0 25px 50px -12px rgba(0, 0, 0, 0.25); overflow: hidden; animation: hsm-fade-in 0.2s ease-out; } @keyframes hsm-fade-in { from { opacity: 0; transform: scale(0.95); } to { opacity: 1; transform: scale(1); } } [data-bs-theme="dark"] .hsm-dialog { background: #1e293b; border-color: rgba(255,255,255,0.1); color: #f8f9fa; } .hsm-header { display: flex; justify-content: space-between; align-items: center; padding: 1rem 1.5rem; border-bottom: 1px solid var(--bs-border-color, rgba(0,0,0,0.1)); background: rgba(0,0,0,0.02); } [data-bs-theme="dark"] .hsm-header { background: rgba(255,255,255,0.02); border-color: rgba(255,255,255,0.1); } .hsm-close { background: transparent; border: none; color: inherit; opacity: 0.5; padding: 0.25rem 0.5rem; border-radius: 0.25rem; font-size: 1.2rem; line-height: 1; transition: opacity 0.2s; } .hsm-close:hover { opacity: 1; } .hsm-body { padding: 1.5rem; } .hsm-url-group { display: flex !important; align-items: stretch; } .hsm-url-group .form-control { flex: 1; min-width: 0; margin: 0; background: var(--bs-secondary-bg, #f8f9fa); border-color: var(--bs-border-color, #dee2e6); border-top-right-radius: 0; border-bottom-right-radius: 0; height: 42px; } .hsm-url-group .btn { flex: 0 0 auto; margin: 0; margin-left: -1px; border-top-left-radius: 0; border-bottom-left-radius: 0; height: 42px; display: flex; align-items: center; justify-content: center; padding: 0 1.25rem; z-index: 2; } [data-bs-theme="dark"] .hsm-url-group .form-control { background: #0f172a; border-color: #334155; color: #e2e8f0; } .hsm-share-grid { display: flex; flex-direction: column; gap: 0.5rem; } .hsm-share-grid .btn { display: flex; align-items: center; justify-content: center; font-size: 0.9rem; padding: 0.6rem; border-color: var(--bs-border-color); width: 100%; } [data-bs-theme="dark"] .hsm-share-grid .btn { color: #e2e8f0; border-color: #475569; } [data-bs-theme="dark"] .hsm-share-grid .btn:hover { background: #334155; border-color: #cbd5e1; } </style> <script> (function(){ const modal = document.getElementById('headingShareModal'); if(!modal) return; const input = modal.querySelector('#headingShareInput'); const copyBtn = modal.querySelector('.hsm-copy'); const twitter = modal.querySelector('#share-twitter'); const linkedin = modal.querySelector('#share-linkedin'); const facebook = modal.querySelector('#share-facebook'); const closeBtn = modal.querySelector('.hsm-close'); let lastFocus=null; let trapBound=false; function buildUrl(id){ return window.location.origin + window.location.pathname + '#' + id; } function isOpen(){ return !modal.hasAttribute('hidden'); } function hydrate(id){ const url=buildUrl(id); input.value=url; const enc=encodeURIComponent(url); const text=encodeURIComponent(document.title); if(twitter) twitter.href=`https://twitter.com/intent/tweet?url=${enc}&text=${text}`; if(linkedin) linkedin.href=`https://www.linkedin.com/sharing/share-offsite/?url=${enc}`; if(facebook) facebook.href=`https://www.facebook.com/sharer/sharer.php?u=${enc}`; } function openModal(id){ lastFocus=document.activeElement; hydrate(id); if(!isOpen()){ modal.removeAttribute('hidden'); } requestAnimationFrame(()=>{ input.focus(); }); trapFocus(); } function closeModal(){ if(!isOpen()) return; modal.setAttribute('hidden',''); if(lastFocus && typeof lastFocus.focus==='function') lastFocus.focus(); } function copyCurrent(){ try{ navigator.clipboard.writeText(input.value).then(()=>feedback(true),()=>fallback()); } catch(e){ fallback(); } } function fallback(){ input.select(); try{ document.execCommand('copy'); feedback(true);}catch(e){ feedback(false);} } function feedback(ok){ if(!copyBtn) return; const icon=copyBtn.querySelector('i'); if(!icon) return; const prev=copyBtn.getAttribute('data-prev')||icon.className; if(!copyBtn.getAttribute('data-prev')) copyBtn.setAttribute('data-prev',prev); icon.className= ok ? 'fa-duotone fa-clipboard-check':'fa-duotone fa-circle-exclamation'; setTimeout(()=>{ icon.className=prev; },1800); } function handleShareClick(e){ e.preventDefault(); const btn=e.currentTarget; const id=btn.getAttribute('data-share-target'); if(id) openModal(id); } function bindShareButtons(){ document.querySelectorAll('.h-share').forEach(btn=>{ if(!btn.dataset.hShareBound){ btn.addEventListener('click', handleShareClick); btn.dataset.hShareBound='1'; } }); } bindShareButtons(); if(document.readyState==='loading'){ document.addEventListener('DOMContentLoaded', bindShareButtons); } else { requestAnimationFrame(bindShareButtons); } document.addEventListener('click', function(e){ const shareBtn=e.target.closest && e.target.closest('.h-share'); if(shareBtn && !shareBtn.dataset.hShareBound){ handleShareClick.call(shareBtn, e); } }, true); document.addEventListener('click', e=>{ if(e.target===modal) closeModal(); if(e.target.closest && e.target.closest('.hsm-close')){ e.preventDefault(); closeModal(); } if(copyBtn && (e.target===copyBtn || (e.target.closest && e.target.closest('.hsm-copy')))) { e.preventDefault(); copyCurrent(); } }); document.addEventListener('keydown', e=>{ if(e.key==='Escape' && isOpen()) closeModal(); }); function trapFocus(){ if(trapBound) return; trapBound=true; modal.addEventListener('keydown', f=>{ if(f.key==='Tab' && isOpen()){ const focusable=[...modal.querySelectorAll('a[href],button,input,textarea,select,[tabindex]:not([tabindex="-1"])')].filter(el=>!el.hasAttribute('disabled')); if(!focusable.length) return; const first=focusable[0]; const last=focusable[focusable.length-1]; if(f.shiftKey && document.activeElement===first){ f.preventDefault(); last.focus(); } else if(!f.shiftKey && document.activeElement===last){ f.preventDefault(); first.focus(); } } }); } if(closeBtn) closeBtn.addEventListener('click', e=>{ e.preventDefault(); closeModal(); }); })(); </script>Modern database development requires more than just query capabilities—developers need rich tooling, intuitive APIs, and streamlined workflows. Geode provides a complete development ecosystem designed for productivity and ease of use. The REPL shell enables interactive query development with syntax highlighting and auto-completion. Client libraries for Go, Python, Rust, Node.js, and Zig offer idiomatic APIs for each language. LSP integration brings IDE features like error checking and go-to-definition to any editor. CLI tools automate common tasks from schema management to deployment. This category documents the full development experience, from writing your first query in the REPL to building production applications with client libraries. Whether you’re prototyping a new feature, debugging a complex query, or optimizing application performance, these resources provide the knowledge and tools you need. Topics span programming language integrations, development workflows, testing strategies, debugging techniques, and operational best practices. <h3 id="what-youll-find" class="position-relative d-flex align-items-center group"> What You&rsquo;ll Find <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-youll-find" aria-haspopup="dialog" aria-label="Share link: What Youll Find"> Share link </button> </h3> <h4 id="development-tools" class="position-relative d-flex align-items-center group"> Development Tools <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-tools" aria-haspopup="dialog" aria-label="Share link: Development Tools"> Share link </button> </h4>Interactive Shell (REPL) <ul> <li>Interactive query development with immediate feedback</li> <li>Syntax highlighting and auto-completion</li> <li>Multi-line editing for complex queries</li> <li>Transaction management and session persistence</li> <li>Query profiling and execution plan analysis</li> <li>Meta-commands for database introspection</li> <li>History search and command recall</li> <li>Result formatting and export</li> </ul> CLI Tools <ul> <li>Database server management (<code>geode serve</code>)</li> <li>Interactive shell access (<code>geode shell</code>)</li> <li>Schema management and migrations</li> <li>Backup and restore operations</li> <li>Performance monitoring and diagnostics</li> <li>Configuration management</li> <li>Deployment automation</li> <li>Testing and validation tools</li> </ul> Language Server Protocol (LSP) <ul> <li>IDE integration for VS Code, Vim, Emacs, and others</li> <li>Real-time syntax validation and error checking</li> <li>Context-aware auto-completion</li> <li>Hover documentation and tooltips</li> <li>Go-to-definition navigation</li> <li>Find references and symbols</li> <li>Code formatting and refactoring</li> <li>Schema-aware suggestions</li> </ul> <h4 id="client-libraries" class="position-relative d-flex align-items-center group"> Client Libraries <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-libraries" aria-haspopup="dialog" aria-label="Share link: Client Libraries"> Share link </button> </h4>Official SDKs <ul> <li>Go Client: <code>database/sql</code> driver with connection pooling</li> <li>Python Client: Async client with aioquic and connection pooling</li> <li>Rust Client: Tokio-based high-performance client</li> <li>Zig Client: Native Zig implementation with vendored QUIC</li> </ul> Common Features <ul> <li>QUIC + TLS 1.3 transport protocol</li> <li>Connection pooling and management</li> <li>Prepared statement support</li> <li>Transaction management with savepoints</li> <li>Streaming result sets for large queries</li> <li>Parametrized queries for SQL injection prevention</li> <li>Error handling with GQL status codes</li> <li>Type-safe value marshaling</li> </ul> <h4 id="api-and-protocol" class="position-relative d-flex align-items-center group"> API and Protocol <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="api-and-protocol" aria-haspopup="dialog" aria-label="Share link: API and Protocol"> Share link </button> </h4>GQL Query API <ul> <li>ISO/IEC 39075:2024 compliant query language</li> <li>Pattern matching with ASCII-art syntax</li> <li>CRUD operations (INSERT, UPDATE, DELETE)</li> <li>Aggregations and subqueries</li> <li>Path queries and graph algorithms</li> <li>Transaction control (BEGIN, COMMIT, ROLLBACK)</li> <li>Prepared statements and parameter binding</li> </ul> Wire Protocol <ul> <li>Protobuf wire protocol over QUIC (default) or gRPC</li> <li>Multiplexed streams for concurrent queries</li> <li>Request types: <code>HelloRequest</code>, <code>ExecuteRequest</code>, <code>PullRequest</code>, <code>BeginRequest</code>, <code>CommitRequest</code></li> <li>Response type: <code>ExecutionResponse</code> (payloads: <code>SchemaDefinition</code>, <code>DataPage</code>, <code>Error</code>, <code>ExplainPayload</code>, <code>ProfilePayload</code>)</li> <li>Streaming results with flow control</li> <li>Connection migration support</li> <li>0-RTT resumption for low latency</li> </ul> <h4 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> </h4>Local Development <ul> <li>Quick start with Docker or binary installation</li> <li>REPL-driven query development</li> <li>Schema design and iteration</li> <li>Test data generation and seeding</li> <li>Local debugging with profiling tools</li> <li>Integration testing with testcontainers</li> </ul> CI/CD Integration <ul> <li>Automated testing in CI pipelines</li> <li>Schema migration automation</li> <li>Performance regression testing</li> <li>Deployment to staging and production</li> <li>Rollback strategies and blue-green deployments</li> <li>Monitoring and observability integration</li> </ul> Debugging and Profiling <ul> <li>EXPLAIN for query execution plans</li> <li>PROFILE for performance analysis</li> <li>Query tracing and logging</li> <li>Connection debugging</li> <li>Performance bottleneck identification</li> <li>Memory and CPU profiling</li> </ul> <h3 id="use-cases-with-code-examples" class="position-relative d-flex align-items-center group"> Use Cases with Code 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="use-cases-with-code-examples" aria-haspopup="dialog" aria-label="Share link: Use Cases with Code Examples"> Share link </button> </h3> <h4 id="rapid-prototyping-with-repl" class="position-relative d-flex align-items-center group"> Rapid Prototyping with REPL <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="rapid-prototyping-with-repl" aria-haspopup="dialog" aria-label="Share link: Rapid Prototyping with REPL"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash"># Start interactive shell geode shell # Explore existing data geode> MATCH (n) RETURN DISTINCT labels(n), count(*); # Test query patterns geode> MATCH (p:Person)-[:KNOWS]->(f:Person) WHERE p.age > 30 RETURN p.name, collect(f.name) AS friends; # Profile for performance geode> \profile MATCH (p:Person)-[:KNOWS*2]-(friend) WHERE p.name = 'Alice' RETURN DISTINCT friend.name; # Save successful queries geode> \save queries/social_network.gql </code></pre></div> <h4 id="building-applications-with-client-libraries" class="position-relative d-flex align-items-center group"> Building Applications with Client Libraries <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="building-applications-with-client-libraries" aria-haspopup="dialog" aria-label="Share link: Building Applications with Client Libraries"> Share link </button> </h4>Python Example <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-python" data-lang="python">import geode_client import asyncio async def get_user_recommendations(user_id: int, limit: int = 10): """Get product recommendations for a user.""" client = geode_client.open_database('quic://localhost:3141') async with client.connection() as conn: query = """ MATCH (user:User {id: $user_id})-[:PURCHASED]->(product:Product) <-[:PURCHASED]-(similar:User)-[:PURCHASED]->(rec:Product) WHERE NOT EXISTS { MATCH (user)-[:PURCHASED]->(rec) } RETURN rec.name AS product, rec.price AS price, COUNT(similar) AS score ORDER BY score DESC, rec.rating DESC LIMIT $limit """ result, _ = await conn.query(query, { 'user_id': user_id, 'limit': limit }) recommendations = [] for row in result.rows: recommendations.append({ 'product': row['product'], 'price': row['price'], 'score': row['score'] }) return recommendations # Use in application recommendations = asyncio.run(get_user_recommendations(12345)) for rec in recommendations: print(f"{rec['product']}: ${rec['price']} (score: {rec['score']})") </code></pre></div>Go Example <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go">package main import ( "context" "database/sql" "log" _ "geodedb.com/geode" ) type Product struct { Name string Price float64 Score int } func GetRecommendations(userID int, limit int) ([]Product, error) { db, err := sql.Open("geode", "quic://localhost:3141") if err != nil { return nil, err } defer db.Close() query := ` MATCH (user:User {id: $1})-[:PURCHASED]->(product:Product) <-[:PURCHASED]-(similar:User)-[:PURCHASED]->(rec:Product) WHERE NOT EXISTS { MATCH (user)-[:PURCHASED]->(rec) } RETURN rec.name, rec.price, COUNT(similar) AS score ORDER BY score DESC, rec.rating DESC LIMIT $2 ` rows, err := db.QueryContext(context.Background(), query, userID, limit) if err != nil { return nil, err } defer rows.Close() var products []Product for rows.Next() { var p Product if err := rows.Scan(&p.Name, &p.Price, &p.Score); err != nil { return nil, err } products = append(products, p) } return products, rows.Err() } func main() { recommendations, err := GetRecommendations(12345, 10) if err != nil { log.Fatal(err) } for _, rec := range recommendations { log.Printf("%s: $%.2f (score: %d)", rec.Name, rec.Price, rec.Score) } } </code></pre></div> <h4 id="ide-integration-with-lsp" class="position-relative d-flex align-items-center group"> IDE Integration with LSP <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="ide-integration-with-lsp" aria-haspopup="dialog" aria-label="Share link: IDE Integration with LSP"> Share link </button> </h4>VS Code Configuration <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-json" data-lang="json">{ "gql.server.host": "localhost", "gql.server.port": 3141, "gql.validation.enabled": true, "gql.completion.autoComplete": true, "gql.format.enable": true, "gql.hover.documentation": true, "editor.formatOnSave": true, "files.associations": { "*.gql": "gql" } } </code></pre></div>Query Development with LSP <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">-- Full IDE support: auto-completion, error checking, go-to-definition MATCH (p:Person)-[:WORKS_AT]->(c:Company) WHERE p.age > $minAge AND c.industry = $industry RETURN p.name AS employee, c.name AS company, p.salary AS salary ORDER BY p.salary DESC LIMIT $limit </code></pre></div> <h4 id="automated-testing" class="position-relative d-flex align-items-center group"> Automated Testing <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="automated-testing" aria-haspopup="dialog" aria-label="Share link: Automated Testing"> Share link </button> </h4>Python Testing Example <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-python" data-lang="python">import pytest import geode_client @pytest.fixture async def db(): """Provide test database connection.""" client = geode_client.open_database('quic://localhost:3141') async with client.connection() as conn: # Setup: Create test data await conn.execute(""" INSERT (:Person {id: 1, name: 'Alice', age: 30}), (:Person {id: 2, name: 'Bob', age: 25}), (:Person {id: 1})-[:KNOWS]->(:Person {id: 2}) """) yield conn # Teardown: Clean up test data await conn.execute("MATCH (n:Person) DELETE n") @pytest.mark.asyncio async def test_friend_recommendation(db): """Test friend recommendation query.""" result, _ = await db.query(""" MATCH (p:Person {id: 1})-[:KNOWS]->()-[:KNOWS]->(foaf:Person) WHERE NOT EXISTS { MATCH (p)-[:KNOWS]->(foaf) } RETURN foaf.name AS recommended_friend """) friends = [row['recommended_friend'] for row in result.rows] assert len(friends) > 0 </code></pre></div> <h3 id="best-practices" class="position-relative d-flex align-items-center group"> Best Practices <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="best-practices" aria-haspopup="dialog" aria-label="Share link: Best Practices"> Share link </button> </h3> <h4 id="development-workflow" class="position-relative d-flex align-items-center group"> Development Workflow <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="development-workflow" aria-haspopup="dialog" aria-label="Share link: Development Workflow"> Share link </button> </h4><ol> <li>REPL-First Development: Use REPL for query prototyping</li> <li>Version Control: Track queries and schema in Git</li> <li>Schema Migrations: Use versioned migration scripts</li> <li>Environment Parity: Keep dev/staging/prod schemas aligned</li> <li>Code Reviews: Review GQL queries like application code</li> </ol> <h4 id="api-usage" class="position-relative d-flex align-items-center group"> API Usage <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="api-usage" aria-haspopup="dialog" aria-label="Share link: API Usage"> Share link </button> </h4><ol> <li>Connection Pooling: Reuse connections for better performance</li> <li>Prepared Statements: Use parameterized queries for security</li> <li>Error Handling: Catch and handle GQL-specific errors</li> <li>Transaction Boundaries: Keep transactions short and focused</li> <li>Result Streaming: Stream large result sets to conserve memory</li> </ol> <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><ol> <li>Unit Tests: Test query logic with test data</li> <li>Integration Tests: Test against real database</li> <li>Performance Tests: Benchmark critical queries</li> <li>Schema Tests: Validate schema integrity</li> <li>Regression Tests: Prevent performance regressions</li> </ol> <h4 id="debugging-techniques" class="position-relative d-flex align-items-center group"> Debugging Techniques <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-techniques" aria-haspopup="dialog" aria-label="Share link: Debugging Techniques"> Share link </button> </h4><ol> <li>EXPLAIN Queries: Understand execution plans</li> <li>PROFILE Queries: Measure actual performance</li> <li>Logging: Enable query logging in development</li> <li>Tracing: Use distributed tracing for debugging</li> <li>Monitoring: Watch query metrics in production</li> </ol> <h3 id="related-categories" class="position-relative d-flex align-items-center group"> Related Categories <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-categories" aria-haspopup="dialog" aria-label="Share link: Related Categories"> Share link </button> </h3><ul> <li><a href="/categories/tutorials/" >Tutorials</a> - Step-by-step learning guides</li> <li><a href="/categories/query-language/" >Query Language</a> - GQL reference and examples</li> <li><a href="/categories/client-libraries/" >Client Libraries</a> - SDK documentation</li> <li><a href="/categories/reference/" >Reference</a> - API and protocol reference</li> <li><a href="/categories/best-practices/" >Best Practices</a> - Development guidelines</li> </ul> <h3 id="related-tags" class="position-relative d-flex align-items-center group"> Related Tags <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-tags" aria-haspopup="dialog" aria-label="Share link: Related Tags"> Share link </button> </h3><ul> <li><a href="/tags/repl/" >REPL</a> - Interactive shell</li> <li><a href="/tags/cli/" >CLI</a> - Command-line tools</li> <li><a href="/tags/lsp/" >LSP</a> - Language Server Protocol</li> <li><a href="/tags/api/" >API</a> - API documentation</li> <li><a href="/tags/gql/" >GQL</a> - Graph Query Language</li> <li><a href="/tags/tools/" >Tools</a> - Development tooling</li> <li><a href="/tags/debugging/" >Debugging</a> - Debugging techniques</li> <li><a href="/tags/testing/" >Testing</a> - Testing strategies</li> </ul> <h3 id="advanced-development-patterns" class="position-relative d-flex align-items-center group"> Advanced Development 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="advanced-development-patterns" aria-haspopup="dialog" aria-label="Share link: Advanced Development Patterns"> Share link </button> </h3> <h4 id="connection-pool-management" class="position-relative d-flex align-items-center group"> Connection Pool Management <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-management" aria-haspopup="dialog" aria-label="Share link: Connection Pool Management"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-python" data-lang="python">import geode_client from contextlib import asynccontextmanager class DatabasePool: """Production-ready connection pool.""" def __init__(self, url, min_size=5, max_size=20): self.url = url self.min_size = min_size self.max_size = max_size self._pool = None async def initialize(self): """Initialize connection pool.""" self._pool = await geode_client.create_pool( self.url, min_size=self.min_size, max_size=self.max_size, timeout=30, idle_timeout=300 ) @asynccontextmanager async def acquire(self): """Acquire connection from pool.""" async with self._pool.acquire() as conn: try: yield conn except Exception as e: # Log error with context logger.error(f"Database error: {e}", exc_info=True) raise async def close(self): """Close all pool connections.""" await self._pool.close() # Usage pool = DatabasePool("quic://localhost:3141") await pool.initialize() async with pool.acquire() as conn: result, _ = await conn.query("MATCH (n) RETURN count(n)") </code></pre></div> <h4 id="query-builder-pattern" class="position-relative d-flex align-items-center group"> Query Builder Pattern <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="query-builder-pattern" aria-haspopup="dialog" aria-label="Share link: Query Builder Pattern"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-python" data-lang="python">class GQLQueryBuilder: """Fluent API for building GQL queries.""" def __init__(self): self.match_clauses = [] self.where_conditions = [] self.return_expressions = [] self.order_by = [] self.limit_value = None self.params = {} def match(self, pattern, **kwargs): """Add MATCH clause.""" self.match_clauses.append(pattern) self.params.update(kwargs) return self def where(self, condition): """Add WHERE condition.""" self.where_conditions.append(condition) return self def return_(self, *expressions): """Add RETURN expressions.""" self.return_expressions.extend(expressions) return self def order_by_desc(self, field): """Add ORDER BY DESC.""" self.order_by.append(f"{field} DESC") return self def limit(self, count): """Add LIMIT.""" self.limit_value = count return self def build(self): """Build final query string.""" parts = [] # MATCH for clause in self.match_clauses: parts.append(f"MATCH {clause}") # WHERE if self.where_conditions: parts.append("WHERE " + " AND ".join(self.where_conditions)) # RETURN if self.return_expressions: parts.append("RETURN " + ", ".join(self.return_expressions)) # ORDER BY if self.order_by: parts.append("ORDER BY " + ", ".join(self.order_by)) # LIMIT if self.limit_value: parts.append(f"LIMIT {self.limit_value}") return "\n".join(parts) # Usage query = (GQLQueryBuilder() .match("(u:User)-[:POSTED]->(p:Post)", user_id=123) .where("u.id = $user_id") .where("p.created > $min_date") .return_("p.title", "p.created") .order_by_desc("p.created") .limit(10) .build()) print(query) # Output: # MATCH (u:User)-[:POSTED]->(p:Post) # WHERE u.id = $user_id AND p.created > $min_date # RETURN p.title, p.created # ORDER BY p.created DESC # LIMIT 10 </code></pre></div> <h4 id="repository-pattern" class="position-relative d-flex align-items-center group"> Repository Pattern <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="repository-pattern" aria-haspopup="dialog" aria-label="Share link: Repository Pattern"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-python" data-lang="python">from abc import ABC, abstractmethod from typing import Optional, List class Repository(ABC): """Base repository interface.""" @abstractmethod async def find_by_id(self, id: int): pass @abstractmethod async def find_all(self) -> List: pass @abstractmethod async def save(self, entity): pass @abstractmethod async def delete(self, id: int): pass class UserRepository(Repository): """User-specific repository implementation.""" def __init__(self, pool): self.pool = pool async def find_by_id(self, user_id: int) -> Optional[dict]: """Find user by ID.""" async with self.pool.acquire() as conn: result, _ = await conn.query(""" MATCH (u:User {id: $id}) RETURN u.id AS id, u.name AS name, u.email AS email, u.created AS created """, {"id": user_id}) return result.rows[0] if result.rows else None async def find_by_email(self, email: str) -> Optional[dict]: """Find user by email.""" async with self.pool.acquire() as conn: result, _ = await conn.query(""" MATCH (u:User {email: $email}) RETURN u.id AS id, u.name AS name, u.email AS email """, {"email": email}) return result.rows[0] if result.rows else None async def find_all(self) -> List[dict]: """Get all users.""" async with self.pool.acquire() as conn: result, _ = await conn.query(""" MATCH (u:User) RETURN u.id AS id, u.name AS name, u.email AS email ORDER BY u.created DESC """) return [row for row in result.rows] async def save(self, user: dict): """Create or update user.""" async with self.pool.acquire() as conn: await conn.execute(""" MERGE (u:User {email: $email}) SET u.name = $name, u.updated = current_timestamp() ON CREATE SET u.created = current_timestamp() """, user) async def delete(self, user_id: int): """Delete user.""" async with self.pool.acquire() as conn: await conn.execute(""" MATCH (u:User {id: $id}) DETACH DELETE u """, {"id": user_id}) # Usage user_repo = UserRepository(pool) user = await user_repo.find_by_email("[email protected]") </code></pre></div> <h4 id="error-handling-strategies" class="position-relative d-flex align-items-center group"> Error Handling Strategies <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-strategies" aria-haspopup="dialog" aria-label="Share link: Error Handling Strategies"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-python" data-lang="python">from enum import Enum from typing import Optional import logging class GeodeErrorCode(Enum): """GQL error codes.""" CONSTRAINT_VIOLATION = "22000" QUERY_TIMEOUT = "57014" SERIALIZATION_FAILURE = "40001" DEADLOCK = "40P01" class RetryableError(Exception): """Error that should trigger retry.""" pass class PermanentError(Exception): """Error that should not be retried.""" pass async def execute_with_retry(func, max_retries=3, backoff_factor=2): """Execute function with exponential backoff retry.""" for attempt in range(max_retries): try: return await func() except geode_client.QueryError as e: error_code = e.code # Check if error is retryable if error_code in [GeodeErrorCode.SERIALIZATION_FAILURE.value, GeodeErrorCode.DEADLOCK.value]: if attempt < max_retries - 1: wait_time = backoff_factor ** attempt logging.warning(f"Retrying after {wait_time}s due to: {e}") await asyncio.sleep(wait_time) continue else: raise RetryableError(f"Max retries exceeded: {e}") else: # Permanent error, don't retry raise PermanentError(f"Permanent error: {e}") # Usage async def transfer_money(from_id, to_id, amount): async with pool.acquire() as conn: async with conn.connection() as tx: await tx.begin() await tx.execute(""" MATCH (from:Account {id: $from_id}) SET from.balance = from.balance - $amount """, {"from_id": from_id, "amount": amount}) await tx.execute(""" MATCH (to:Account {id: $to_id}) SET to.balance = to.balance + $amount """, {"to_id": to_id, "amount": amount}) await tx.commit() # Execute with retry await execute_with_retry(lambda: transfer_money(1, 2, 100.0)) </code></pre></div> <h3 id="performance-monitoring" class="position-relative d-flex align-items-center group"> Performance Monitoring <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-monitoring" aria-haspopup="dialog" aria-label="Share link: Performance Monitoring"> Share link </button> </h3> <h4 id="query-performance-tracking" class="position-relative d-flex align-items-center group"> Query Performance Tracking <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="query-performance-tracking" aria-haspopup="dialog" aria-label="Share link: Query Performance Tracking"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-python" data-lang="python">import time from functools import wraps import prometheus_client # Prometheus metrics query_duration = prometheus_client.Histogram( 'geode_query_duration_seconds', 'Query execution time', ['query_type'] ) query_counter = prometheus_client.Counter( 'geode_queries_total', 'Total queries executed', ['query_type', 'status'] ) def track_query_performance(query_type: str): """Decorator to track query performance.""" def decorator(func): @wraps(func) async def wrapper(*args, **kwargs): start_time = time.perf_counter() status = 'success' try: result = await func(*args, **kwargs) return result except Exception as e: status = 'error' raise finally: duration = time.perf_counter() - start_time query_duration.labels(query_type=query_type).observe(duration) query_counter.labels(query_type=query_type, status=status).inc() return wrapper return decorator # Usage @track_query_performance('user_lookup') async def find_user(email: str): async with pool.acquire() as conn: return await conn.execute(""" MATCH (u:User {email: $email}) RETURN u """, {"email": email}) </code></pre></div> <h4 id="slow-query-logging" class="position-relative d-flex align-items-center group"> Slow Query 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="slow-query-logging" aria-haspopup="dialog" aria-label="Share link: Slow Query Logging"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-python" data-lang="python">class SlowQueryLogger: """Log queries exceeding threshold.""" def __init__(self, threshold_ms=1000): self.threshold_ms = threshold_ms async def execute(self, conn, query, params=None): """Execute query with timing.""" start = time.perf_counter() try: result, _ = await conn.query(query, params) return result finally: duration_ms = (time.perf_counter() - start) * 1000 if duration_ms > self.threshold_ms: logging.warning( f"Slow query ({duration_ms:.2f}ms): {query[:100]}...", extra={ 'duration_ms': duration_ms, 'query': query, 'params': params } ) # Usage logger = SlowQueryLogger(threshold_ms=500) async with pool.acquire() as conn: result, _ = await logger.query(conn, "MATCH (n) RETURN count(n)") </code></pre></div> <h3 id="code-generation-and-scaffolding" class="position-relative d-flex align-items-center group"> Code Generation and Scaffolding <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-generation-and-scaffolding" aria-haspopup="dialog" aria-label="Share link: Code Generation and Scaffolding"> Share link </button> </h3> <h4 id="schema-to-code-generator" class="position-relative d-flex align-items-center group"> Schema-to-Code Generator <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="schema-to-code-generator" aria-haspopup="dialog" aria-label="Share link: Schema-to-Code Generator"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-python" data-lang="python">def generate_model_class(label: str, properties: dict): """Generate Python dataclass from graph schema.""" lines = [ "from dataclasses import dataclass", "from datetime import datetime", "from typing import Optional", "", "@dataclass", f"class {label}:" ] for prop_name, prop_type in properties.items(): python_type = { 'string': 'str', 'integer': 'int', 'float': 'float', 'boolean': 'bool', 'datetime': 'datetime' }.get(prop_type, 'str') lines.append(f" {prop_name}: Optional[{python_type}] = None") return "\n".join(lines) # Generate from schema schema = { 'User': { 'id': 'integer', 'name': 'string', 'email': 'string', 'created': 'datetime' } } for label, properties in schema.items(): code = generate_model_class(label, properties) print(code) </code></pre></div> <h3 id="continuous-integration-examples" class="position-relative d-flex align-items-center group"> Continuous Integration 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="continuous-integration-examples" aria-haspopup="dialog" aria-label="Share link: Continuous Integration Examples"> Share link </button> </h3> <h4 id="github-actions-workflow" class="position-relative d-flex align-items-center group"> GitHub Actions Workflow <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="github-actions-workflow" aria-haspopup="dialog" aria-label="Share link: GitHub Actions Workflow"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-yaml" data-lang="yaml">name: Geode Integration Tests on: [push, pull_request] jobs: test: runs-on: ubuntu-latest services: geode: image: codepros/geode:latest ports: - 3141:3141 options: >- --health-cmd "geode ping" --health-interval 10s --health-timeout 5s --health-retries 5 steps: - uses: actions/checkout@v3 - name: Set up Python uses: actions/setup-python@v4 with: python-version: '3.11' - name: Install dependencies run: | pip install -r requirements.txt pip install pytest pytest-asyncio - name: Wait for Geode run: | timeout 30 sh -c 'until geode ping; do sleep 1; done' - name: Run tests env: GEODE_URL: quic://localhost:3141 run: pytest tests/ - name: Upload coverage uses: codecov/codecov-action@v3 </code></pre></div> <h4 id="docker-compose-for-development" class="position-relative d-flex align-items-center group"> Docker Compose for Development <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="docker-compose-for-development" aria-haspopup="dialog" aria-label="Share link: Docker Compose for Development"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-yaml" data-lang="yaml">version: '3.8' services: geode: image: codepros/geode:v0.2.18 ports: - "3141:3141" volumes: - geode-data:/var/lib/geode environment: - GEODE_LOG_LEVEL=debug healthcheck: test: ["CMD", "geode", "ping"] interval: 10s timeout: 5s retries: 3 prometheus: image: prom/prometheus:latest ports: - "9090:9090" volumes: - ./prometheus.yml:/etc/prometheus/prometheus.yml grafana: image: grafana/grafana:latest ports: - "3000:3000" environment: - GF_SECURITY_ADMIN_PASSWORD=admin depends_on: - prometheus volumes: geode-data: </code></pre></div> <h3 id="further-reading" class="position-relative d-flex align-items-center group"> Further Reading <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="further-reading" aria-haspopup="dialog" aria-label="Share link: Further Reading"> Share link </button> </h3><ul> <li><a href="/docs/getting-started/" >Getting Started Guide</a> - Initial setup and first queries</li> <li><a href="/docs/client-libraries/" >Client Library Documentation</a> - SDK references</li> <li><a href="/docs/tutorials/repl-basics/" >REPL Basics Tutorial</a> - Interactive shell documentation</li> <li><a href="/docs/development/lsp-guide/" >LSP Guide</a> - IDE integration</li> <li><a href="/docs/api-reference/" >API Reference</a> - Complete API documentation</li> <li><a href="/docs/development/testing-guide/" >Testing Guide</a> - Coding and testing guidelines</li> <li><a href="/docs/ops/observability/" >Observability</a> - Monitoring and observability setup</li> </ul>

Popular

Related Articles

GQL Language Server Protocol Implementation Guide

Testing Strategies Guide

Error Handling Guide

Transaction Management Guide

Advanced REPL Features Guide

Development

Governance and Requirements Tracking