System Integration

<h2 id="system-integration" class="position-relative d-flex align-items-center group"> System 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="system-integration" aria-haspopup="dialog" aria-label="Share link: System Integration"> 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>Geode provides comprehensive integration capabilities designed to fit seamlessly into modern application architectures. From native client libraries and standard protocols to data pipeline connectors and third-party integrations, Geode supports diverse integration patterns across multiple languages and platforms. <h3 id="introduction-to-geode-integration" class="position-relative d-flex align-items-center group"> Introduction to Geode 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="introduction-to-geode-integration" aria-haspopup="dialog" aria-label="Share link: Introduction to Geode Integration"> Share link </button> </h3>Integration is a first-class concern in Geode’s architecture. The database is designed to work in heterogeneous environments where applications may be written in different languages, deployed across various platforms, and need to communicate using different protocols. Geode achieves this through: <ul> <li>Native Client Libraries: Production-ready clients for Go, Python, Rust, and Zig</li> <li>Standard Protocols: QUIC+TLS for high-performance communication, HTTP/REST for broad compatibility</li> <li>ISO/IEC 39075:2024 GQL: Standards-compliant query language ensuring long-term compatibility</li> <li>JSON Line Protocol: Simple, text-based wire format for easy debugging and custom client development</li> <li>Database/SQL Interface: Native Go integration with the standard database/sql package</li> </ul> <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-integration" class="position-relative d-flex align-items-center group"> Go 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="go-integration" aria-haspopup="dialog" aria-label="Share link: Go Integration"> Share link </button> </h4>Geode’s Go client implements the standard <code>database/sql</code> interface, enabling seamless integration with existing Go applications: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go">import ( "database/sql" "fmt" _ "geodedb.com/geode" ) func main() { // Standard database/sql interface db, err := sql.Open("geode", "quic://localhost:3141") if err != nil { panic(err) } defer db.Close() // Connection pooling automatically managed db.SetMaxOpenConns(100) db.SetMaxIdleConns(10) db.SetConnMaxLifetime(time.Hour) // Execute GQL queries using familiar SQL patterns rows, err := db.Query(` MATCH (u:User)-[:PURCHASED]->(p:Product) WHERE u.id = $user_id RETURN p.name, p.price, p.category `, 12345) if err != nil { panic(err) } defer rows.Close() for rows.Next() { var name, category string var price float64 if err := rows.Scan(&name, &price, &category); err != nil { panic(err) } fmt.Printf("%s ($%.2f) - %s\n", name, price, category) } // Transactions work as expected tx, err := db.Begin() defer tx.Rollback() _, err = tx.Exec(` CREATE (u:User { id: $id, email: $email, created_at: $timestamp }) `, 99999, "[email protected]", time.Now()) tx.Commit() } </code></pre></div>Integration Benefits: <ul> <li>Drop-in replacement for SQL databases in Go applications</li> <li>Works with ORMs and query builders expecting database/sql</li> <li>Automatic connection pooling and lifecycle management</li> <li>Context-aware operations with timeout and cancellation support</li> </ul> <h4 id="python-integration" class="position-relative d-flex align-items-center group"> Python 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="python-integration" aria-haspopup="dialog" aria-label="Share link: Python Integration"> Share link </button> </h4>The Python client provides async/await integration with modern Python applications: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-python" data-lang="python">import asyncio import geode_client import geode_client from geode_client import Client from datetime import datetime async def integrate_geode(): # Async context manager for automatic cleanup client = Client(host="localhost", port=3141) async with client.connection() as conn: # Execute queries with async/await result, _ = await conn.query(""" MATCH (u:User)-[:PURCHASED]->(p:Product) WHERE u.id = $user_id RETURN p.name, p.price, p.category """, {"user_id": 12345}) for row in result.rows: print(f"{row['p.name']} (${row['p.price']}) - {row['p.category']}") # Transaction support async with client.connection() as tx: await tx.begin() await tx.execute(""" CREATE (u:User { id: $id, email: $email, created_at: $timestamp }) """, { "id": 99999, "email": "[email protected]", "timestamp": datetime.now() }) await tx.commit() # Integration with FastAPI from fastapi import FastAPI, Depends from typing import List app = FastAPI() # Shared connection pool geode_pool = None @app.on_event("startup") async def startup(): global geode_pool from geode_client import ConnectionPool geode_pool = ConnectionPool( url="localhost:3141", min_connections=10, max_connections=100 ) @app.on_event("shutdown") async def shutdown(): await geode_pool.close() async def get_client(): async with geode_pool.acquire() as client: yield client @app.get("/users/{user_id}/purchases") async def get_user_purchases( user_id: int, client: Client = Depends(get_client) ) -> List[dict]: result, _ = await client.query(""" MATCH (u:User {id: $user_id})-[:PURCHASED]->(p:Product) RETURN p.name, p.price, p.category """, {"user_id": user_id}) return [dict(row) for row in result] </code></pre></div>Integration Benefits: <ul> <li>Native async/await support for asyncio applications</li> <li>Connection pooling for high-concurrency workloads</li> <li>FastAPI, Django Channels, and AIOHTTP compatibility</li> <li>Type-safe query builders and parameter handling</li> </ul> <h4 id="rust-integration" class="position-relative d-flex align-items-center group"> Rust 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="rust-integration" aria-haspopup="dialog" aria-label="Share link: Rust Integration"> Share link </button> </h4>The Rust client provides zero-cost abstractions with tokio integration: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-rust" data-lang="rust">use geode_client::{Client, Value}; use rust_decimal::Decimal; use serde::Deserialize; use std::collections::HashMap; #[derive(Debug, Deserialize)] struct Purchase { name: String, price: Decimal, category: String, } #[tokio::main] async fn main() -> geode_client::Result<()> { let client = Client::new("localhost", 3141).skip_verify(true); let mut conn = client.connect().await?; // Execute query let mut params = HashMap::new(); params.insert("user_id".to_string(), Value::int(12345)); let (page, _) = conn.query_with_params( "MATCH (u:User {id: $user_id})-[:PURCHASED]->(p:Product) RETURN p.name, p.price, p.category", &params, ).await?; for row in &page.rows { println!("{} (${}) - {}", row.get("name").unwrap().as_string()?, row.get("price").unwrap().as_decimal()?, row.get("category").unwrap().as_string()? ); } // Transaction support conn.begin().await?; let mut tx_params = HashMap::new(); tx_params.insert("id".to_string(), Value::int(99999)); tx_params.insert("email".to_string(), Value::string("[email protected]")); conn.query_with_params( "CREATE (u:User {id: $id, email: $email})", &tx_params, ).await?; conn.commit().await?; Ok(()) } // Integration with Actix-Web use actix_web::{web, App, HttpServer, Result as ActixResult}; use std::sync::Arc; #[actix_web::get("/users/{user_id}/purchases")] async fn get_purchases( user_id: web::Path<i64>, client: web::Data<Arc<Client>> ) -> ActixResult<web::Json<Vec<Purchase>>> { let mut conn = client.connect().await .map_err(actix_web::error::ErrorInternalServerError)?; let mut params = HashMap::new(); params.insert("user_id".to_string(), Value::int(user_id.into_inner())); let (page, _) = conn.query_with_params( "MATCH (u:User {id: $user_id})-[:PURCHASED]->(p:Product) RETURN p.name, p.price, p.category", &params ).await .map_err(actix_web::error::ErrorInternalServerError)?; let purchases = page.rows.iter().map(|row| Purchase { name: row.get("name").unwrap().as_string().unwrap().to_string(), price: row.get("price").unwrap().as_decimal().unwrap(), category: row.get("category").unwrap().as_string().unwrap().to_string(), }).collect(); Ok(web::Json(purchases)) } #[tokio::main] async fn server() -> std::io::Result<()> { let client = Arc::new( Client::new("localhost", 3141).skip_verify(true) ); HttpServer::new(move || { App::new() .app_data(web::Data::new(client.clone())) .service(get_purchases) }) .bind("127.0.0.1:8080")? .run() .await } </code></pre></div>Integration Benefits: <ul> <li>Zero-cost abstractions with compile-time optimization</li> <li>Native tokio integration for async Rust applications</li> <li>Type-safe query execution with serde deserialization</li> <li>High-performance, workload-dependent throughput</li> </ul> <h3 id="httprest-integration" class="position-relative d-flex align-items-center group"> HTTP/REST 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="httprest-integration" aria-haspopup="dialog" aria-label="Share link: HTTP/REST Integration"> Share link </button> </h3>For environments where native clients are unavailable or HTTP integration is preferred, Geode provides RESTful endpoints: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash"># Execute query via REST API curl -X POST https://geode.example.com/api/v1/query \ -H "Content-Type: application/json" \ -H "Authorization: Bearer token_abc123" \ -d '{ "query": "MATCH (u:User {id: $user_id})-[:PURCHASED]->(p:Product) RETURN p", "parameters": { "user_id": 12345 } }' # Response { "schema": { "fields": [{"name": "p", "type": "NODE"}] }, "data": [ { "p": { "labels": ["Product"], "properties": { "id": 101, "name": "Laptop", "price": 999.99, "category": "Electronics" } } } ], "metadata": { "rows_returned": 1, "execution_time_ms": 12 } } </code></pre></div>REST Integration Patterns: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-javascript" data-lang="javascript">// JavaScript/Node.js integration const axios = require('axios'); class GeodeClient { constructor(baseUrl, apiKey) { this.baseUrl = baseUrl; this.apiKey = apiKey; } async query(gql, parameters = {}) { const response = await axios.post( `${this.baseUrl}/api/v1/query`, { query: gql, parameters }, { headers: { 'Authorization': `Bearer ${this.apiKey}`, 'Content-Type': 'application/json' } } ); return response.data; } async transaction(queries) { // Begin transaction const txResponse = await axios.post( `${this.baseUrl}/api/v1/transaction/begin`, {}, { headers: { 'Authorization': `Bearer ${this.apiKey}` } } ); const txId = txResponse.data.transaction_id; try { // Execute queries for (const { query, parameters } of queries) { await axios.post( `${this.baseUrl}/api/v1/transaction/${txId}/query`, { query, parameters }, { headers: { 'Authorization': `Bearer ${this.apiKey}` } } ); } // Commit await axios.post( `${this.baseUrl}/api/v1/transaction/${txId}/commit`, {}, { headers: { 'Authorization': `Bearer ${this.apiKey}` } } ); } catch (error) { // Rollback on error await axios.post( `${this.baseUrl}/api/v1/transaction/${txId}/rollback`, {}, { headers: { 'Authorization': `Bearer ${this.apiKey}` } } ); throw error; } } } // Usage const { createClient } = require('@geodedb/client'); const client = await createClient('quic://geode.example.com:3141'); const rows = await client.queryAll(` MATCH (u:User {id: $user_id})-[:PURCHASED]->(p:Product) RETURN p.name, p.price `, { params: { user_id: 12345 } }); console.log(rows); </code></pre></div> <h3 id="data-pipeline-integration" class="position-relative d-flex align-items-center group"> Data Pipeline 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="data-pipeline-integration" aria-haspopup="dialog" aria-label="Share link: Data Pipeline Integration"> Share link </button> </h3> <h4 id="apache-kafka-integration" class="position-relative d-flex align-items-center group"> Apache Kafka 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="apache-kafka-integration" aria-haspopup="dialog" aria-label="Share link: Apache Kafka Integration"> Share link </button> </h4>Stream changes from Geode to Kafka using Change Data Capture (CDC): <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-python" data-lang="python">from geode_client import Client from kafka import KafkaProducer import json import asyncio async def geode_to_kafka(): producer = KafkaProducer( bootstrap_servers=['kafka:9092'], value_serializer=lambda v: json.dumps(v).encode('utf-8') ) client = Client(host="localhost", port=3141) last_seen = None async with client.connection() as conn: while True: result, _ = await conn.query( """ MATCH (n) WHERE n.updated_at > $since RETURN labels(n) AS labels, n AS node, n.updated_at AS updated_at ORDER BY updated_at """, {"since": last_seen or "1970-01-01T00:00:00Z"}, ) for row in result.rows: topic = f\"geode.{row['labels'].raw_value[0]}\" producer.send(topic, { "operation": "UPSERT", "timestamp": row["updated_at"].raw_value, "data": row["node"].raw_value, }) last_seen = row["updated_at"].raw_value await asyncio.sleep(1) asyncio.run(geode_to_kafka()) </code></pre></div> <h4 id="etl-integration" class="position-relative d-flex align-items-center group"> ETL 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="etl-integration" aria-haspopup="dialog" aria-label="Share link: ETL Integration"> Share link </button> </h4>Integrate Geode with data transformation pipelines: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-python" data-lang="python">from geode_client import Client from airflow import DAG from airflow.operators.python import PythonOperator from datetime import datetime, timedelta def extract_from_postgres(**context): import psycopg2 conn = psycopg2.connect("postgresql://user:pass@postgres:5432/db") cursor = conn.cursor() cursor.execute("SELECT id, name, email FROM users WHERE created_at > %s", (context['execution_date'],)) return cursor.fetchall() async def load_to_geode(**context): users = context['task_instance'].xcom_pull(task_ids='extract') client = Client(host="localhost", port=3141) async with client.connection() as conn: await conn.begin() try: for user_id, name, email in users: await conn.execute(""" MERGE (u:User {id: $id}) SET u.name = $name, u.email = $email, u.synced_at = $timestamp """, { "id": user_id, "name": name, "email": email, "timestamp": datetime.now() }) await conn.commit() except Exception: await conn.rollback() raise with DAG( 'postgres_to_geode', default_args={'owner': 'airflow'}, schedule_interval=timedelta(hours=1), start_date=datetime(2024, 1, 1) ) as dag: extract = PythonOperator( task_id='extract', python_callable=extract_from_postgres ) load = PythonOperator( task_id='load', python_callable=load_to_geode ) extract >> load </code></pre></div> <h3 id="monitoring-and-observability-integration" class="position-relative d-flex align-items-center group"> Monitoring and Observability 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="monitoring-and-observability-integration" aria-haspopup="dialog" aria-label="Share link: Monitoring and Observability Integration"> Share link </button> </h3> <h4 id="prometheus-integration" class="position-relative d-flex align-items-center group"> Prometheus 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="prometheus-integration" aria-haspopup="dialog" aria-label="Share link: Prometheus Integration"> Share link </button> </h4>Geode exposes Prometheus metrics for monitoring integration: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-yaml" data-lang="yaml"># prometheus.yml scrape_configs: - job_name: 'geode' static_configs: - targets: ['geode:9090'] metrics_path: '/metrics' scrape_interval: 15s </code></pre></div>Query Geode metrics: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-python" data-lang="python">from prometheus_api_client import PrometheusConnect prom = PrometheusConnect(url="http://prometheus:9090") # Query Geode query latency query_latency = prom.custom_query( 'histogram_quantile(0.95, geode_query_duration_seconds_bucket)' ) # Query connection pool status connections = prom.custom_query('geode_connection_pool_active') # Alert on high error rate error_rate = prom.custom_query( 'rate(geode_query_errors_total[5m]) > 0.01' ) </code></pre></div> <h4 id="grafana-integration" class="position-relative d-flex align-items-center group"> Grafana 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="grafana-integration" aria-haspopup="dialog" aria-label="Share link: Grafana Integration"> Share link </button> </h4>Import Geode dashboards for visualization: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-json" data-lang="json">{ "dashboard": { "title": "Geode Database Metrics", "panels": [ { "title": "Query Rate", "targets": [ { "expr": "rate(geode_queries_total[5m])", "legendFormat": "{{instance}}" } ] }, { "title": "Query Latency (p95)", "targets": [ { "expr": "histogram_quantile(0.95, geode_query_duration_seconds_bucket)", "legendFormat": "p95" } ] }, { "title": "Connection Pool", "targets": [ { "expr": "geode_connection_pool_active", "legendFormat": "Active" }, { "expr": "geode_connection_pool_idle", "legendFormat": "Idle" } ] } ] } } </code></pre></div> <h3 id="authentication-and-security-integration" class="position-relative d-flex align-items-center group"> Authentication and Security 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="authentication-and-security-integration" aria-haspopup="dialog" aria-label="Share link: Authentication and Security Integration"> Share link </button> </h3> <h4 id="oauth2oidc-integration" class="position-relative d-flex align-items-center group"> OAuth2/OIDC 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="oauth2oidc-integration" aria-haspopup="dialog" aria-label="Share link: OAuth2/OIDC Integration"> Share link </button> </h4>Integrate Geode with OAuth2 identity providers: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-python" data-lang="python">from geode_client import Client from authlib.integrations.httpx_client import AsyncOAuth2Client import asyncio async def geode_with_oauth(): # Get OAuth2 token oauth = AsyncOAuth2Client( client_id='geode-client', client_secret='secret', token_endpoint='https://auth.example.com/token' ) token = await oauth.fetch_token() access_token = token['access_token'] # Map OAuth identity to a Geode user and login client = Client(host="localhost", port=3141) async with client.connection() as conn: auth = geode_client.AuthClient(conn) await auth.login("service_user", "service_password") result, _ = await conn.query(""" MATCH (u:User {email: $email}) RETURN u """, {"email": "[email protected]"}) asyncio.run(geode_with_oauth()) </code></pre></div> <h4 id="ldap-integration" class="position-relative d-flex align-items-center group"> LDAP 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="ldap-integration" aria-haspopup="dialog" aria-label="Share link: LDAP Integration"> Share link </button> </h4>Authenticate Geode users against LDAP: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-python" data-lang="python">from geode_client import Client import ldap3 def authenticate_ldap(username, password): server = ldap3.Server('ldap://ldap.example.com') conn = ldap3.Connection( server, user=f'uid={username},ou=users,dc=example,dc=com', password=password ) return conn.bind() async def run_query_with_ldap(username, password, query, params=None): if not authenticate_ldap(username, password): raise ValueError("Authentication failed") client = Client(host="localhost", port=3141) async with client.connection() as conn: auth = geode_client.AuthClient(conn) await auth.login(username, password) result, _ = await conn.query(query, params) return result.rows </code></pre></div> <h3 id="container-orchestration-integration" class="position-relative d-flex align-items-center group"> Container Orchestration 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="container-orchestration-integration" aria-haspopup="dialog" aria-label="Share link: Container Orchestration Integration"> Share link </button> </h3> <h4 id="kubernetes-integration" class="position-relative d-flex align-items-center group"> Kubernetes 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="kubernetes-integration" aria-haspopup="dialog" aria-label="Share link: Kubernetes Integration"> Share link </button> </h4>Deploy Geode with Kubernetes service discovery: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-yaml" data-lang="yaml">apiVersion: v1 kind: Service metadata: name: geode labels: app: geode spec: type: ClusterIP ports: - port: 3141 targetPort: 3141 name: quic - port: 8080 targetPort: 8080 name: http selector: app: geode --- apiVersion: apps/v1 kind: StatefulSet metadata: name: geode spec: serviceName: geode replicas: 3 selector: matchLabels: app: geode template: metadata: labels: app: geode spec: containers: - name: geode image: geodedb/geode:0.2.18 ports: - containerPort: 3141 name: quic - containerPort: 8080 name: http env: - name: GEODE_CLUSTER_PEERS value: "geode-0.geode:3141,geode-1.geode:3141,geode-2.geode:3141" volumeMounts: - name: data mountPath: /var/lib/geode volumeClaimTemplates: - metadata: name: data spec: accessModes: ["ReadWriteOnce"] resources: requests: storage: 100Gi </code></pre></div>Application integration with Kubernetes service: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-python" data-lang="python">import geode_client import os async def connect_k8s(): # Use Kubernetes service DNS geode_url = os.getenv("GEODE_SERVICE", "geode.default.svc.cluster.local:3141") client = geode_client.open_database(f"quic://{geode_url}") async with client.connection() as conn: result, _ = await conn.query("MATCH (n) RETURN COUNT(n) AS total") total = result.rows[0]["total"] if result.rows else 0 print(f"Total nodes: {total}") </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><ol> <li> Connection Pooling: Always use connection pools for production applications <ul> <li>Go: Configure via <code>db.SetMaxOpenConns()</code> and <code>db.SetMaxIdleConns()</code></li> <li>Python: Use <code>ConnectionPool</code> with appropriate min/max settings</li> <li>Rust: Set <code>max_connections</code> in client builder</li> </ul> </li> <li> Error Handling: Implement proper error handling and retry logic <ul> <li>Handle transient network errors with exponential backoff</li> <li>Parse ISO error codes for specific error conditions</li> <li>Log errors with context for debugging</li> </ul> </li> <li> Authentication: Secure all integration points <ul> <li>Use TLS 1.3 for all connections</li> <li>Rotate credentials regularly</li> <li>Implement least-privilege access with Row-Level Security</li> </ul> </li> <li> Monitoring: Integrate comprehensive monitoring <ul> <li>Export metrics to Prometheus or similar systems</li> <li>Set up alerts for query latency, error rates, and resource usage</li> <li>Monitor connection pool health</li> </ul> </li> <li> Testing: Test integration points thoroughly <ul> <li>Use test containers for integration tests</li> <li>Mock Geode clients for unit tests</li> <li>Test failure scenarios and recovery</li> </ul> </li> </ol> <h3 id="performance-considerations" class="position-relative d-flex align-items-center group"> Performance Considerations <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-considerations" aria-haspopup="dialog" aria-label="Share link: Performance Considerations"> Share link </button> </h3><ul> <li>Native Clients: Use native QUIC clients (Go, Python, Rust, Node.js, Zig) for best performance</li> <li>Batch Operations: Group related operations in transactions for efficiency</li> <li>Connection Reuse: Maintain persistent connections and connection pools</li> <li>Query Optimization: Use EXPLAIN to optimize queries at integration points</li> <li>Network Latency: Co-locate clients with Geode servers when possible</li> </ul> <h3 id="related-topics" class="position-relative d-flex align-items-center group"> Related Topics <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="related-topics" aria-haspopup="dialog" aria-label="Share link: Related Topics"> Share link </button> </h3><ul> <li><a href="/tags/client-libraries/" >Client Libraries</a> - Detailed client library documentation</li> <li><a href="/tags/api/" >API Development</a> - API design and implementation</li> <li><a href="/tags/protocol/" >Protocol</a> - QUIC protocol and wire format</li> <li><a href="/tags/authentication/" >Authentication</a> - Authentication and authorization</li> <li><a href="/tags/monitoring/" >Monitoring</a> - Observability and metrics</li> </ul> <h3 id="further-reading" class="position-relative d-flex align-items-center group"> Further Reading <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="further-reading" aria-haspopup="dialog" aria-label="Share link: Further Reading"> Share link </button> </h3><ul> <li><a href="/docs/client-libraries/go-client/" >Go Client Documentation</a> - Complete Go integration guide</li> <li><a href="/docs/client-libraries/python-client/" >Python Client Documentation</a> - Python client reference</li> <li><a href="/docs/client-libraries/rust-client/" >Rust Client Documentation</a> - Rust client guide</li> <li><a href="/docs/client-libraries/nodejs-client/" >Node.js Client Documentation</a> - Node.js client guide</li> <li><a href="/docs/api-reference/" >API Reference</a> - API documentation</li> <li><a href="/tags/examples/" >Examples</a> - Real-world integration patterns</li> </ul>

Popular

Related Articles