Installation & Setup

Setting up Geode involves installing required dependencies, building from source, configuring the server, and establishing initial deployment parameters. This process transforms the source code into a running production-ready graph database capable of handling enterprise workloads with the 100% GQL compliance. <h3 id="prerequisites-and-requirements" class="position-relative d-flex align-items-center group"> Prerequisites and Requirements <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-and-requirements" aria-haspopup="dialog" aria-label="Share link: Prerequisites and Requirements"> 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>Before beginning Geode installation, ensure your system meets minimum requirements and has necessary dependencies installed. <h4 id="system-requirements" class="position-relative d-flex align-items-center group"> System Requirements <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-requirements" aria-haspopup="dialog" aria-label="Share link: System Requirements"> Share link </button> </h4>Geode requires a modern Linux, macOS, or Windows environment with sufficient resources for development and production workloads: <ul> <li>Operating System: Linux (Ubuntu 20.04+, Debian 11+, RHEL 8+), macOS 11+, or Windows 10/11 with WSL2</li> <li>CPU: 2+ cores (4+ recommended for production)</li> <li>Memory: 4GB minimum (8GB+ recommended for production)</li> <li>Storage: 10GB for binaries and source, plus data storage requirements</li> <li>Network: QUIC/UDP support (not blocked by firewall)</li> </ul> <h4 id="build-dependencies" class="position-relative d-flex align-items-center group"> Build Dependencies <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="build-dependencies" aria-haspopup="dialog" aria-label="Share link: Build Dependencies"> Share link </button> </h4>Geode is written in Zig and requires specific build tools: Zig Compiler: Version 0.1.0 or later is required for building Geode. Download from the official Zig website: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash"># Linux/macOS: Download and extract wget https://ziglang.org/download/0.1.0/zig-linux-x86_64-0.1.0.tar.xz tar -xf zig-linux-x86_64-0.1.0.tar.xz sudo mv zig-linux-x86_64-0.1.0 /opt/zig export PATH="/opt/zig:$PATH" # Verify installation zig version </code></pre></div>Build Tools: Standard development tools may be needed: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash"># Ubuntu/Debian sudo apt-get update sudo apt-get install build-essential git make # RHEL/CentOS sudo yum groupinstall "Development Tools" sudo yum install git make # macOS (via Homebrew) xcode-select --install brew install git make </code></pre></div> <h4 id="network-configuration" class="position-relative d-flex align-items-center group"> Network Configuration <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="network-configuration" aria-haspopup="dialog" aria-label="Share link: Network Configuration"> Share link </button> </h4>Geode uses QUIC over UDP on port 3141 by default. Ensure firewall rules allow this traffic: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash"># Ubuntu/Debian (ufw) sudo ufw allow 3141/udp sudo ufw reload # RHEL/CentOS (firewalld) sudo firewall-cmd --permanent --add-port=3141/udp sudo firewall-cmd --reload # Check port availability netstat -an | grep 3141 </code></pre></div> <h3 id="obtaining-geode-source-code" class="position-relative d-flex align-items-center group"> Obtaining Geode Source 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="obtaining-geode-source-code" aria-haspopup="dialog" aria-label="Share link: Obtaining Geode Source Code"> Share link </button> </h3>Geode is distributed as source code through a Git repository. <h4 id="cloning-the-repository" class="position-relative d-flex align-items-center group"> Cloning the Repository <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="cloning-the-repository" aria-haspopup="dialog" aria-label="Share link: Cloning the Repository"> Share link </button> </h4>Clone the complete monorepo containing the server and all client libraries: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash"># Clone via HTTPS git clone https://github.com/codeprosorg/geode cd geode # Or clone via SSH git clone [email protected]:devnw/codepros/geode.git cd geode </code></pre></div> <h4 id="repository-structure" class="position-relative d-flex align-items-center group"> Repository Structure <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-structure" aria-haspopup="dialog" aria-label="Share link: Repository Structure"> Share link </button> </h4>The monorepo contains multiple components: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-fallback" data-lang="fallback">geode/ ├── geode/ # Main database server (Zig) ├── geode-client-go/ # Go client library ├── geode-client-python/ # Python client library ├── geode-client-rust/ # Rust client library ├── geode-client-zig/ # Zig client library ├── geode-test-harness/ # Cross-client test framework └── gql/ # GQL reference implementation </code></pre></div>Navigate to the server directory for database installation: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash">cd geode </code></pre></div> <h3 id="building-geode" class="position-relative d-flex align-items-center group"> Building 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="building-geode" aria-haspopup="dialog" aria-label="Share link: Building Geode"> Share link </button> </h3>The build process compiles Geode from source, producing executable binaries. <h4 id="development-build" class="position-relative d-flex align-items-center group"> Development Build <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-build" aria-haspopup="dialog" aria-label="Share link: Development Build"> Share link </button> </h4>Build a debug version for development and testing: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash">cd geode make build </code></pre></div>This creates debug binaries in <code>zig-out/bin/</code> with full debugging symbols and safety checks enabled. <h4 id="production-build" class="position-relative d-flex align-items-center group"> Production Build <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="production-build" aria-haspopup="dialog" aria-label="Share link: Production Build"> Share link </button> </h4>Build an optimized release version for production deployment: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash">make release </code></pre></div>The release build enables optimizations while maintaining ReleaseSafe mode, which includes runtime safety checks. The resulting binary appears in <code>zig-out/bin/geode</code>. <h4 id="build-verification" class="position-relative d-flex align-items-center group"> Build Verification <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="build-verification" aria-haspopup="dialog" aria-label="Share link: Build Verification"> Share link </button> </h4>Verify the build completed successfully: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash"># Check binary exists ls -lh zig-out/bin/geode # Verify it runs ./zig-out/bin/geode --version </code></pre></div> <h4 id="build-options" class="position-relative d-flex align-items-center group"> Build Options <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="build-options" aria-haspopup="dialog" aria-label="Share link: Build Options"> Share link </button> </h4>The Makefile supports several build targets: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash"># Clean build artifacts make clean # Run tests make test # Run comprehensive test suite (97.4% pass rate) make geodetestlab-comprehensive # Complete CI pipeline make ci </code></pre></div> <h3 id="initial-configuration" class="position-relative d-flex align-items-center group"> Initial Configuration <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="initial-configuration" aria-haspopup="dialog" aria-label="Share link: Initial Configuration"> Share link </button> </h3>Configure Geode for your environment before first run. <h4 id="data-directory" class="position-relative d-flex align-items-center group"> Data Directory <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-directory" aria-haspopup="dialog" aria-label="Share link: Data Directory"> Share link </button> </h4>Geode stores data in a configured directory. Create this directory with appropriate permissions: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash"># Development setup mkdir -p ./data # Production setup sudo mkdir -p /var/lib/geode/data sudo chown geode:geode /var/lib/geode/data sudo chmod 750 /var/lib/geode/data </code></pre></div> <h4 id="tls-certificates" class="position-relative d-flex align-items-center group"> TLS Certificates <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="tls-certificates" aria-haspopup="dialog" aria-label="Share link: TLS Certificates"> Share link </button> </h4>Geode requires TLS certificates for secure QUIC connections. For development, generate self-signed certificates: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash"># Generate self-signed certificate openssl req -x509 -newkey rsa:4096 \ -keyout key.pem -out cert.pem \ -days 365 -nodes \ -subj "/C=US/ST=State/L=City/O=Organization/CN=localhost" # Set appropriate permissions chmod 600 key.pem chmod 644 cert.pem </code></pre></div>For production, obtain certificates from a trusted Certificate Authority (Let’s Encrypt, etc.). <h4 id="environment-variables" class="position-relative d-flex align-items-center group"> Environment Variables <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="environment-variables" aria-haspopup="dialog" aria-label="Share link: Environment Variables"> Share link </button> </h4>Configure environment variables for consistent operation: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash"># Add to ~/.bashrc or ~/.zshrc export GEODE_DATA_DIR="/var/lib/geode/data" export GEODE_CERT="/etc/geode/cert.pem" export GEODE_KEY="/etc/geode/key.pem" export GEODE_LOG_LEVEL="info" </code></pre></div> <h3 id="running-geode" class="position-relative d-flex align-items-center group"> Running 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="running-geode" aria-haspopup="dialog" aria-label="Share link: Running Geode"> Share link </button> </h3>Start the Geode server with appropriate configuration. <h4 id="development-server" class="position-relative d-flex align-items-center group"> 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="development-server" aria-haspopup="dialog" aria-label="Share link: Development Server"> Share link </button> </h4>Run a development server with default settings: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash">cd geode ./zig-out/bin/geode serve --listen 127.0.0.1:3141 </code></pre></div>The server starts and listens on localhost port 3141. Output indicates successful startup: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-fallback" data-lang="fallback">[INFO] Geode Graph Database v0.2.18 [INFO] Listening on 127.0.0.1:3141 [INFO] Data directory: ./data [INFO] Ready for connections </code></pre></div> <h4 id="production-server" class="position-relative d-flex align-items-center group"> Production 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="production-server" aria-haspopup="dialog" aria-label="Share link: Production Server"> Share link </button> </h4>Run with production-appropriate configuration: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash">./zig-out/bin/geode serve \ --listen 0.0.0.0:3141 \ --data-dir /var/lib/geode/data \ --cert /etc/geode/cert.pem \ --key /etc/geode/key.pem \ --log-level info \ --max-connections 1000 </code></pre></div> <h4 id="server-as-system-service" class="position-relative d-flex align-items-center group"> Server as System Service <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="server-as-system-service" aria-haspopup="dialog" aria-label="Share link: Server as System Service"> Share link </button> </h4>Configure Geode as a systemd service for automatic startup: Create <code>/etc/systemd/system/geode.service</code>: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-ini" data-lang="ini">[Unit] Description=Geode Graph Database After=network.target Documentation=https://geodedb.com [Service] Type=simple User=geode Group=geode WorkingDirectory=/opt/geode ExecStart=/opt/geode/zig-out/bin/geode serve \ --listen 0.0.0.0:3141 \ --data-dir /var/lib/geode/data \ --cert /etc/geode/cert.pem \ --key /etc/geode/key.pem \ --log-level info Restart=always RestartSec=10 StandardOutput=journal StandardError=journal SyslogIdentifier=geode # Security settings NoNewPrivileges=true PrivateTmp=true ProtectSystem=strict ProtectHome=true ReadWritePaths=/var/lib/geode LimitNOFILE=65536 [Install] WantedBy=multi-user.target </code></pre></div>Enable and start the service: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash">sudo systemctl daemon-reload sudo systemctl enable geode sudo systemctl start geode sudo systemctl status geode </code></pre></div> <h3 id="verifying-installation" class="position-relative d-flex align-items-center group"> Verifying Installation <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="verifying-installation" aria-haspopup="dialog" aria-label="Share link: Verifying Installation"> Share link </button> </h3>Confirm Geode is running correctly and accepting connections. <h4 id="connection-testing" class="position-relative d-flex align-items-center group"> Connection 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="connection-testing" aria-haspopup="dialog" aria-label="Share link: Connection Testing"> Share link </button> </h4>Use the Geode shell to test connectivity: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash">./zig-out/bin/geode shell # At the prompt, test basic operations > PING PONG > CREATE (n:Person {name: 'Alice', age: 30}) RETURN n; > MATCH (n:Person) RETURN n; </code></pre></div>Successful responses indicate proper installation. <h4 id="client-library-testing" class="position-relative d-flex align-items-center group"> Client Library 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="client-library-testing" aria-haspopup="dialog" aria-label="Share link: Client Library Testing"> Share link </button> </h4>Test connectivity from client libraries: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go">// Go client test package main import ( "context" "fmt" "log" "geodedb.com/geode" ) func main() { client, err := geode.NewClient("localhost:3141") if err != nil { log.Fatal(err) } defer client.Close() ctx := context.Background() if err := client.Ping(ctx); err != nil { log.Fatal(err) } fmt.Println("Connected successfully!") } </code></pre></div> <h4 id="performance-baseline" class="position-relative d-flex align-items-center group"> Performance Baseline <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-baseline" aria-haspopup="dialog" aria-label="Share link: Performance Baseline"> Share link </button> </h4>Run baseline performance tests to establish expected performance: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash">cd geode make test </code></pre></div>This runs the test suite and provides performance metrics for comparison against future runs. <h3 id="user-and-access-setup" class="position-relative d-flex align-items-center group"> User and Access 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="user-and-access-setup" aria-haspopup="dialog" aria-label="Share link: User and Access Setup"> Share link </button> </h3>Configure users and access controls for multi-user environments. <h4 id="creating-users" class="position-relative d-flex align-items-center group"> Creating Users <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="creating-users" aria-haspopup="dialog" aria-label="Share link: Creating Users"> Share link </button> </h4>While Geode’s authentication model depends on your deployment, establish basic access patterns: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">-- Create user accounts (example, actual implementation may vary) CREATE USER admin WITH PASSWORD 'secure_password'; CREATE USER app_user WITH PASSWORD 'app_password'; </code></pre></div> <h4 id="access-policies" class="position-relative d-flex align-items-center group"> Access Policies <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="access-policies" aria-haspopup="dialog" aria-label="Share link: Access Policies"> Share link </button> </h4>Configure Row-Level Security policies for fine-grained access control: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">-- Enable RLS on sensitive tables ALTER TABLE Person ENABLE ROW LEVEL SECURITY; -- Create access policies CREATE POLICY user_access ON Person FOR SELECT USING (owner_id = current_user_id()); </code></pre></div> <h3 id="client-setup" class="position-relative d-flex align-items-center group"> Client 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="client-setup" aria-haspopup="dialog" aria-label="Share link: Client Setup"> Share link </button> </h3>Configure client libraries to connect to Geode. <h4 id="go-client-setup" class="position-relative d-flex align-items-center group"> Go Client 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="go-client-setup" aria-haspopup="dialog" aria-label="Share link: Go Client Setup"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash"># Install Go client go get geodedb.com/geode # Import in your application import "geodedb.com/geode" </code></pre></div> <h4 id="python-client-setup" class="position-relative d-flex align-items-center group"> Python Client 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="python-client-setup" aria-haspopup="dialog" aria-label="Share link: Python Client Setup"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash">cd geode-client-python # Install dependencies pip install -r requirements.txt # Install client pip install -e . </code></pre></div> <h4 id="rust-client-setup" class="position-relative d-flex align-items-center group"> Rust Client 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="rust-client-setup" aria-haspopup="dialog" aria-label="Share link: Rust Client Setup"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash">cd geode-client-rust # Build client cargo build --release # Add to Cargo.toml [dependencies] geode-client = { path = "../geode-client-rust" } </code></pre></div> <h4 id="zig-client-setup" class="position-relative d-flex align-items-center group"> Zig Client 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="zig-client-setup" aria-haspopup="dialog" aria-label="Share link: Zig Client Setup"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash">cd geode-client-zig # Build client zig build # Run example zig build run </code></pre></div> <h3 id="initial-data-loading" class="position-relative d-flex align-items-center group"> Initial Data Loading <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="initial-data-loading" aria-haspopup="dialog" aria-label="Share link: Initial Data Loading"> Share link </button> </h3>Load initial data into your Geode instance. <h4 id="bulk-data-import" class="position-relative d-flex align-items-center group"> Bulk Data Import <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="bulk-data-import" aria-haspopup="dialog" aria-label="Share link: Bulk Data Import"> Share link </button> </h4>For large datasets, use batch operations: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">BEGIN TRANSACTION; UNWIND $nodes AS node CREATE (n:Person { id: node.id, name: node.name, email: node.email }); UNWIND $relationships AS rel MATCH (a:Person {id: rel.from}) MATCH (b:Person {id: rel.to}) CREATE (a)-[:KNOWS]->(b); COMMIT; </code></pre></div> <h4 id="schema-initialization" class="position-relative d-flex align-items-center group"> Schema Initialization <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-initialization" aria-haspopup="dialog" aria-label="Share link: Schema Initialization"> Share link </button> </h4>Create indexes and constraints: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">-- Create indexes for performance CREATE INDEX ON Person(email); CREATE INDEX ON Person(name); CREATE INDEX ON Company(name); -- Create unique constraints CREATE CONSTRAINT ON Person(email) ASSERT email IS UNIQUE; </code></pre></div> <h3 id="troubleshooting-setup-issues" class="position-relative d-flex align-items-center group"> Troubleshooting Setup 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="troubleshooting-setup-issues" aria-haspopup="dialog" aria-label="Share link: Troubleshooting Setup Issues"> Share link </button> </h3>Common setup problems and solutions. <h4 id="build-failures" class="position-relative d-flex align-items-center group"> Build Failures <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="build-failures" aria-haspopup="dialog" aria-label="Share link: Build Failures"> Share link </button> </h4>If build fails, verify Zig version and dependencies: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash">zig version # Should be 0.1.0+ make clean make build </code></pre></div> <h4 id="connection-refused" class="position-relative d-flex align-items-center group"> Connection Refused <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-refused" aria-haspopup="dialog" aria-label="Share link: Connection Refused"> Share link </button> </h4>If clients cannot connect, check server is running and firewall allows traffic: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash"># Verify server running ps aux | grep geode # Check port listening netstat -an | grep 3141 # Test locally ./zig-out/bin/geode shell </code></pre></div> <h4 id="permission-errors" class="position-relative d-flex align-items-center group"> Permission Errors <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="permission-errors" aria-haspopup="dialog" aria-label="Share link: Permission Errors"> Share link </button> </h4>Ensure data directory has correct permissions: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash">sudo chown -R geode:geode /var/lib/geode sudo chmod -R 750 /var/lib/geode </code></pre></div> <h4 id="certificate-issues" class="position-relative d-flex align-items-center group"> Certificate 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="certificate-issues" aria-haspopup="dialog" aria-label="Share link: Certificate Issues"> Share link </button> </h4>For TLS certificate problems, verify certificate files are readable: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash">ls -l cert.pem key.pem openssl x509 -in cert.pem -text -noout </code></pre></div> <h3 id="post-installation-steps" class="position-relative d-flex align-items-center group"> Post-Installation Steps <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="post-installation-steps" aria-haspopup="dialog" aria-label="Share link: Post-Installation Steps"> Share link </button> </h3>Complete setup with operational configuration. <h4 id="backup-configuration" class="position-relative d-flex align-items-center group"> Backup Configuration <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="backup-configuration" aria-haspopup="dialog" aria-label="Share link: Backup Configuration"> Share link </button> </h4>Establish backup procedures: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash"># Create backup script cat > /opt/geode/backup.sh <<'EOF' #!/bin/bash BACKUP_DIR="/backup/geode/$(date +%Y%m%d)" mkdir -p $BACKUP_DIR rsync -av /var/lib/geode/data/ $BACKUP_DIR/ EOF chmod +x /opt/geode/backup.sh # Schedule daily backups crontab -e # Add: 0 2 * * * /opt/geode/backup.sh </code></pre></div> <h4 id="monitoring-setup" class="position-relative d-flex align-items-center group"> Monitoring 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="monitoring-setup" aria-haspopup="dialog" aria-label="Share link: Monitoring Setup"> Share link </button> </h4>Configure monitoring for production systems: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash"># Enable slow query logging ./zig-out/bin/geode serve \ --slow-query-log \ --slow-query-threshold 1000 </code></pre></div> <h4 id="documentation-review" class="position-relative d-flex align-items-center group"> Documentation Review <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-review" aria-haspopup="dialog" aria-label="Share link: Documentation Review"> Share link </button> </h4>Review relevant documentation: <ul> <li>Geode server configuration reference</li> <li>Client library documentation for your language</li> <li>GQL query language syntax</li> <li>Performance tuning guides</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>Setup connects to several operational areas: <ul> <li>Installation - Detailed installation procedures</li> <li>Configuration - Advanced configuration options</li> <li>Deployment - Production deployment strategies</li> <li>Operations - Ongoing operational management</li> <li>Troubleshooting - Resolving setup and operational issues</li> </ul> <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>Additional setup resources: <ul> <li>Official Geode documentation at geodedb.com</li> <li>Build system documentation in geode/CLAUDE.md</li> <li>Client library setup guides in respective directories</li> <li>Community support and issue tracking</li> </ul> Proper installation and setup establishes the foundation for reliable Geode operation. Following these procedures ensures a stable, performant graph database ready for development and production workloads.

Popular

Related Articles

Installation Guide

Installation