Command-Line Interface

<h2 id="command-line-interface" class="position-relative d-flex align-items-center group"> Command-Line Interface <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="command-line-interface" aria-haspopup="dialog" aria-label="Share link: Command-Line Interface"> 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>The Geode command-line interface (CLI) provides comprehensive tools for database administration, interactive query execution, server management, and automation. The CLI is the primary interface for operators, developers, and administrators working with Geode databases. <h3 id="introduction-to-geode-cli" class="position-relative d-flex align-items-center group"> Introduction to Geode CLI <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="introduction-to-geode-cli" aria-haspopup="dialog" aria-label="Share link: Introduction to Geode CLI"> Share link </button> </h3>The Geode CLI is a unified tool that combines server management, an interactive GQL shell (REPL), administrative commands, backup and recovery operations, and monitoring and diagnostics. Built with the same Zig codebase as the server, the CLI provides native performance and direct access to all database features. The CLI follows Unix philosophy with composable commands, pipe-friendly output, consistent exit codes, and comprehensive help documentation. All commands support both interactive and scripted usage. <h3 id="installation-and-setup" class="position-relative d-flex align-items-center group"> Installation and 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="installation-and-setup" aria-haspopup="dialog" aria-label="Share link: Installation and Setup"> Share link </button> </h3> <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><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash"># Install from package manager (Debian/Ubuntu) sudo apt-get update sudo apt-get install geode # Install from package manager (macOS) brew install geodedb/geode/geode # Verify installation geode version # Show help geode --help geode help </code></pre></div> <h4 id="configuration" class="position-relative d-flex align-items-center group"> 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="configuration" aria-haspopup="dialog" aria-label="Share link: Configuration"> Share link </button> </h4>Configure CLI defaults: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash"># Set default connection geode config set connection.default=localhost:3141 # Set output format geode config set output.format=table # table, json, csv # Set editor for query editing geode config set editor=$EDITOR # View configuration geode config list # Configuration file location: ~/.config/geode/config.toml </code></pre></div> <h3 id="interactive-shell" class="position-relative d-flex align-items-center group"> Interactive Shell <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="interactive-shell" aria-haspopup="dialog" aria-label="Share link: Interactive Shell"> Share link </button> </h3> <h4 id="starting-the-shell" class="position-relative d-flex align-items-center group"> Starting the Shell <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="starting-the-shell" aria-haspopup="dialog" aria-label="Share link: Starting the Shell"> Share link </button> </h4>The interactive shell provides a REPL (Read-Eval-Print Loop) for GQL queries: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash"># Start interactive shell geode shell # Connect to specific server geode shell --connect geode.example.com:3141 # Connect with authentication geode shell --connect localhost:3141 --user admin --password # Start with specific database geode shell --database mydb </code></pre></div>Shell session example: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-text" data-lang="text">Geode Shell v0.2.18 Connected to localhost:3141 Database: graph Type \help for help, \quit to exit geode> MATCH (n:User) RETURN n.name, n.age LIMIT 5; +------------+--------+ | n.name | n.age | +------------+--------+ | Alice | 30 | | Bob | 25 | | Charlie | 35 | | David | 28 | | Eve | 32 | +------------+--------+ 5 rows (12 ms) geode> \timing on Timing enabled. geode> MATCH (n:User) RETURN COUNT(n); +-----------+ | COUNT(n) | +-----------+ | 1000000 | +-----------+ 1 row (145 ms) </code></pre></div> <h4 id="shell-commands" class="position-relative d-flex align-items-center group"> Shell Commands <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="shell-commands" aria-haspopup="dialog" aria-label="Share link: Shell Commands"> Share link </button> </h4>Meta-commands (starting with backslash) control shell behavior: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash"># Help and documentation \help # Show all commands \help CREATE # Help for specific GQL command \? # Alias for \help # Connection management \connect localhost:3141 # Connect to database \disconnect # Disconnect \reconnect # Reconnect to current database # Query execution \e # Edit query in external editor \g # Execute current query (same as ;) \timing on|off # Show/hide query execution time \watch 5 # Re-execute query every 5 seconds # Output formatting \format table # Table format (default) \format json # JSON output \format csv # CSV output \format yaml # YAML output \expanded on|off # Toggle expanded/vertical output \pset border 2 # Set table border style (0-2) # Transaction control \begin # Begin transaction \commit # Commit transaction \rollback # Rollback transaction \savepoint name # Create savepoint # Schema exploration \dn # List node labels \dr # List relationship types \di # List indexes \dt # List all types \d User # Describe User label # Query history \history # Show command history \! <command> # Execute shell command \set VAR value # Set shell variable \echo message # Print message # File operations \i filename.gql # Execute queries from file \o output.txt # Write output to file \o # Stop writing to file # Quit \q # Quit shell \quit # Quit shell (alias) exit # Exit shell </code></pre></div> <h4 id="multi-line-queries" class="position-relative d-flex align-items-center group"> Multi-line 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="multi-line-queries" aria-haspopup="dialog" aria-label="Share link: Multi-line Queries"> Share link </button> </h4>The shell supports multi-line query editing: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-sql" data-lang="sql">geode> MATCH (p:Person)-[:KNOWS]->(friend:Person) -> WHERE p.name = 'Alice' -> RETURN friend.name, friend.age -> ORDER BY friend.age DESC; +---------------+-------------+ | friend.name | friend.age | +---------------+-------------+ | Bob | 35 | | Charlie | 32 | | David | 28 | +---------------+-------------+ 3 rows (8 ms) </code></pre></div> <h3 id="server-management" class="position-relative d-flex align-items-center group"> Server Management <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="server-management" aria-haspopup="dialog" aria-label="Share link: Server Management"> Share link </button> </h3> <h4 id="starting-and-stopping" class="position-relative d-flex align-items-center group"> Starting and Stopping <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="starting-and-stopping" aria-haspopup="dialog" aria-label="Share link: Starting and Stopping"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash"># Start server geode serve --listen 0.0.0.0:3141 # Start with configuration file geode serve --config /etc/geode/geode.conf # Start as daemon geode serve --daemon --pid-file /var/run/geode.pid # Stop server geode stop # Stop with specific PID file geode stop --pid-file /var/run/geode.pid # Restart server geode restart # Reload configuration (without restart) geode reload </code></pre></div> <h4 id="server-status" class="position-relative d-flex align-items-center group"> 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="server-status" aria-haspopup="dialog" aria-label="Share link: Server Status"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash"># Check server status geode status # Detailed status with metrics geode status --verbose # Output as JSON geode status --format json # Monitor server in real-time geode status --watch 1 # Update every second </code></pre></div> <h3 id="query-execution" class="position-relative d-flex align-items-center group"> Query Execution <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="query-execution" aria-haspopup="dialog" aria-label="Share link: Query Execution"> Share link </button> </h3> <h4 id="non-interactive-queries" class="position-relative d-flex align-items-center group"> Non-Interactive 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="non-interactive-queries" aria-haspopup="dialog" aria-label="Share link: Non-Interactive Queries"> Share link </button> </h4>Execute queries from command line: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash"># Execute single query geode query "MATCH (n:User) RETURN COUNT(n)" # Execute with output format geode query "MATCH (n:User) RETURN n.name, n.age LIMIT 10" --format table # Execute with parameters geode query "MATCH (n:User {id: \$id}) RETURN n" \ --param id=123 \ --format json # Read query from file geode query --file queries/user-report.gql # Read from stdin cat query.gql | geode query # Output to file geode query "MATCH (n) RETURN n" --output results.csv --format csv </code></pre></div> <h4 id="batch-query-execution" class="position-relative d-flex align-items-center group"> Batch Query Execution <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="batch-query-execution" aria-haspopup="dialog" aria-label="Share link: Batch Query Execution"> Share link </button> </h4>Execute multiple queries from files: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash"># Execute all queries in file geode batch --file migrations/schema-v2.gql # Execute with transaction geode batch --file migrations/data-migration.gql --transaction # Execute directory of files geode batch --directory migrations/ --pattern "*.gql" --order=name # Parallel execution (independent queries) geode batch --directory queries/ --parallel=4 # Continue on errors geode batch --file queries.gql --continue-on-error \ --error-log /tmp/errors.log </code></pre></div> <h3 id="administration-commands" class="position-relative d-flex align-items-center group"> Administration Commands <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="administration-commands" aria-haspopup="dialog" aria-label="Share link: Administration Commands"> Share link </button> </h3> <h4 id="user-management" class="position-relative d-flex align-items-center group"> User Management <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="user-management" aria-haspopup="dialog" aria-label="Share link: User Management"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash"># Create user geode admin user create --username alice --password --role admin # List users geode admin user list # Change password geode admin user password --username alice # Grant role geode admin user grant --username alice --role read_write # Revoke role geode admin user revoke --username alice --role admin # Delete user geode admin user delete --username alice </code></pre></div> <h4 id="database-management" class="position-relative d-flex align-items-center group"> Database Management <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="database-management" aria-haspopup="dialog" aria-label="Share link: Database Management"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash"># Create database geode admin database create --name testdb # List databases geode admin database list # Describe database geode admin database describe --name testdb # Drop database geode admin database drop --name testdb --confirm # Database statistics geode admin database stats --name graph </code></pre></div> <h4 id="index-management" class="position-relative d-flex align-items-center group"> Index Management <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="index-management" aria-haspopup="dialog" aria-label="Share link: Index Management"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash"># Create index geode admin index create --label User --property email # List indexes geode admin index list # Describe index geode admin index describe --name idx_user_email # Rebuild index geode admin index rebuild --name idx_user_email # Drop index geode admin index drop --name idx_user_email </code></pre></div> <h3 id="backup-and-recovery" class="position-relative d-flex align-items-center group"> Backup and Recovery <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-and-recovery" aria-haspopup="dialog" aria-label="Share link: Backup and Recovery"> Share link </button> </h3> <h4 id="backup-operations" class="position-relative d-flex align-items-center group"> Backup Operations <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-operations" aria-haspopup="dialog" aria-label="Share link: Backup Operations"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash"># Create full backup geode backup create --type full --output /backups/geode-full.tar.gz # Create incremental backup geode backup create --type incremental \ --base /backups/geode-full.tar.gz \ --output /backups/geode-incr-$(date +%Y%m%d).tar.gz # List backups geode backup list --directory /backups # Verify backup geode backup verify /backups/geode-full.tar.gz # Schedule automatic backups geode backup schedule --type full --cron "0 2 * * *" \ --output /backups/daily/geode-%Y%m%d.tar.gz </code></pre></div> <h4 id="recovery-operations" class="position-relative d-flex align-items-center group"> Recovery Operations <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="recovery-operations" aria-haspopup="dialog" aria-label="Share link: Recovery Operations"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash"># Restore from backup geode restore --backup /backups/geode-full.tar.gz \ --target /var/lib/geode # Point-in-time recovery geode recover \ --backup /backups/geode-full.tar.gz \ --wal-archive /wal-archive \ --target-time "2026-01-24 14:30:00" # Verify restored database geode verify --data-dir /var/lib/geode --full-scan </code></pre></div> <h3 id="monitoring-and-diagnostics" class="position-relative d-flex align-items-center group"> Monitoring and Diagnostics <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="monitoring-and-diagnostics" aria-haspopup="dialog" aria-label="Share link: Monitoring and Diagnostics"> Share link </button> </h3> <h4 id="performance-monitoring" class="position-relative d-flex align-items-center group"> Performance Monitoring <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="performance-monitoring" aria-haspopup="dialog" aria-label="Share link: Performance Monitoring"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash"># Show current metrics geode metrics # Continuous monitoring geode metrics --watch 1 # Specific metric groups geode metrics --group queries,connections,performance # Export metrics for Prometheus geode metrics --format prometheus > /var/lib/prometheus/geode.prom </code></pre></div> <h4 id="query-analysis" class="position-relative d-flex align-items-center group"> Query Analysis <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="query-analysis" aria-haspopup="dialog" aria-label="Share link: Query Analysis"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash"># Explain query geode query "EXPLAIN MATCH (n:User) RETURN n" --format yaml # Profile query geode query "PROFILE MATCH (n:User) RETURN n" --format json # Analyze slow queries geode admin slow-queries --min-duration 1000 # Queries >1 second # Query statistics geode admin query-stats --top 10 # Top 10 queries by execution time </code></pre></div> <h4 id="system-diagnostics" class="position-relative d-flex align-items-center group"> System Diagnostics <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-diagnostics" aria-haspopup="dialog" aria-label="Share link: System Diagnostics"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash"># Health check geode admin health # Connection diagnostics geode admin connections list geode admin connections show --id conn-123 # Resource usage geode admin resources # Logs geode logs --tail 100 geode logs --level error --since "1 hour ago" geode logs --follow # Continuous log streaming </code></pre></div> <h3 id="scripting-and-automation" class="position-relative d-flex align-items-center group"> Scripting and Automation <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="scripting-and-automation" aria-haspopup="dialog" aria-label="Share link: Scripting and Automation"> Share link </button> </h3> <h4 id="shell-scripting" class="position-relative d-flex align-items-center group"> Shell Scripting <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="shell-scripting" aria-haspopup="dialog" aria-label="Share link: Shell Scripting"> Share link </button> </h4>Integrate Geode CLI in shell scripts: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash">#!/bin/bash # Check if server is running if ! geode status --quiet; then echo "Geode is not running" exit 1 fi # Execute query and capture output RESULT=$(geode query "MATCH (n:User) RETURN COUNT(n)" --format json) COUNT=$(echo "$RESULT" | jq -r '.data[0]["COUNT(n)"]') echo "Total users: $COUNT" # Conditional execution if [ "$COUNT" -gt 1000000 ]; then echo "Running maintenance..." geode admin vacuum --analyze fi # Exit codes # 0 = success # 1 = error # 2 = connection failed </code></pre></div> <h4 id="csv-importexport" class="position-relative d-flex align-items-center group"> CSV Import/Export <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="csv-importexport" aria-haspopup="dialog" aria-label="Share link: CSV Import/Export"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash"># Export to CSV geode query "MATCH (n:User) RETURN n.id, n.name, n.email" \ --format csv \ --output users.csv # Import from CSV geode import csv \ --input users.csv \ --node-label User \ --id-column 0 \ --property-columns 1,2 \ --property-names name,email </code></pre></div> <h4 id="json-processing" class="position-relative d-flex align-items-center group"> JSON Processing <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="json-processing" aria-haspopup="dialog" aria-label="Share link: JSON Processing"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash"># Query with JSON output for processing geode query "MATCH (n:User) RETURN n" --format json | \ jq '.data[].n.properties | {id, name, email}' # Combine with other tools geode query "MATCH (n:User) RETURN n.email" --format json | \ jq -r '.data[].["n.email"]' | \ mail -s "User emails" [email protected] </code></pre></div> <h3 id="best-practices" class="position-relative d-flex align-items-center group"> Best Practices <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="best-practices" aria-haspopup="dialog" aria-label="Share link: Best Practices"> Share link </button> </h3><ol> <li>Configuration: Use configuration files for repeated connection settings</li> <li>Scripting: Use <code>--format json</code> for scripting and automation</li> <li>Error Handling: Check exit codes in scripts for proper error handling</li> <li>Parameters: Always use parameterized queries to prevent injection</li> <li>Transactions: Use transactions for multi-query operations requiring atomicity</li> <li>Logging: Enable logging for troubleshooting and auditing</li> <li>Aliases: Create shell aliases for frequently used commands</li> <li>Documentation: Document automation scripts and scheduled tasks</li> </ol> <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-issues" class="position-relative d-flex align-items-center group"> Connection 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="connection-issues" aria-haspopup="dialog" aria-label="Share link: Connection Issues"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash"># Test connectivity geode admin ping --host localhost:3141 # Verbose connection diagnostics geode shell --connect localhost:3141 --verbose # Check logs geode logs --filter connection --level debug </code></pre></div> <h4 id="performance-issues" class="position-relative d-flex align-items-center group"> Performance 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="performance-issues" aria-haspopup="dialog" aria-label="Share link: Performance Issues"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash"># Profile slow query geode query "PROFILE MATCH (n)-[r*1..5]-(m) RETURN COUNT(*)" \ --format yaml # Check server resources geode admin resources --watch 1 # Analyze query plan geode query "EXPLAIN MATCH (n:User) WHERE n.email = '[email protected]' RETURN n" </code></pre></div> <h4 id="data-issues" class="position-relative d-flex align-items-center group"> Data 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="data-issues" aria-haspopup="dialog" aria-label="Share link: Data Issues"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash"># Verify database integrity geode verify --full-scan # Check for corrupted indexes geode admin index verify --all # Repair database geode admin repair --backup-first --verify-after </code></pre></div> <h3 id="related-topics" class="position-relative d-flex align-items-center group"> Related Topics <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="related-topics" aria-haspopup="dialog" aria-label="Share link: Related Topics"> Share link </button> </h3><ul> <li><a href="/tags/repl/" >REPL</a> - Interactive shell features</li> <li><a href="/tags/server/" >Server Configuration</a> - Server management</li> <li><a href="/tags/backup/" >Backup</a> - Backup and recovery</li> <li><a href="/tags/monitoring/" >Monitoring</a> - Monitoring and metrics</li> </ul> <h3 id="further-reading" class="position-relative d-flex align-items-center group"> Further Reading <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="further-reading" aria-haspopup="dialog" aria-label="Share link: Further Reading"> Share link </button> </h3><ul> <li><a href="/docs/reference/cli-and-api/" >CLI and API Reference</a> - Complete command reference</li> <li><a href="/docs/architecture/cli-design/" >CLI Design</a> - CLI architecture documentation</li> <li><a href="/docs/tutorials/repl-basics/" >REPL Basics</a> - Interactive shell tutorial</li> <li><a href="/docs/query/performance-tuning/" >Performance Tuning</a> - Performance optimization</li> </ul>

Popular

Related Articles

API Reference and CLI Manual

CLI Architecture and Unified Binary Design

Reference

REPL Interactive Shell Basics