Installation Guide | Geode Database

<h2 id="installation-guide" class="position-relative d-flex align-items-center group"> Installation Guide <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="installation-guide" aria-haspopup="dialog" aria-label="Share link: Installation Guide"> Share link </button> </h2><div id="headingShareModal" class="heading-share-modal" role="dialog" aria-modal="true" aria-labelledby="headingShareTitle" hidden> <div class="hsm-dialog" role="document"> <div class="hsm-header"> <h2 id="headingShareTitle" class="h6 mb-0 fw-bold">Share this section</h2> <button type="button" class="hsm-close" aria-label="Close"> </button> </div> <div class="hsm-body"> <label for="headingShareInput" class="form-label small text-muted mb-1 text-uppercase fw-bold" style="font-size: 0.7rem; letter-spacing: 0.5px;">Permalink</label> <div class="input-group mb-4 hsm-url-group"> <input id="headingShareInput" type="text" class="form-control font-monospace" readonly aria-readonly="true" style="font-size: 0.85rem;" /> <button class="btn btn-primary hsm-copy" type="button" aria-label="Copy" title="Copy"> </button> </div> <div class="small fw-bold mb-2 text-muted text-uppercase" style="font-size: 0.7rem; letter-spacing: 0.5px;">Share via</div> <div class="hsm-share-grid"> <a id="share-twitter" class="btn btn-outline-secondary w-100" target="_blank" rel="noopener noreferrer"> Twitter </a> <a id="share-linkedin" class="btn btn-outline-secondary w-100" target="_blank" rel="noopener noreferrer"> LinkedIn </a> <a id="share-facebook" class="btn btn-outline-secondary w-100" target="_blank" rel="noopener noreferrer"> Facebook </a> </div> </div> </div> </div> <style> .heading-share-modal { position: fixed; inset: 0; display: flex; justify-content: center; align-items: center; background: rgba(0, 0, 0, 0.6); z-index: 1050; padding: 1rem; backdrop-filter: blur(4px); -webkit-backdrop-filter: blur(4px); } .heading-share-modal[hidden] { display: none !important; } .hsm-dialog { max-width: 420px; width: 100%; background: var(--bs-body-bg, #fff); color: var(--bs-body-color, #212529); border: 1px solid var(--bs-border-color, rgba(0,0,0,0.1)); border-radius: 1rem; box-shadow: 0 25px 50px -12px rgba(0, 0, 0, 0.25); overflow: hidden; animation: hsm-fade-in 0.2s ease-out; } @keyframes hsm-fade-in { from { opacity: 0; transform: scale(0.95); } to { opacity: 1; transform: scale(1); } } [data-bs-theme="dark"] .hsm-dialog { background: #1e293b; border-color: rgba(255,255,255,0.1); color: #f8f9fa; } .hsm-header { display: flex; justify-content: space-between; align-items: center; padding: 1rem 1.5rem; border-bottom: 1px solid var(--bs-border-color, rgba(0,0,0,0.1)); background: rgba(0,0,0,0.02); } [data-bs-theme="dark"] .hsm-header { background: rgba(255,255,255,0.02); border-color: rgba(255,255,255,0.1); } .hsm-close { background: transparent; border: none; color: inherit; opacity: 0.5; padding: 0.25rem 0.5rem; border-radius: 0.25rem; font-size: 1.2rem; line-height: 1; transition: opacity 0.2s; } .hsm-close:hover { opacity: 1; } .hsm-body { padding: 1.5rem; } .hsm-url-group { display: flex !important; align-items: stretch; } .hsm-url-group .form-control { flex: 1; min-width: 0; margin: 0; background: var(--bs-secondary-bg, #f8f9fa); border-color: var(--bs-border-color, #dee2e6); border-top-right-radius: 0; border-bottom-right-radius: 0; height: 42px; } .hsm-url-group .btn { flex: 0 0 auto; margin: 0; margin-left: -1px; border-top-left-radius: 0; border-bottom-left-radius: 0; height: 42px; display: flex; align-items: center; justify-content: center; padding: 0 1.25rem; z-index: 2; } [data-bs-theme="dark"] .hsm-url-group .form-control { background: #0f172a; border-color: #334155; color: #e2e8f0; } .hsm-share-grid { display: flex; flex-direction: column; gap: 0.5rem; } .hsm-share-grid .btn { display: flex; align-items: center; justify-content: center; font-size: 0.9rem; padding: 0.6rem; border-color: var(--bs-border-color); width: 100%; } [data-bs-theme="dark"] .hsm-share-grid .btn { color: #e2e8f0; border-color: #475569; } [data-bs-theme="dark"] .hsm-share-grid .btn:hover { background: #334155; border-color: #cbd5e1; } </style> <script> (function(){ const modal = document.getElementById('headingShareModal'); if(!modal) return; const input = modal.querySelector('#headingShareInput'); const copyBtn = modal.querySelector('.hsm-copy'); const twitter = modal.querySelector('#share-twitter'); const linkedin = modal.querySelector('#share-linkedin'); const facebook = modal.querySelector('#share-facebook'); const closeBtn = modal.querySelector('.hsm-close'); let lastFocus=null; let trapBound=false; function buildUrl(id){ return window.location.origin + window.location.pathname + '#' + id; } function isOpen(){ return !modal.hasAttribute('hidden'); } function hydrate(id){ const url=buildUrl(id); input.value=url; const enc=encodeURIComponent(url); const text=encodeURIComponent(document.title); if(twitter) twitter.href=`https://twitter.com/intent/tweet?url=${enc}&text=${text}`; if(linkedin) linkedin.href=`https://www.linkedin.com/sharing/share-offsite/?url=${enc}`; if(facebook) facebook.href=`https://www.facebook.com/sharer/sharer.php?u=${enc}`; } function openModal(id){ lastFocus=document.activeElement; hydrate(id); if(!isOpen()){ modal.removeAttribute('hidden'); } requestAnimationFrame(()=>{ input.focus(); }); trapFocus(); } function closeModal(){ if(!isOpen()) return; modal.setAttribute('hidden',''); if(lastFocus && typeof lastFocus.focus==='function') lastFocus.focus(); } function copyCurrent(){ try{ navigator.clipboard.writeText(input.value).then(()=>feedback(true),()=>fallback()); } catch(e){ fallback(); } } function fallback(){ input.select(); try{ document.execCommand('copy'); feedback(true);}catch(e){ feedback(false);} } function feedback(ok){ if(!copyBtn) return; const icon=copyBtn.querySelector('i'); if(!icon) return; const prev=copyBtn.getAttribute('data-prev')||icon.className; if(!copyBtn.getAttribute('data-prev')) copyBtn.setAttribute('data-prev',prev); icon.className= ok ? 'fa-duotone fa-clipboard-check':'fa-duotone fa-circle-exclamation'; setTimeout(()=>{ icon.className=prev; },1800); } function handleShareClick(e){ e.preventDefault(); const btn=e.currentTarget; const id=btn.getAttribute('data-share-target'); if(id) openModal(id); } function bindShareButtons(){ document.querySelectorAll('.h-share').forEach(btn=>{ if(!btn.dataset.hShareBound){ btn.addEventListener('click', handleShareClick); btn.dataset.hShareBound='1'; } }); } bindShareButtons(); if(document.readyState==='loading'){ document.addEventListener('DOMContentLoaded', bindShareButtons); } else { requestAnimationFrame(bindShareButtons); } document.addEventListener('click', function(e){ const shareBtn=e.target.closest && e.target.closest('.h-share'); if(shareBtn && !shareBtn.dataset.hShareBound){ handleShareClick.call(shareBtn, e); } }, true); document.addEventListener('click', e=>{ if(e.target===modal) closeModal(); if(e.target.closest && e.target.closest('.hsm-close')){ e.preventDefault(); closeModal(); } if(copyBtn && (e.target===copyBtn || (e.target.closest && e.target.closest('.hsm-copy')))) { e.preventDefault(); copyCurrent(); } }); document.addEventListener('keydown', e=>{ if(e.key==='Escape' && isOpen()) closeModal(); }); function trapFocus(){ if(trapBound) return; trapBound=true; modal.addEventListener('keydown', f=>{ if(f.key==='Tab' && isOpen()){ const focusable=[...modal.querySelectorAll('a[href],button,input,textarea,select,[tabindex]:not([tabindex="-1"])')].filter(el=>!el.hasAttribute('disabled')); if(!focusable.length) return; const first=focusable[0]; const last=focusable[focusable.length-1]; if(f.shiftKey && document.activeElement===first){ f.preventDefault(); last.focus(); } else if(!f.shiftKey && document.activeElement===last){ f.preventDefault(); first.focus(); } } }); } if(closeBtn) closeBtn.addEventListener('click', e=>{ e.preventDefault(); closeModal(); }); })(); </script>This comprehensive guide covers all methods to install and configure Geode, the ISO/IEC 39075:2024 GQL-compliant graph database. Choose the installation method that best fits your environment. <h3 id="prerequisites" class="position-relative d-flex align-items-center group"> Prerequisites <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="prerequisites" aria-haspopup="dialog" aria-label="Share link: Prerequisites"> Share link </button> </h3>Before installing Geode, ensure you have: <ul> <li>Operating System: Linux (x86_64, ARM64), macOS (Apple Silicon, Intel), or Windows (WSL2)</li> <li>Memory: Minimum 2GB RAM (4GB+ recommended for production)</li> <li>Disk: Minimum 1GB free space</li> <li>Network: Port 3141 available (configurable)</li> </ul> <h3 id="quick-installation-methods" class="position-relative d-flex align-items-center group"> Quick Installation Methods <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="quick-installation-methods" aria-haspopup="dialog" aria-label="Share link: Quick Installation Methods"> Share link </button> </h3><table> <thead> <tr> <th>Method</th> <th>Best For</th> <th>Difficulty</th> </tr> </thead> <tbody> <tr> <td>Docker</td> <td>Development, Testing, Quick Start</td> <td>Easy</td> </tr> <tr> <td>APT Repository</td> <td>Production Linux Servers</td> <td>Easy</td> </tr> <tr> <td>Binary Download</td> <td>Air-gapped environments</td> <td>Medium</td> </tr> <tr> <td>Build from Source</td> <td>Contributors, Custom builds</td> <td>Advanced</td> </tr> </tbody> </table> <hr> <h3 id="docker-installation-recommended" class="position-relative d-flex align-items-center group"> Docker Installation (Recommended) <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="docker-installation-recommended" aria-haspopup="dialog" aria-label="Share link: Docker Installation (Recommended)"> Share link </button> </h3>Docker provides the fastest and most consistent way to run Geode. <h4 id="prerequisites-1" class="position-relative d-flex align-items-center group"> Prerequisites <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="prerequisites-1" aria-haspopup="dialog" aria-label="Share link: Prerequisites"> Share link </button> </h4><ul> <li>Docker 20.10+ installed</li> <li>Docker Compose v2+ (optional, for multi-container setups)</li> </ul> <h4 id="basic-installation" class="position-relative d-flex align-items-center group"> Basic 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="basic-installation" aria-haspopup="dialog" aria-label="Share link: Basic Installation"> Share link </button> </h4>Pull and run the official Geode image: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash"># Pull the latest stable release docker pull geodedb/geode:latest # Run Geode docker run -d \ --name geode \ -p 3141:3141 \ -v geode-data:/var/lib/geode \ geodedb/geode:latest serve --listen 0.0.0.0:3141 </code></pre></div> <h4 id="docker-compose-setup" class="position-relative d-flex align-items-center group"> Docker Compose 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="docker-compose-setup" aria-haspopup="dialog" aria-label="Share link: Docker Compose Setup"> Share link </button> </h4>For production deployments, use Docker Compose: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-yaml" data-lang="yaml"># docker-compose.yml version: '3.8' services: geode: image: geodedb/geode:latest container_name: geode restart: unless-stopped ports: - "3141:3141" volumes: - geode-data:/var/lib/geode - ./geode.toml:/etc/geode/geode.toml:ro environment: - GEODE_LOG_LEVEL=info - GEODE_DATA_DIR=/var/lib/geode command: ["serve", "--listen", "0.0.0.0:3141", "--config", "/etc/geode/geode.toml"] healthcheck: test: ["CMD", "geode", "ping", "localhost:3141"] interval: 30s timeout: 10s retries: 3 start_period: 10s volumes: geode-data: driver: local </code></pre></div>Start with Docker Compose: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash">docker compose up -d </code></pre></div> <h4 id="available-image-tags" class="position-relative d-flex align-items-center group"> Available Image 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="available-image-tags" aria-haspopup="dialog" aria-label="Share link: Available Image Tags"> Share link </button> </h4><table> <thead> <tr> <th>Tag</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td><code>latest</code></td> <td>Latest stable release</td> </tr> <tr> <td><code>0.2.18</code></td> <td>Specific version</td> </tr> <tr> <td><code>0.2</code></td> <td>Latest patch of minor version</td> </tr> <tr> <td><code>edge</code></td> <td>Latest development build</td> </tr> <tr> <td><code>alpine</code></td> <td>Minimal Alpine-based image</td> </tr> </tbody> </table> <h4 id="docker-configuration-options" class="position-relative d-flex align-items-center group"> Docker Configuration 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="docker-configuration-options" aria-haspopup="dialog" aria-label="Share link: Docker Configuration Options"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash"># Run with custom configuration docker run -d \ --name geode \ -p 3141:3141 \ -p 8443:8443 \ -v geode-data:/var/lib/geode \ -v $(pwd)/geode.toml:/etc/geode/geode.toml:ro \ -e GEODE_LOG_LEVEL=debug \ -e GEODE_MAX_CONNECTIONS=1000 \ geodedb/geode:latest serve \ --listen 0.0.0.0:3141 \ --config /etc/geode/geode.toml # Run with TLS certificates docker run -d \ --name geode \ -p 3141:3141 \ -v geode-data:/var/lib/geode \ -v $(pwd)/certs:/etc/geode/certs:ro \ geodedb/geode:latest serve \ --listen 0.0.0.0:3141 \ --tls-cert /etc/geode/certs/server.crt \ --tls-key /etc/geode/certs/server.key </code></pre></div> <h4 id="docker-verification" class="position-relative d-flex align-items-center group"> Docker 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="docker-verification" aria-haspopup="dialog" aria-label="Share link: Docker Verification"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash"># Check container is running docker ps | grep geode # View logs docker logs geode # Test connection docker exec -it geode geode ping localhost:3141 # Open interactive shell docker exec -it geode geode shell </code></pre></div><hr> <h3 id="apt-repository-installation-debianubuntu" class="position-relative d-flex align-items-center group"> APT Repository Installation (Debian/Ubuntu) <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="apt-repository-installation-debianubuntu" aria-haspopup="dialog" aria-label="Share link: APT Repository Installation (Debian/Ubuntu)"> Share link </button> </h3>For production Linux servers, use the official APT repository. <h4 id="supported-distributions" class="position-relative d-flex align-items-center group"> Supported Distributions <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="supported-distributions" aria-haspopup="dialog" aria-label="Share link: Supported Distributions"> Share link </button> </h4><ul> <li>Debian 11 (Bullseye), 12 (Bookworm)</li> <li>Ubuntu 20.04 LTS, 22.04 LTS, 24.04 LTS</li> <li>Linux Mint 20+</li> </ul> <h4 id="installation-steps" class="position-relative d-flex align-items-center group"> 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="installation-steps" aria-haspopup="dialog" aria-label="Share link: Installation Steps"> Share link </button> </h4><ol> <li>Add the GPG key:</li> </ol> <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash">curl -fsSL https://apt.geodedb.com/geode.gpg | sudo gpg --dearmor -o /usr/share/keyrings/geode-archive-keyring.gpg </code></pre></div><ol> <li>Add the repository:</li> </ol> <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash">echo "deb [signed-by=/usr/share/keyrings/geode-archive-keyring.gpg] https://apt.geodedb.com stable main" | sudo tee /etc/apt/sources.list.d/geode.list </code></pre></div><ol> <li>Install Geode:</li> </ol> <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash">sudo apt update sudo apt install geode </code></pre></div><ol> <li>Enable and start the service:</li> </ol> <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash">sudo systemctl enable geode sudo systemctl start geode </code></pre></div> <h4 id="apt-configuration" class="position-relative d-flex align-items-center group"> APT 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="apt-configuration" aria-haspopup="dialog" aria-label="Share link: APT Configuration"> Share link </button> </h4>The APT installation creates: <ul> <li>Binary: <code>/usr/bin/geode</code></li> <li>Configuration: <code>/etc/geode/geode.toml</code></li> <li>Data directory: <code>/var/lib/geode</code></li> <li>Log directory: <code>/var/log/geode</code></li> <li>Systemd service: <code>geode.service</code></li> </ul> Edit the configuration: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash">sudo nano /etc/geode/geode.toml </code></pre></div><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-toml" data-lang="toml"># /etc/geode/geode.toml [server] listen = "0.0.0.0:3141" data_dir = "/var/lib/geode" log_level = "info" [storage] engine = "lsm" cache_size = "1GB" wal_enabled = true [security] tls_enabled = true tls_cert = "/etc/geode/certs/server.crt" tls_key = "/etc/geode/certs/server.key" </code></pre></div> <h4 id="managing-the-service" class="position-relative d-flex align-items-center group"> Managing the 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="managing-the-service" aria-haspopup="dialog" aria-label="Share link: Managing the Service"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash"># Start Geode sudo systemctl start geode # Stop Geode sudo systemctl stop geode # Restart Geode sudo systemctl restart geode # Check status sudo systemctl status geode # View logs sudo journalctl -u geode -f </code></pre></div> <h4 id="upgrading-via-apt" class="position-relative d-flex align-items-center group"> Upgrading via APT <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="upgrading-via-apt" aria-haspopup="dialog" aria-label="Share link: Upgrading via APT"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash">sudo apt update sudo apt upgrade geode </code></pre></div><hr> <h3 id="binary-installation" class="position-relative d-flex align-items-center group"> Binary 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="binary-installation" aria-haspopup="dialog" aria-label="Share link: Binary Installation"> Share link </button> </h3>For environments without Docker or package managers. <h4 id="macos-installation-homebrew" class="position-relative d-flex align-items-center group"> macOS Installation (Homebrew) <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="macos-installation-homebrew" aria-haspopup="dialog" aria-label="Share link: macOS Installation (Homebrew)"> Share link </button> </h4>The recommended way to install Geode on macOS is via Homebrew: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash"># Install via Homebrew brew install geodedb/geode/geode # Verify installation geode version </code></pre></div> <h4 id="download-binary-linux" class="position-relative d-flex align-items-center group"> Download Binary (Linux) <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="download-binary-linux" aria-haspopup="dialog" aria-label="Share link: Download Binary (Linux)"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash"># Linux x86_64 curl -LO https://releases.geodedb.com/latest/geode-linux-amd64.tar.gz tar -xzf geode-linux-amd64.tar.gz # Linux ARM64 curl -LO https://releases.geodedb.com/latest/geode-linux-arm64.tar.gz tar -xzf geode-linux-arm64.tar.gz </code></pre></div> <h4 id="install-binary" class="position-relative d-flex align-items-center group"> Install Binary <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="install-binary" aria-haspopup="dialog" aria-label="Share link: Install Binary"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash"># Move to system path sudo mv geode /usr/local/bin/ sudo chmod +x /usr/local/bin/geode # Create data directory sudo mkdir -p /var/lib/geode sudo chown $USER:$USER /var/lib/geode # Verify installation geode version </code></pre></div> <h4 id="create-systemd-service-optional" class="position-relative d-flex align-items-center group"> Create Systemd Service (Optional) <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="create-systemd-service-optional" aria-haspopup="dialog" aria-label="Share link: Create Systemd Service (Optional)"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash">sudo tee /etc/systemd/system/geode.service > /dev/null <<EOF [Unit] Description=Geode Graph Database After=network.target [Service] Type=simple User=geode Group=geode ExecStart=/usr/local/bin/geode serve --listen 0.0.0.0:3141 --data-dir /var/lib/geode Restart=on-failure RestartSec=10 [Install] WantedBy=multi-user.target EOF sudo systemctl daemon-reload sudo systemctl enable geode sudo systemctl start geode </code></pre></div><hr> <h3 id="building-from-source" class="position-relative d-flex align-items-center group"> Building from Source <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-from-source" aria-haspopup="dialog" aria-label="Share link: Building from Source"> Share link </button> </h3>For contributors or custom builds. <h4 id="prerequisites-2" class="position-relative d-flex align-items-center group"> Prerequisites <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="prerequisites-2" aria-haspopup="dialog" aria-label="Share link: Prerequisites"> Share link </button> </h4><ul> <li>Zig: Version 0.1.0 or later</li> <li>Git: For cloning the repository</li> <li>Make: For build automation</li> </ul> <h4 id="installing-zig" class="position-relative d-flex align-items-center group"> Installing Zig <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="installing-zig" aria-haspopup="dialog" aria-label="Share link: Installing Zig"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash"># Download Zig (Linux x86_64) curl -LO 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 echo 'export PATH="/opt/zig:$PATH"' >> ~/.bashrc source ~/.bashrc # Verify Zig installation zig version </code></pre></div> <h4 id="build-geode" class="position-relative d-flex align-items-center group"> Build 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="build-geode" aria-haspopup="dialog" aria-label="Share link: Build Geode"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash"># Clone the repository git clone https://gitlab.com/devnw/codepros/geode/geode.git cd geode # Build debug version make build # Build release version (optimized) make release # Run tests make test # The binary is located at: # Debug: ./zig-out/bin/geode # Release: ./zig-out/bin/geode </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><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash"># Build with specific options zig build -Doptimize=ReleaseSafe # Build with debug symbols zig build -Doptimize=Debug # Build for specific target zig build -Dtarget=aarch64-linux-gnu # Run comprehensive tests make geodetestlab-comprehensive </code></pre></div><hr> <h3 id="client-library-installation" class="position-relative d-flex align-items-center group"> Client Library 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="client-library-installation" aria-haspopup="dialog" aria-label="Share link: Client Library Installation"> Share link </button> </h3>Geode supports multiple programming languages. Install the client for your preferred language. <h4 id="go-client" class="position-relative d-flex align-items-center group"> Go Client <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="go-client" aria-haspopup="dialog" aria-label="Share link: Go Client"> Share link </button> </h4>Requirements: Go 1.24.0+ <div class="docs-tabs mb-4"> <ul class="nav nav-tabs" id="tabs-1774880881810895486" role="tablist"><li class="nav-item" role="presentation"> <button class="nav-link active" id="tabs-1774880881810895486-tab-0-tab" data-bs-toggle="tab" data-bs-target="#tabs-1774880881810895486-tab-0" type="button" role="tab" aria-controls="tabs-1774880881810895486-tab-0" aria-selected="true" > go get </button> </li><li class="nav-item" role="presentation"> <button class="nav-link" id="tabs-1774880881810895486-tab-1-tab" data-bs-toggle="tab" data-bs-target="#tabs-1774880881810895486-tab-1" type="button" role="tab" aria-controls="tabs-1774880881810895486-tab-1" aria-selected="false" > go.mod </button> </li></ul> <div class="tab-content border border-top-0 rounded-bottom p-3" id="tabs-1774880881810895486-content"><div class="tab-pane fade show active" id="tabs-1774880881810895486-tab-0" role="tabpanel" aria-labelledby="tabs-1774880881810895486-tab-0-tab" > <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash">go get geodedb.com/geode </code></pre></div> </div><div class="tab-pane fade" id="tabs-1774880881810895486-tab-1" role="tabpanel" aria-labelledby="tabs-1774880881810895486-tab-1-tab" > <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go">// Add to your go.mod require geodedb.com/geode v0.2.18 </code></pre></div> </div></div> </div> Verify Installation: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go">package main import ( "context" "database/sql" "fmt" "log" _ "geodedb.com/geode" ) func main() { db, err := sql.Open("geode", "localhost:3141") if err != nil { log.Fatal(err) } defer db.Close() if err := db.PingContext(context.Background()); err != nil { log.Fatal(err) } fmt.Println("Connected to Geode!") } </code></pre></div> <h4 id="python-client" class="position-relative d-flex align-items-center group"> Python Client <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="python-client" aria-haspopup="dialog" aria-label="Share link: Python Client"> Share link </button> </h4>Requirements: Python 3.9+ <div class="docs-tabs mb-4"> <ul class="nav nav-tabs" id="tabs-1774880881811754607" role="tablist"><li class="nav-item" role="presentation"> <button class="nav-link active" id="tabs-1774880881811754607-tab-0-tab" data-bs-toggle="tab" data-bs-target="#tabs-1774880881811754607-tab-0" type="button" role="tab" aria-controls="tabs-1774880881811754607-tab-0" aria-selected="true" > pip </button> </li><li class="nav-item" role="presentation"> <button class="nav-link" id="tabs-1774880881811754607-tab-1-tab" data-bs-toggle="tab" data-bs-target="#tabs-1774880881811754607-tab-1" type="button" role="tab" aria-controls="tabs-1774880881811754607-tab-1" aria-selected="false" > poetry </button> </li><li class="nav-item" role="presentation"> <button class="nav-link" id="tabs-1774880881811754607-tab-2-tab" data-bs-toggle="tab" data-bs-target="#tabs-1774880881811754607-tab-2" type="button" role="tab" aria-controls="tabs-1774880881811754607-tab-2" aria-selected="false" > pipenv </button> </li><li class="nav-item" role="presentation"> <button class="nav-link" id="tabs-1774880881811754607-tab-3-tab" data-bs-toggle="tab" data-bs-target="#tabs-1774880881811754607-tab-3" type="button" role="tab" aria-controls="tabs-1774880881811754607-tab-3" aria-selected="false" > requirements.txt </button> </li></ul> <div class="tab-content border border-top-0 rounded-bottom p-3" id="tabs-1774880881811754607-content"><div class="tab-pane fade show active" id="tabs-1774880881811754607-tab-0" role="tabpanel" aria-labelledby="tabs-1774880881811754607-tab-0-tab" > <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash">pip install geode-client </code></pre></div> </div><div class="tab-pane fade" id="tabs-1774880881811754607-tab-1" role="tabpanel" aria-labelledby="tabs-1774880881811754607-tab-1-tab" > <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash">poetry add geode-client </code></pre></div> </div><div class="tab-pane fade" id="tabs-1774880881811754607-tab-2" role="tabpanel" aria-labelledby="tabs-1774880881811754607-tab-2-tab" > <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash">pipenv install geode-client </code></pre></div> </div><div class="tab-pane fade" id="tabs-1774880881811754607-tab-3" role="tabpanel" aria-labelledby="tabs-1774880881811754607-tab-3-tab" > <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-text" data-lang="text">geode-client>=0.3.19 </code></pre></div> </div></div> </div> Verify Installation: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-python" data-lang="python">import asyncio from geode_client import Client async def main(): client = Client(host="localhost", port=3141, skip_verify=True) async with client.connection() as conn: result = await conn.ping() print(f"Connected to Geode! Latency: {result.latency_ms}ms") asyncio.run(main()) </code></pre></div> <h4 id="rust-client" class="position-relative d-flex align-items-center group"> Rust Client <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="rust-client" aria-haspopup="dialog" aria-label="Share link: Rust Client"> Share link </button> </h4>Requirements: Rust 1.70+, tokio runtime <div class="docs-tabs mb-4"> <ul class="nav nav-tabs" id="tabs-1774880881813071470" role="tablist"><li class="nav-item" role="presentation"> <button class="nav-link active" id="tabs-1774880881813071470-tab-0-tab" data-bs-toggle="tab" data-bs-target="#tabs-1774880881813071470-tab-0" type="button" role="tab" aria-controls="tabs-1774880881813071470-tab-0" aria-selected="true" > Cargo.toml </button> </li><li class="nav-item" role="presentation"> <button class="nav-link" id="tabs-1774880881813071470-tab-1-tab" data-bs-toggle="tab" data-bs-target="#tabs-1774880881813071470-tab-1" type="button" role="tab" aria-controls="tabs-1774880881813071470-tab-1" aria-selected="false" > cargo add </button> </li></ul> <div class="tab-content border border-top-0 rounded-bottom p-3" id="tabs-1774880881813071470-content"><div class="tab-pane fade show active" id="tabs-1774880881813071470-tab-0" role="tabpanel" aria-labelledby="tabs-1774880881813071470-tab-0-tab" > <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-toml" data-lang="toml">[dependencies] geode-client = "0.1.1-alpha.8" tokio = { version = "1", features = ["full"] } </code></pre></div> </div><div class="tab-pane fade" id="tabs-1774880881813071470-tab-1" role="tabpanel" aria-labelledby="tabs-1774880881813071470-tab-1-tab" > <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash">cargo add geode-client cargo add tokio --features full </code></pre></div> </div></div> </div> Verify Installation: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-rust" data-lang="rust">use geode_client::Client; #[tokio::main] async fn main() -> Result<(), Box<dyn std::error::Error>> { let client = Client::new("127.0.0.1", 3141).skip_verify(true); let mut conn = client.connect().await?; conn.ping().await?; println!("Connected to Geode!"); Ok(()) } </code></pre></div> <h4 id="nodejs-client" class="position-relative d-flex align-items-center group"> Node.js Client <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="nodejs-client" aria-haspopup="dialog" aria-label="Share link: Node.js Client"> Share link </button> </h4>Requirements: Node.js 18+ <div class="docs-tabs mb-4"> <ul class="nav nav-tabs" id="tabs-1774880881813861069" role="tablist"><li class="nav-item" role="presentation"> <button class="nav-link active" id="tabs-1774880881813861069-tab-0-tab" data-bs-toggle="tab" data-bs-target="#tabs-1774880881813861069-tab-0" type="button" role="tab" aria-controls="tabs-1774880881813861069-tab-0" aria-selected="true" > npm </button> </li><li class="nav-item" role="presentation"> <button class="nav-link" id="tabs-1774880881813861069-tab-1-tab" data-bs-toggle="tab" data-bs-target="#tabs-1774880881813861069-tab-1" type="button" role="tab" aria-controls="tabs-1774880881813861069-tab-1" aria-selected="false" > yarn </button> </li><li class="nav-item" role="presentation"> <button class="nav-link" id="tabs-1774880881813861069-tab-2-tab" data-bs-toggle="tab" data-bs-target="#tabs-1774880881813861069-tab-2" type="button" role="tab" aria-controls="tabs-1774880881813861069-tab-2" aria-selected="false" > pnpm </button> </li><li class="nav-item" role="presentation"> <button class="nav-link" id="tabs-1774880881813861069-tab-3-tab" data-bs-toggle="tab" data-bs-target="#tabs-1774880881813861069-tab-3" type="button" role="tab" aria-controls="tabs-1774880881813861069-tab-3" aria-selected="false" > package.json </button> </li></ul> <div class="tab-content border border-top-0 rounded-bottom p-3" id="tabs-1774880881813861069-content"><div class="tab-pane fade show active" id="tabs-1774880881813861069-tab-0" role="tabpanel" aria-labelledby="tabs-1774880881813861069-tab-0-tab" > <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash">npm install @geodedb/client </code></pre></div> </div><div class="tab-pane fade" id="tabs-1774880881813861069-tab-1" role="tabpanel" aria-labelledby="tabs-1774880881813861069-tab-1-tab" > <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash">yarn add @geodedb/client </code></pre></div> </div><div class="tab-pane fade" id="tabs-1774880881813861069-tab-2" role="tabpanel" aria-labelledby="tabs-1774880881813861069-tab-2-tab" > <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash">pnpm add @geodedb/client </code></pre></div> </div><div class="tab-pane fade" id="tabs-1774880881813861069-tab-3" role="tabpanel" aria-labelledby="tabs-1774880881813861069-tab-3-tab" > <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-json" data-lang="json">{ "dependencies": { "@geodedb/client": "^1.0.0-alpha.15" } } </code></pre></div> </div></div> </div> Verify Installation: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-typescript" data-lang="typescript">import { createClient } from '@geodedb/client'; async function main() { const client = await createClient('quic://localhost:3141'); const pong = await client.ping(); console.log(`Connected to Geode! Latency: ${pong.latency}ms`); await client.close(); } main(); </code></pre></div> <h4 id="zig-client" class="position-relative d-flex align-items-center group"> Zig Client <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="zig-client" aria-haspopup="dialog" aria-label="Share link: Zig Client"> Share link </button> </h4>Requirements: Zig 0.1.0+ <div class="docs-tabs mb-4"> <ul class="nav nav-tabs" id="tabs-1774880881815207472" role="tablist"><li class="nav-item" role="presentation"> <button class="nav-link active" id="tabs-1774880881815207472-tab-0-tab" data-bs-toggle="tab" data-bs-target="#tabs-1774880881815207472-tab-0" type="button" role="tab" aria-controls="tabs-1774880881815207472-tab-0" aria-selected="true" > build.zig.zon </button> </li><li class="nav-item" role="presentation"> <button class="nav-link" id="tabs-1774880881815207472-tab-1-tab" data-bs-toggle="tab" data-bs-target="#tabs-1774880881815207472-tab-1" type="button" role="tab" aria-controls="tabs-1774880881815207472-tab-1" aria-selected="false" > build.zig </button> </li></ul> <div class="tab-content border border-top-0 rounded-bottom p-3" id="tabs-1774880881815207472-content"><div class="tab-pane fade show active" id="tabs-1774880881815207472-tab-0" role="tabpanel" aria-labelledby="tabs-1774880881815207472-tab-0-tab" > <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-zig" data-lang="zig">.{ .name = "my-project", .version = "0.1.0", .dependencies = .{ .geode_client = .{ .url = "https://gitlab.com/devnw/codepros/geode/geode-client-zig/-/archive/v0.1.0/geode-client-zig-v0.1.0.tar.gz", .hash = "...", // Get hash from first build attempt }, }, } </code></pre></div> </div><div class="tab-pane fade" id="tabs-1774880881815207472-tab-1" role="tabpanel" aria-labelledby="tabs-1774880881815207472-tab-1-tab" > <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-zig" data-lang="zig">const std = @import("std"); pub fn build(b: *std.Build) void { const target = b.standardTargetOptions(.{}); const optimize = b.standardOptimizeOption(.{}); const geode_client = b.dependency("geode_client", .{ .target = target, .optimize = optimize, }); const exe = b.addExecutable(.{ .name = "my-app", .root_source_file = b.path("src/main.zig"), .target = target, .optimize = optimize, }); exe.root_module.addImport("geode_client", geode_client.module("geode_client")); b.installArtifact(exe); } </code></pre></div> </div></div> </div> Verify Installation: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-zig" data-lang="zig">const std = @import("std"); const geode = @import("geode_client"); pub fn main() !void { var gpa = std.heap.GeneralPurposeAllocator(.{}){}; defer _ = gpa.deinit(); const allocator = gpa.allocator(); var client = geode.GeodeClient.init(allocator, "localhost", 3141, true); defer client.deinit(); try client.connect(); try client.sendHello("verify", "1.0.0"); _ = try client.receiveMessage(30000); std.debug.print("Connected to Geode!\n", .{}); } </code></pre></div><hr> <h3 id="verification-steps" class="position-relative d-flex align-items-center group"> Verification 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="verification-steps" aria-haspopup="dialog" aria-label="Share link: Verification Steps"> Share link </button> </h3>After installation, verify everything is working correctly. <h4 id="1-check-server-status" class="position-relative d-flex align-items-center group"> 1. Check Server Status <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="1-check-server-status" aria-haspopup="dialog" aria-label="Share link: 1. Check Server Status"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash"># Using CLI geode ping localhost:3141 # Expected output: # Connected to Geode v0.2.18 # Latency: 2ms </code></pre></div> <h4 id="2-run-a-test-query" class="position-relative d-flex align-items-center group"> 2. Run a Test Query <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="2-run-a-test-query" aria-haspopup="dialog" aria-label="Share link: 2. Run a Test Query"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash"># Open interactive shell geode shell # Run test query geode> RETURN 1 + 1 AS result | result | |--------| | 2 | geode> \exit </code></pre></div> <h4 id="3-verify-client-connection" class="position-relative d-flex align-items-center group"> 3. Verify Client Connection <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="3-verify-client-connection" aria-haspopup="dialog" aria-label="Share link: 3. Verify Client Connection"> Share link </button> </h4><div class="docs-tabs mb-4"> <ul class="nav nav-tabs" id="tabs-1774880881817942469" role="tablist"><li class="nav-item" role="presentation"> <button class="nav-link active" id="tabs-1774880881817942469-tab-0-tab" data-bs-toggle="tab" data-bs-target="#tabs-1774880881817942469-tab-0" type="button" role="tab" aria-controls="tabs-1774880881817942469-tab-0" aria-selected="true" > Go </button> </li><li class="nav-item" role="presentation"> <button class="nav-link" id="tabs-1774880881817942469-tab-1-tab" data-bs-toggle="tab" data-bs-target="#tabs-1774880881817942469-tab-1" type="button" role="tab" aria-controls="tabs-1774880881817942469-tab-1" aria-selected="false" > Python </button> </li><li class="nav-item" role="presentation"> <button class="nav-link" id="tabs-1774880881817942469-tab-2-tab" data-bs-toggle="tab" data-bs-target="#tabs-1774880881817942469-tab-2" type="button" role="tab" aria-controls="tabs-1774880881817942469-tab-2" aria-selected="false" > Rust </button> </li><li class="nav-item" role="presentation"> <button class="nav-link" id="tabs-1774880881817942469-tab-3-tab" data-bs-toggle="tab" data-bs-target="#tabs-1774880881817942469-tab-3" type="button" role="tab" aria-controls="tabs-1774880881817942469-tab-3" aria-selected="false" > Node.js </button> </li></ul> <div class="tab-content border border-top-0 rounded-bottom p-3" id="tabs-1774880881817942469-content"><div class="tab-pane fade show active" id="tabs-1774880881817942469-tab-0" role="tabpanel" aria-labelledby="tabs-1774880881817942469-tab-0-tab" > <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash"># Create test file cat > test_connection.go << 'EOF' package main import ( "context" "database/sql" "fmt" "log" _ "geodedb.com/geode" ) func main() { db, err := sql.Open("geode", "localhost:3141") if err != nil { log.Fatal(err) } defer db.Close() row := db.QueryRowContext(context.Background(), "RETURN 1 + 1 AS result") var result int if err := row.Scan(&result); err != nil { log.Fatal(err) } fmt.Printf("Query result: %d\n", result) } EOF go run test_connection.go </code></pre></div> </div><div class="tab-pane fade" id="tabs-1774880881817942469-tab-1" role="tabpanel" aria-labelledby="tabs-1774880881817942469-tab-1-tab" > <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash"># Create test file cat > test_connection.py << 'EOF' import asyncio from geode_client import Client async def main(): client = Client(host="localhost", port=3141, skip_verify=True) async with client.connection() as conn: page, _ = await conn.query("RETURN 1 + 1 AS result") result = page.rows[0]['result'].as_int print(f"Query result: {result}") asyncio.run(main()) EOF python test_connection.py </code></pre></div> </div><div class="tab-pane fade" id="tabs-1774880881817942469-tab-2" role="tabpanel" aria-labelledby="tabs-1774880881817942469-tab-2-tab" > <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash"># In a Cargo project cargo run --example basic_connection </code></pre></div> </div><div class="tab-pane fade" id="tabs-1774880881817942469-tab-3" role="tabpanel" aria-labelledby="tabs-1774880881817942469-tab-3-tab" > <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash"># Create test file cat > test_connection.mjs << 'EOF' import { createClient } from '@geodedb/client'; const client = await createClient('quic://localhost:3141'); const rows = await client.queryAll('RETURN 1 + 1 AS result'); console.log(`Query result: ${rows[0].get('result')?.asNumber}`); await client.close(); EOF node test_connection.mjs </code></pre></div> </div></div> </div> <hr> <h3 id="troubleshooting" class="position-relative d-flex align-items-center group"> Troubleshooting <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" aria-haspopup="dialog" aria-label="Share link: Troubleshooting"> Share link </button> </h3> <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>Symptom: <code>Connection refused</code> or <code>Cannot connect to server</code> Solutions: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash"># 1. Check if Geode is running docker ps | grep geode # OR systemctl status geode # 2. Check if port is open netstat -tlnp | grep 3141 # OR ss -tlnp | grep 3141 # 3. Check firewall sudo ufw status sudo ufw allow 3141/tcp # 4. Check logs docker logs geode # OR journalctl -u geode -n 50 </code></pre></div> <h4 id="port-already-in-use" class="position-relative d-flex align-items-center group"> Port Already in Use <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="port-already-in-use" aria-haspopup="dialog" aria-label="Share link: Port Already in Use"> Share link </button> </h4>Symptom: <code>Address already in use</code> Solutions: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash"># Find process using port lsof -i :3141 # OR fuser 3141/tcp # Kill the process kill -9 <PID> # Or use a different port docker run -d -p 3142:3141 geodedb/geode:latest serve --listen 0.0.0.0:3141 # Connect to new port geode ping localhost:3142 </code></pre></div> <h4 id="tlscertificate-errors" class="position-relative d-flex align-items-center group"> TLS/Certificate 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="tlscertificate-errors" aria-haspopup="dialog" aria-label="Share link: TLS/Certificate Errors"> Share link </button> </h4>Symptom: <code>Certificate verification failed</code> or <code>TLS handshake error</code> Solutions: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash"># 1. For development, skip verification # Go db, _ := sql.Open("geode", "localhost:3141?insecure_tls_skip_verify=true") # Python client = Client(host="localhost", port=3141, skip_verify=True) # 2. Use proper certificates for production docker run -d \ -v $(pwd)/certs:/etc/geode/certs:ro \ geodedb/geode:latest serve \ --tls-cert /etc/geode/certs/server.crt \ --tls-key /etc/geode/certs/server.key # 3. Generate self-signed certificates openssl req -x509 -newkey rsa:4096 \ -keyout server.key -out server.crt \ -days 365 -nodes \ -subj "/CN=localhost" </code></pre></div> <h4 id="out-of-memory" class="position-relative d-flex align-items-center group"> Out of Memory <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="out-of-memory" aria-haspopup="dialog" aria-label="Share link: Out of Memory"> Share link </button> </h4>Symptom: <code>Out of memory</code> or server crashes Solutions: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash"># 1. Increase Docker memory limit docker run -d \ --memory=4g \ --memory-swap=4g \ geodedb/geode:latest # 2. Adjust cache size in config # /etc/geode/geode.toml [storage] cache_size = "512MB" # Reduce from default # 3. Monitor memory usage docker stats geode </code></pre></div> <h4 id="permission-denied" class="position-relative d-flex align-items-center group"> Permission Denied <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-denied" aria-haspopup="dialog" aria-label="Share link: Permission Denied"> Share link </button> </h4>Symptom: <code>Permission denied</code> accessing data directory Solutions: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash"># 1. Fix ownership sudo chown -R $USER:$USER /var/lib/geode # 2. Fix permissions sudo chmod -R 755 /var/lib/geode # 3. For Docker, use named volumes docker run -d \ -v geode-data:/var/lib/geode \ geodedb/geode:latest </code></pre></div> <h4 id="client-library-build-errors" class="position-relative d-flex align-items-center group"> Client Library Build 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="client-library-build-errors" aria-haspopup="dialog" aria-label="Share link: Client Library Build Errors"> Share link </button> </h4>Go: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash"># Clear module cache go clean -modcache go mod download </code></pre></div>Python: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash"># Upgrade pip and reinstall pip install --upgrade pip pip install --force-reinstall geode-client </code></pre></div>Rust: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash"># Update dependencies cargo update cargo clean cargo build </code></pre></div>Zig: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash"># Clear cache rm -rf zig-cache .zig-cache zig build </code></pre></div> <h4 id="slow-queries" class="position-relative d-flex align-items-center group"> Slow Queries <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="slow-queries" aria-haspopup="dialog" aria-label="Share link: Slow Queries"> Share link </button> </h4>Symptom: Queries taking longer than expected Solutions: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash"># 1. Check query execution plan geode shell geode> EXPLAIN MATCH (n:Person) RETURN n # 2. Add indexes for frequently queried properties CREATE INDEX person_name ON :Person(name) # 3. Profile the query geode> PROFILE MATCH (n:Person) RETURN n </code></pre></div><hr> <h3 id="next-steps" class="position-relative d-flex align-items-center group"> Next Steps <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="next-steps" aria-haspopup="dialog" aria-label="Share link: Next Steps"> Share link </button> </h3>Now that Geode is installed: <ol> <li>Quick Start: Follow the <a href="/guides/quick-start/" >Quick Start Guide</a> to create your first graph</li> <li>Build an Application: See <a href="/guides/first-application/" >Building Your First Application</a> </li> <li>Learn GQL: Explore the <a href="/docs/gql-reference/" >GQL Reference</a> </li> <li>Design Your Schema: Read the <a href="/guides/graph-modeling/" >Graph Modeling Guide</a> </li> <li>Production Setup: Review <a href="/guides/production-deployment/" >Production Deployment</a> </li> </ol> <hr> <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><ul> <li><a href="/docs/" >Full Documentation</a> </li> <li><a href="/clients/" >Client Library APIs</a> </li> <li><a href="/docs/use-cases/" >Use Cases</a> </li> <li><a href="https://forum.geodedb.com" aria-label="Community Forum – opens in new window" target="_blank" rel="noopener noreferrer" >Community Forum ↗ </a> </li> <li><a href="https://gitlab.com/devnw/codepros/geode" aria-label="GitLab Repository – opens in new window" target="_blank" rel="noopener noreferrer" >GitLab Repository ↗ </a> </li> </ul> <h3 id="get-help" class="position-relative d-flex align-items-center group"> Get Help <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="get-help" aria-haspopup="dialog" aria-label="Share link: Get Help"> Share link </button> </h3><ul> <li><a href="https://docs.geodedb.com" aria-label="Documentation – opens in new window" target="_blank" rel="noopener noreferrer" >Documentation ↗ </a> </li> <li><a href="https://gitlab.com/devnw/codepros/geode/geode/-/issues" aria-label="GitLab Issues – opens in new window" target="_blank" rel="noopener noreferrer" >GitLab Issues ↗ </a> </li> <li><a href="https://chat.geodedb.com" aria-label="Community Chat – opens in new window" target="_blank" rel="noopener noreferrer" >Community Chat ↗ </a> </li> <li><a href="mailto:[email protected]" >Email Support</a> </li> </ul>

Related Guides

Client Library Comparison

Quick Start Guide