Tag: Read-Eval-Print Loop (REPL)

Geode documentation tagged with Read-Eval-Print Loop (REPL). The REPL is an interactive shell that reads GQL commands, evaluates them against your database, and prints results immediately—the primary tool for exploratory analysis, query development, and learning GQL. <h3 id="introduction-to-the-repl" class="position-relative d-flex align-items-center group"> Introduction to the REPL <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="introduction-to-the-repl" aria-haspopup="dialog" aria-label="Share link: Introduction to the REPL"> Share link </button> </h3><div id="headingShareModal" class="heading-share-modal" role="dialog" aria-modal="true" aria-labelledby="headingShareTitle" hidden> <div class="hsm-dialog" role="document"> <div class="hsm-header"> <h2 id="headingShareTitle" class="h6 mb-0 fw-bold">Share this section</h2> <button type="button" class="hsm-close" aria-label="Close"> </button> </div> <div class="hsm-body"> <label for="headingShareInput" class="form-label small text-muted mb-1 text-uppercase fw-bold" style="font-size: 0.7rem; letter-spacing: 0.5px;">Permalink</label> <div class="input-group mb-4 hsm-url-group"> <input id="headingShareInput" type="text" class="form-control font-monospace" readonly aria-readonly="true" style="font-size: 0.85rem;" /> <button class="btn btn-primary hsm-copy" type="button" aria-label="Copy" title="Copy"> </button> </div> <div class="small fw-bold mb-2 text-muted text-uppercase" style="font-size: 0.7rem; letter-spacing: 0.5px;">Share via</div> <div class="hsm-share-grid"> <a id="share-twitter" class="btn btn-outline-secondary w-100" target="_blank" rel="noopener noreferrer"> Twitter </a> <a id="share-linkedin" class="btn btn-outline-secondary w-100" target="_blank" rel="noopener noreferrer"> LinkedIn </a> <a id="share-facebook" class="btn btn-outline-secondary w-100" target="_blank" rel="noopener noreferrer"> Facebook </a> </div> </div> </div> </div> <style> .heading-share-modal { position: fixed; inset: 0; display: flex; justify-content: center; align-items: center; background: rgba(0, 0, 0, 0.6); z-index: 1050; padding: 1rem; backdrop-filter: blur(4px); -webkit-backdrop-filter: blur(4px); } .heading-share-modal[hidden] { display: none !important; } .hsm-dialog { max-width: 420px; width: 100%; background: var(--bs-body-bg, #fff); color: var(--bs-body-color, #212529); border: 1px solid var(--bs-border-color, rgba(0,0,0,0.1)); border-radius: 1rem; box-shadow: 0 25px 50px -12px rgba(0, 0, 0, 0.25); overflow: hidden; animation: hsm-fade-in 0.2s ease-out; } @keyframes hsm-fade-in { from { opacity: 0; transform: scale(0.95); } to { opacity: 1; transform: scale(1); } } [data-bs-theme="dark"] .hsm-dialog { background: #1e293b; border-color: rgba(255,255,255,0.1); color: #f8f9fa; } .hsm-header { display: flex; justify-content: space-between; align-items: center; padding: 1rem 1.5rem; border-bottom: 1px solid var(--bs-border-color, rgba(0,0,0,0.1)); background: rgba(0,0,0,0.02); } [data-bs-theme="dark"] .hsm-header { background: rgba(255,255,255,0.02); border-color: rgba(255,255,255,0.1); } .hsm-close { background: transparent; border: none; color: inherit; opacity: 0.5; padding: 0.25rem 0.5rem; border-radius: 0.25rem; font-size: 1.2rem; line-height: 1; transition: opacity 0.2s; } .hsm-close:hover { opacity: 1; } .hsm-body { padding: 1.5rem; } .hsm-url-group { display: flex !important; align-items: stretch; } .hsm-url-group .form-control { flex: 1; min-width: 0; margin: 0; background: var(--bs-secondary-bg, #f8f9fa); border-color: var(--bs-border-color, #dee2e6); border-top-right-radius: 0; border-bottom-right-radius: 0; height: 42px; } .hsm-url-group .btn { flex: 0 0 auto; margin: 0; margin-left: -1px; border-top-left-radius: 0; border-bottom-left-radius: 0; height: 42px; display: flex; align-items: center; justify-content: center; padding: 0 1.25rem; z-index: 2; } [data-bs-theme="dark"] .hsm-url-group .form-control { background: #0f172a; border-color: #334155; color: #e2e8f0; } .hsm-share-grid { display: flex; flex-direction: column; gap: 0.5rem; } .hsm-share-grid .btn { display: flex; align-items: center; justify-content: center; font-size: 0.9rem; padding: 0.6rem; border-color: var(--bs-border-color); width: 100%; } [data-bs-theme="dark"] .hsm-share-grid .btn { color: #e2e8f0; border-color: #475569; } [data-bs-theme="dark"] .hsm-share-grid .btn:hover { background: #334155; border-color: #cbd5e1; } </style> <script> (function(){ const modal = document.getElementById('headingShareModal'); if(!modal) return; const input = modal.querySelector('#headingShareInput'); const copyBtn = modal.querySelector('.hsm-copy'); const twitter = modal.querySelector('#share-twitter'); const linkedin = modal.querySelector('#share-linkedin'); const facebook = modal.querySelector('#share-facebook'); const closeBtn = modal.querySelector('.hsm-close'); let lastFocus=null; let trapBound=false; function buildUrl(id){ return window.location.origin + window.location.pathname + '#' + id; } function isOpen(){ return !modal.hasAttribute('hidden'); } function hydrate(id){ const url=buildUrl(id); input.value=url; const enc=encodeURIComponent(url); const text=encodeURIComponent(document.title); if(twitter) twitter.href=`https://twitter.com/intent/tweet?url=${enc}&text=${text}`; if(linkedin) linkedin.href=`https://www.linkedin.com/sharing/share-offsite/?url=${enc}`; if(facebook) facebook.href=`https://www.facebook.com/sharer/sharer.php?u=${enc}`; } function openModal(id){ lastFocus=document.activeElement; hydrate(id); if(!isOpen()){ modal.removeAttribute('hidden'); } requestAnimationFrame(()=>{ input.focus(); }); trapFocus(); } function closeModal(){ if(!isOpen()) return; modal.setAttribute('hidden',''); if(lastFocus && typeof lastFocus.focus==='function') lastFocus.focus(); } function copyCurrent(){ try{ navigator.clipboard.writeText(input.value).then(()=>feedback(true),()=>fallback()); } catch(e){ fallback(); } } function fallback(){ input.select(); try{ document.execCommand('copy'); feedback(true);}catch(e){ feedback(false);} } function feedback(ok){ if(!copyBtn) return; const icon=copyBtn.querySelector('i'); if(!icon) return; const prev=copyBtn.getAttribute('data-prev')||icon.className; if(!copyBtn.getAttribute('data-prev')) copyBtn.setAttribute('data-prev',prev); icon.className= ok ? 'fa-duotone fa-clipboard-check':'fa-duotone fa-circle-exclamation'; setTimeout(()=>{ icon.className=prev; },1800); } function handleShareClick(e){ e.preventDefault(); const btn=e.currentTarget; const id=btn.getAttribute('data-share-target'); if(id) openModal(id); } function bindShareButtons(){ document.querySelectorAll('.h-share').forEach(btn=>{ if(!btn.dataset.hShareBound){ btn.addEventListener('click', handleShareClick); btn.dataset.hShareBound='1'; } }); } bindShareButtons(); if(document.readyState==='loading'){ document.addEventListener('DOMContentLoaded', bindShareButtons); } else { requestAnimationFrame(bindShareButtons); } document.addEventListener('click', function(e){ const shareBtn=e.target.closest && e.target.closest('.h-share'); if(shareBtn && !shareBtn.dataset.hShareBound){ handleShareClick.call(shareBtn, e); } }, true); document.addEventListener('click', e=>{ if(e.target===modal) closeModal(); if(e.target.closest && e.target.closest('.hsm-close')){ e.preventDefault(); closeModal(); } if(copyBtn && (e.target===copyBtn || (e.target.closest && e.target.closest('.hsm-copy')))) { e.preventDefault(); copyCurrent(); } }); document.addEventListener('keydown', e=>{ if(e.key==='Escape' && isOpen()) closeModal(); }); function trapFocus(){ if(trapBound) return; trapBound=true; modal.addEventListener('keydown', f=>{ if(f.key==='Tab' && isOpen()){ const focusable=[...modal.querySelectorAll('a[href],button,input,textarea,select,[tabindex]:not([tabindex="-1"])')].filter(el=>!el.hasAttribute('disabled')); if(!focusable.length) return; const first=focusable[0]; const last=focusable[focusable.length-1]; if(f.shiftKey && document.activeElement===first){ f.preventDefault(); last.focus(); } else if(!f.shiftKey && document.activeElement===last){ f.preventDefault(); first.focus(); } } }); } if(closeBtn) closeBtn.addEventListener('click', e=>{ e.preventDefault(); closeModal(); }); })(); </script>A Read-Eval-Print Loop (REPL) is an interactive programming environment that accepts user input, executes it, and displays the result. REPLs have been fundamental to programming since the 1960s, popularized by Lisp and later adopted by languages like Python, Ruby, and JavaScript. For databases, REPLs provide immediate feedback for query development, making them essential tools for exploration and debugging. Geode’s REPL, invoked with <code>geode shell</code>, provides a rich interactive environment for working with graph data. Unlike batch query execution or programmatic access through client libraries, the REPL emphasizes immediate feedback and iterative refinement. You type a GQL query, press Enter, and see results instantly. This tight feedback loop accelerates learning, enables rapid prototyping, and makes debugging far more efficient than edit-compile-run cycles. The Geode REPL goes beyond simple query execution to provide a comprehensive development environment. Features include syntax highlighting, auto-completion for keywords and labels, query history with search, multi-line editing for complex queries, and formatted result display with automatic table rendering. Transaction management, meta-commands for database introspection, and session persistence make the REPL suitable for both quick experiments and extended development sessions. <h3 id="key-concepts" class="position-relative d-flex align-items-center group"> Key Concepts <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="key-concepts" aria-haspopup="dialog" aria-label="Share link: Key Concepts"> Share link </button> </h3> <h4 id="interactive-query-execution" class="position-relative d-flex align-items-center group"> Interactive 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="interactive-query-execution" aria-haspopup="dialog" aria-label="Share link: Interactive Query Execution"> Share link </button> </h4>The core REPL workflow: <ol> <li>Prompt: Display <code>geode></code> prompt waiting for input</li> <li>Read: Accept GQL query or meta-command from user</li> <li>Evaluate: Execute query against database</li> <li>Print: Display formatted results</li> <li>Loop: Return to prompt for next command</li> </ol> <h4 id="multi-line-editing" class="position-relative d-flex align-items-center group"> Multi-Line Editing <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-editing" aria-haspopup="dialog" aria-label="Share link: Multi-Line Editing"> Share link </button> </h4>Complex queries span multiple lines: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-fallback" data-lang="fallback">geode> MATCH (p:Person)-[:WORKS_AT]->(c:Company) WHERE p.age > 30 AND c.industry = 'Technology' RETURN p.name, c.name, p.salary ORDER BY p.salary DESC LIMIT 10; </code></pre></div>The REPL detects incomplete statements and continues accepting input until a semicolon or empty line. <h4 id="result-formatting" class="position-relative d-flex align-items-center group"> Result Formatting <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="result-formatting" aria-haspopup="dialog" aria-label="Share link: Result Formatting"> Share link </button> </h4>Results are displayed in readable tables: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-fallback" data-lang="fallback">geode> MATCH (p:Person) RETURN p.name, p.age LIMIT 3; ╭──────────────┬──────────╮ │ p.name │ p.age │ ├──────────────┼──────────┤ │ Alice Smith │ 32 │ │ Bob Johnson │ 28 │ │ Carol Davis │ 45 │ ╰──────────────┴──────────╯ 3 rows (15.2ms) </code></pre></div> <h4 id="meta-commands" class="position-relative d-flex align-items-center group"> Meta-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="meta-commands" aria-haspopup="dialog" aria-label="Share link: Meta-Commands"> Share link </button> </h4>Meta-commands provide database introspection: <ul> <li><code>\l</code> - List available graphs</li> <li><code>\dt</code> - List node labels and relationship types</li> <li><code>\d <label></code> - Describe label properties</li> <li><code>\timing on</code> - Enable query timing</li> <li><code>\explain <query></code> - Show query execution plan</li> <li><code>\profile <query></code> - Profile query execution</li> <li><code>\history</code> - Show command history</li> <li><code>\save <file></code> - Save session to file</li> <li><code>\load <file></code> - Load and execute file</li> </ul> <h4 id="session-management" class="position-relative d-flex align-items-center group"> Session 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="session-management" aria-haspopup="dialog" aria-label="Share link: Session Management"> Share link </button> </h4>REPL sessions maintain state: <ul> <li>Transaction Context: BEGIN/COMMIT/ROLLBACK manage transaction scope</li> <li>Variable Binding: Store query results for later reference</li> <li>History: Full command history with Up/Down arrow navigation</li> <li>Settings: Persistent configuration (display format, timing, etc.)</li> </ul> <h3 id="how-the-repl-works-in-geode" class="position-relative d-flex align-items-center group"> How the REPL Works in 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="how-the-repl-works-in-geode" aria-haspopup="dialog" aria-label="Share link: How the REPL Works in Geode"> Share link </button> </h3> <h4 id="starting-the-repl" class="position-relative d-flex align-items-center group"> Starting the REPL <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="starting-the-repl" aria-haspopup="dialog" aria-label="Share link: Starting the REPL"> Share link </button> </h4>Launch the interactive shell: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash"># Start REPL connected to local server geode shell # Connect to remote server geode shell --host db.example.com --port 3141 # Authenticate with username/password geode shell --user admin --password # Connect with TLS certificate geode shell --cert client.crt --key client.key </code></pre></div> <h4 id="query-execution-flow" class="position-relative d-flex align-items-center group"> Query Execution Flow <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-flow" aria-haspopup="dialog" aria-label="Share link: Query Execution Flow"> Share link </button> </h4>When you execute a query in the REPL: <ol> <li>Input Collection: REPL accumulates input lines until complete statement</li> <li>Syntax Highlighting: Keywords, strings, and operators highlighted in color</li> <li>Client Transmission: Query sent to server via QUIC connection</li> <li>Server Processing: Query parsed, optimized, and executed</li> <li>Result Streaming: Results stream back to client</li> <li>Rendering: REPL formats results as tables or JSON</li> <li>Timing Display: Execution time displayed</li> </ol> <h4 id="interactive-features" class="position-relative d-flex align-items-center group"> Interactive Features <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-features" aria-haspopup="dialog" aria-label="Share link: Interactive Features"> Share link </button> </h4>The REPL provides rich editing capabilities: <ul> <li>Tab Completion: Complete keywords, labels, properties</li> <li>History Search: Ctrl+R for reverse history search</li> <li>Line Editing: Emacs or Vi key bindings</li> <li>Syntax Validation: Real-time syntax checking</li> <li>Error Display: Detailed error messages with line/column</li> </ul> <h4 id="transaction-management" class="position-relative d-flex align-items-center group"> Transaction 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="transaction-management" aria-haspopup="dialog" aria-label="Share link: Transaction Management"> Share link </button> </h4>Manage transactions interactively: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-fallback" data-lang="fallback">geode> BEGIN; Transaction started (txn:550e8400) geode> INSERT (:Person {name: 'Eve', age: 29}); 1 row inserted (5.2ms) geode> MATCH (p:Person {name: 'Eve'}) RETURN p.name; ╭────────╮ │ p.name │ ├────────┤ │ Eve │ ╰────────╯ geode> COMMIT; Transaction committed (12.3ms) </code></pre></div> <h3 id="use-cases" class="position-relative d-flex align-items-center group"> Use Cases <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="use-cases" aria-haspopup="dialog" aria-label="Share link: Use Cases"> Share link </button> </h3> <h4 id="exploratory-data-analysis" class="position-relative d-flex align-items-center group"> Exploratory Data 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="exploratory-data-analysis" aria-haspopup="dialog" aria-label="Share link: Exploratory Data Analysis"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-fallback" data-lang="fallback">geode> -- Explore graph structure geode> MATCH (n) RETURN DISTINCT labels(n) AS label, count(*) AS count; ╭────────────┬───────╮ │ label │ count │ ├────────────┼───────┤ │ Person │ 1523 │ │ Company │ 245 │ │ Product │ 3421 │ ╰────────────┴───────╯ geode> -- Examine specific node geode> MATCH (p:Person {name: 'Alice'}) RETURN p; ╭────────────────────────────────────────╮ │ p │ ├────────────────────────────────────────┤ │ { │ │ "id": "node:12345", │ │ "labels": ["Person"], │ │ "properties": { │ │ "name": "Alice", │ │ "age": 32, │ │ "email": "[email protected]" │ │ } │ │ } │ ╰────────────────────────────────────────╯ geode> -- Find relationship patterns geode> MATCH (p:Person)-[r]->(c:Company) RETURN type(r) AS rel_type, count(*) AS count ORDER BY count DESC; ╭──────────────┬───────╮ │ rel_type │ count │ ├──────────────┼───────┤ │ WORKS_AT │ 1205 │ │ INVESTED_IN │ 142 │ │ FOUNDED │ 38 │ ╰──────────────┴───────╯ </code></pre></div> <h4 id="query-development-and-testing" class="position-relative d-flex align-items-center group"> Query Development and Testing <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="query-development-and-testing" aria-haspopup="dialog" aria-label="Share link: Query Development and Testing"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-fallback" data-lang="fallback">geode> -- Test query incrementally geode> MATCH (p:Person) WHERE p.age > 30 RETURN count(*); ╭──────────╮ │ count(*) │ ├──────────┤ │ 823 │ ╰──────────╯ geode> -- Add more conditions geode> MATCH (p:Person) WHERE p.age > 30 AND p.city = 'Seattle' RETURN count(*); ╭──────────╮ │ count(*) │ ├──────────┤ │ 156 │ ╰──────────╯ geode> -- Profile for performance geode> \profile MATCH (p:Person) WHERE p.age > 30 AND p.city = 'Seattle' RETURN p.name, p.email; Query Plan: ┌─ Filter (cost=0.1, rows=156) │ └─ IndexScan (Person.city = 'Seattle') │ └─ Filter (age > 30) │ └─ Return (p.name, p.email) Execution: 2.3ms (156 rows) </code></pre></div> <h4 id="learning-gql" class="position-relative d-flex align-items-center group"> Learning GQL <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="learning-gql" aria-haspopup="dialog" aria-label="Share link: Learning GQL"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-fallback" data-lang="fallback">geode> -- Try basic MATCH patterns geode> MATCH (n) RETURN n LIMIT 5; geode> -- Experiment with relationships geode> MATCH (a)-[r]->(b) RETURN a, type(r), b LIMIT 5; geode> -- Learn aggregation geode> MATCH (p:Person) RETURN p.city, count(*) AS population ORDER BY population DESC; geode> -- Practice pattern matching geode> MATCH (p:Person)-[:KNOWS]->()-[:KNOWS]->(friend) WHERE p.name = 'Alice' RETURN DISTINCT friend.name; </code></pre></div> <h4 id="database-administration" class="position-relative d-flex align-items-center group"> Database Administration <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-administration" aria-haspopup="dialog" aria-label="Share link: Database Administration"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-fallback" data-lang="fallback">geode> -- Check database size geode> \dt Labels: Person (1523 nodes) Company (245 nodes) Product (3421 nodes) Relationship Types: WORKS_AT (1205 relationships) KNOWS (3421 relationships) PURCHASED (12456 relationships) geode> -- View indexes geode> SHOW INDEXES; ╭────────────────┬──────────────────┬─────────╮ │ label │ properties │ type │ ├────────────────┼──────────────────┼─────────┤ │ Person │ [name] │ BTREE │ │ Person │ [email] │ UNIQUE │ │ Product │ [sku] │ UNIQUE │ │ Person │ [embedding] │ HNSW │ ╰────────────────┴──────────────────┴─────────╯ geode> -- Create new index geode> CREATE INDEX person_age FOR (p:Person) ON (p.age); Index created (234.5ms) </code></pre></div> <h3 id="best-practices" class="position-relative d-flex align-items-center group"> Best Practices <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="best-practices" aria-haspopup="dialog" aria-label="Share link: Best Practices"> Share link </button> </h3> <h4 id="query-development-workflow" class="position-relative d-flex align-items-center group"> Query Development Workflow <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="query-development-workflow" aria-haspopup="dialog" aria-label="Share link: Query Development Workflow"> Share link </button> </h4><ol> <li>Start Simple: Begin with basic MATCH patterns</li> <li>Add Incrementally: Add WHERE clauses and filters one at a time</li> <li>Profile Early: Use EXPLAIN/PROFILE to understand execution</li> <li>Test with LIMIT: Use LIMIT during development to avoid large result sets</li> <li>Refine Performance: Iterate based on profiling feedback</li> </ol> <h4 id="interactive-session-management" class="position-relative d-flex align-items-center group"> Interactive Session 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="interactive-session-management" aria-haspopup="dialog" aria-label="Share link: Interactive Session Management"> Share link </button> </h4><ol> <li>Use Transactions: Wrap related operations in BEGIN/COMMIT</li> <li>Save Work: Use <code>\save</code> to preserve successful queries</li> <li>History Search: Use Ctrl+R to find previous commands</li> <li>Clear Output: Use <code>\clear</code> for long sessions</li> <li>Tab Completion: Leverage auto-completion for efficiency</li> </ol> <h4 id="result-display-optimization" class="position-relative d-flex align-items-center group"> Result Display Optimization <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="result-display-optimization" aria-haspopup="dialog" aria-label="Share link: Result Display Optimization"> Share link </button> </h4><ol> <li>Limit Results: Always use LIMIT for unbounded queries</li> <li>Format Selection: Choose JSON or table format based on data</li> <li>Column Width: Adjust terminal width for readable tables</li> <li>Vertical Display: Use <code>\x</code> for wide result sets</li> <li>Paging: Use <code>\pset pager on</code> for long results</li> </ol> <h4 id="learning-and-exploration" class="position-relative d-flex align-items-center group"> Learning and Exploration <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="learning-and-exploration" aria-haspopup="dialog" aria-label="Share link: Learning and Exploration"> Share link </button> </h4><ol> <li>Experiment Freely: REPL is perfect for trying new syntax</li> <li>Use Meta-Commands: Explore <code>\?</code> for all available commands</li> <li>Read Error Messages: REPL shows detailed error information</li> <li>Copy Queries: Transfer successful queries to application code</li> <li>Practice Daily: Regular REPL use builds GQL fluency</li> </ol> <h3 id="performance-considerations" class="position-relative d-flex align-items-center group"> Performance Considerations <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="performance-considerations" aria-haspopup="dialog" aria-label="Share link: Performance Considerations"> Share link </button> </h3> <h4 id="repl-overhead" class="position-relative d-flex align-items-center group"> REPL Overhead <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="repl-overhead" aria-haspopup="dialog" aria-label="Share link: REPL Overhead"> Share link </button> </h4>REPL introduces minimal overhead: <ul> <li>Parsing: Client-side syntax highlighting adds <1ms</li> <li>Rendering: Table formatting adds 1-5ms for typical results</li> <li>Network: Same QUIC protocol as programmatic clients</li> <li>Buffering: Results stream with low memory overhead</li> </ul> <h4 id="large-result-sets" class="position-relative d-flex align-items-center group"> Large Result Sets <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="large-result-sets" aria-haspopup="dialog" aria-label="Share link: Large Result Sets"> Share link </button> </h4>Handle large results efficiently: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gdscript3" data-lang="gdscript3">geode> -- Use LIMIT during exploration geode> MATCH (n:Person) RETURN n LIMIT 100; geode> -- Count before retrieving geode> MATCH (n:Person) RETURN count(n); geode> -- Use cursors for large exports geode> \export persons.json geode> MATCH (n:Person) RETURN n; </code></pre></div> <h4 id="query-timing" class="position-relative d-flex align-items-center group"> Query Timing <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-timing" aria-haspopup="dialog" aria-label="Share link: Query Timing"> Share link </button> </h4>Enable timing to monitor performance: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-fallback" data-lang="fallback">geode> \timing on Timing is on. geode> MATCH (p:Person {email: '[email protected]'}) RETURN p; ╭─────────────────────────────────╮ │ p │ ├─────────────────────────────────┤ │ {"name": "Alice", "age": 32} │ ╰─────────────────────────────────╯ 1 row (0.8ms) </code></pre></div> <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>Symptom: Cannot connect to database Solutions: <ul> <li>Verify server is running (<code>geode serve</code>)</li> <li>Check host/port configuration</li> <li>Confirm network connectivity</li> <li>Validate TLS certificates</li> <li>Review authentication credentials</li> </ul> <h4 id="slow-query-performance" class="position-relative d-flex align-items-center group"> Slow Query Performance <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="slow-query-performance" aria-haspopup="dialog" aria-label="Share link: Slow Query Performance"> Share link </button> </h4>Symptom: Queries take longer than expected Solutions: <ul> <li>Use <code>\explain</code> to view query plan</li> <li>Check for missing indexes</li> <li>Add LIMIT to unbounded queries</li> <li>Verify network latency</li> <li>Profile with <code>\profile</code></li> </ul> <h4 id="display-issues" class="position-relative d-flex align-items-center group"> Display 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="display-issues" aria-haspopup="dialog" aria-label="Share link: Display Issues"> Share link </button> </h4>Symptom: Results not displaying correctly Solutions: <ul> <li>Adjust terminal width</li> <li>Switch format with <code>\format json</code></li> <li>Use vertical display <code>\x on</code></li> <li>Check for Unicode characters</li> <li>Clear screen with <code>\clear</code></li> </ul> <h4 id="history-problems" class="position-relative d-flex align-items-center group"> History Problems <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="history-problems" aria-haspopup="dialog" aria-label="Share link: History Problems"> Share link </button> </h4>Symptom: Command history not working Solutions: <ul> <li>Check history file permissions</li> <li>Verify <code>~/.geode_history</code> exists</li> <li>Clear corrupted history file</li> <li>Restart REPL session</li> </ul> <h3 id="related-topics" class="position-relative d-flex align-items-center group"> Related Topics <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="related-topics" aria-haspopup="dialog" aria-label="Share link: Related Topics"> Share link </button> </h3><ul> <li><a href="/tags/cli/" >CLI</a> - Command-line interface and tools</li> <li><a href="/tags/development/" >Query Development</a> - Query development workflow</li> <li><a href="/tags/gql-syntax/" >GQL Syntax</a> - GQL language syntax</li> <li><a href="/tags/tools/" >Interactive Tools</a> - Development tools</li> <li><a href="/tags/debugging/" >Debugging</a> - Query debugging techniques</li> <li><a href="/tags/query-optimization/" >Query Optimization</a> - Performance tuning</li> </ul> <h3 id="advanced-repl-features" class="position-relative d-flex align-items-center group"> Advanced REPL Features <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="advanced-repl-features" aria-haspopup="dialog" aria-label="Share link: Advanced REPL Features"> Share link </button> </h3> <h4 id="query-history-and-search" class="position-relative d-flex align-items-center group"> Query History and Search <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-history-and-search" aria-haspopup="dialog" aria-label="Share link: Query History and Search"> Share link </button> </h4>The REPL maintains a searchable history of all commands: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-fallback" data-lang="fallback">geode> \history 1: MATCH (n) RETURN count(n); 2: MATCH (p:Person) RETURN p.name LIMIT 10; 3: MATCH (p:Person {name: 'Alice'}) RETURN p; ... geode> # Search history with Ctrl+R (reverse-i-search)`MATCH': MATCH (p:Person) RETURN p.name LIMIT 10; geode> # Re-execute previous command with !! geode> !! MATCH (p:Person) RETURN p.name LIMIT 10; geode> # Execute specific history entry with !<number> geode> !2 MATCH (p:Person) RETURN p.name LIMIT 10; </code></pre></div> <h4 id="session-persistence" class="position-relative d-flex align-items-center group"> Session Persistence <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="session-persistence" aria-haspopup="dialog" aria-label="Share link: Session Persistence"> Share link </button> </h4>Save and load REPL sessions: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gdscript3" data-lang="gdscript3">geode> \save session.gql Saved 15 queries to session.gql geode> \load session.gql Loading and executing session.gql... Query 1/15: MATCH (n) RETURN count(n); ✓ Query 2/15: CREATE INDEX FOR (p:Person) ON (p.email); ✓ ... Session loaded successfully. geode> \export results.json Exporting query results to results.json... Exported 1523 rows </code></pre></div> <h4 id="variable-binding-and-reuse" class="position-relative d-flex align-items-center group"> Variable Binding and Reuse <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="variable-binding-and-reuse" aria-haspopup="dialog" aria-label="Share link: Variable Binding and Reuse"> Share link </button> </h4>Bind query results to variables for reuse: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gdscript3" data-lang="gdscript3">geode> @high_value_users := MATCH (u:User) WHERE u.lifetime_value > 10000 RETURN u.id, u.name, u.email; Bound 142 rows to @high_value_users geode> # Use bound variable in subsequent queries geode> MATCH (u:User) WHERE u.id IN [x.id FOR x IN @high_value_users] MATCH (u)-[:PURCHASED]->(p:Product) RETURN u.name, count(p) AS purchases ORDER BY purchases DESC; ╭──────────────┬────────────╮ │ u.name │ purchases │ ├──────────────┼────────────┤ │ Alice Smith │ 87 │ │ Bob Johnson │ 72 │ ... ╰──────────────┴────────────╯ </code></pre></div> <h4 id="multi-line-query-editing" class="position-relative d-flex align-items-center group"> Multi-Line Query Editing <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-query-editing" aria-haspopup="dialog" aria-label="Share link: Multi-Line Query Editing"> Share link </button> </h4>Advanced editing capabilities for complex queries: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-fallback" data-lang="fallback">geode> # Press Ctrl+X Ctrl+E to open query in $EDITOR geode> # Edit multi-line query with full text editor support # Opens in vim/emacs/nano with syntax highlighting: MATCH (u:User)-[:WORKS_AT]->(c:Company), (u)-[:LIVES_IN]->(city:City) WHERE c.industry = 'Technology' AND city.name IN ['San Francisco', 'Seattle', 'Austin'] AND u.salary > 100000 WITH u, c, city, duration.between(u.hire_date, date()) AS tenure WHERE tenure.years > 2 RETURN u.name AS employee, c.name AS company, city.name AS location, u.salary AS salary, tenure.years AS years_employed ORDER BY u.salary DESC LIMIT 50; # Save and exit editor, query executes in REPL </code></pre></div> <h4 id="advanced-meta-commands" class="position-relative d-flex align-items-center group"> Advanced Meta-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="advanced-meta-commands" aria-haspopup="dialog" aria-label="Share link: Advanced Meta-Commands"> Share link </button> </h4>Comprehensive database introspection: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-fallback" data-lang="fallback">geode> \d Person Label: Person Properties: id INTEGER PRIMARY KEY, INDEXED name STRING NOT NULL email STRING UNIQUE, INDEXED age INTEGER city STRING INDEXED created_at TIMESTAMP DEFAULT now() Indexes: person_id_idx (id) - BTREE person_email_idx (email) - UNIQUE BTREE person_city_idx (city) - BTREE person_embedding_idx (embedding) - HNSW Constraints: person_id_unique (id IS UNIQUE) person_email_unique (email IS UNIQUE) person_name_exists (name IS NOT NULL) Relationships: (Person)-[:WORKS_AT]->(Company) 14523 relationships (Person)-[:FRIEND]->(Person) 35621 relationships (Person)-[:LIVES_IN]->(City) 14523 relationships geode> \timing on Timing is on. geode> \explain on Query plans will be displayed. geode> MATCH (p:Person {email: '[email protected]'}) RETURN p; Query Plan: ┌─ IndexScan (person_email_idx) │ ├─ Condition: email = '[email protected]' │ ├─ Estimated rows: 1 │ └─ Cost: 0.1 └─ Return ├─ Columns: p └─ Cost: 0.01 Execution: 0.8ms (1 row) geode> \watch 5 Repeating query every 5 seconds. Press Ctrl+C to stop. geode> MATCH (u:User) WHERE u.online = true RETURN count(u); ╭──────────╮ │ count(u) │ ├──────────┤ │ 1523 │ ╰──────────╯ [2024-01-15 14:30:00] ╭──────────╮ │ count(u) │ ├──────────┤ │ 1531 │ ╰──────────╯ [2024-01-15 14:30:05] ... </code></pre></div> <h4 id="output-formatting-options" class="position-relative d-flex align-items-center group"> Output Formatting 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="output-formatting-options" aria-haspopup="dialog" aria-label="Share link: Output Formatting Options"> Share link </button> </h4>Control result display format: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-fallback" data-lang="fallback">geode> \format table Output format set to table. geode> MATCH (p:Person) RETURN p.name, p.age LIMIT 3; ╭──────────────┬──────╮ │ p.name │ p.age│ ├──────────────┼──────┤ │ Alice Smith │ 32 │ │ Bob Johnson │ 28 │ │ Carol Davis │ 45 │ ╰──────────────┴──────╯ geode> \format json Output format set to JSON. geode> MATCH (p:Person) RETURN p.name, p.age LIMIT 3; [ {"p.name": "Alice Smith", "p.age": 32}, {"p.name": "Bob Johnson", "p.age": 28}, {"p.name": "Carol Davis", "p.age": 45} ] geode> \format csv Output format set to CSV. geode> MATCH (p:Person) RETURN p.name, p.age LIMIT 3; p.name,p.age Alice Smith,32 Bob Johnson,28 Carol Davis,45 geode> \format vertical Output format set to vertical. geode> MATCH (p:Person) RETURN p.name, p.email, p.age LIMIT 1; ─────────────── Row 1 ─────────────── p.name │ Alice Smith p.email │ [email protected] p.age │ 32 </code></pre></div> <h4 id="batch-operations" class="position-relative d-flex align-items-center group"> Batch 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="batch-operations" aria-haspopup="dialog" aria-label="Share link: Batch Operations"> Share link </button> </h4>Execute multiple queries efficiently: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-fallback" data-lang="fallback">geode> \batch Batch mode enabled. Commands will queue until '\execute'. batch> CREATE (:User {id: 1, name: 'Alice'}); Queued (1) batch> CREATE (:User {id: 2, name: 'Bob'}); Queued (2) batch> CREATE (:User {id: 3, name: 'Carol'}); Queued (3) batch> MATCH (a:User {id: 1}), (b:User {id: 2}) CREATE (a)-[:FRIEND]->(b); Queued (4) batch> \execute Executing 4 queued queries in transaction... ✓ Query 1 completed (1.2ms) ✓ Query 2 completed (0.9ms) ✓ Query 3 completed (0.8ms) ✓ Query 4 completed (1.1ms) Batch completed: 4/4 succeeded (4.0ms total) </code></pre></div> <h4 id="remote-server-management" class="position-relative d-flex align-items-center group"> Remote 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="remote-server-management" aria-haspopup="dialog" aria-label="Share link: Remote Server Management"> Share link </button> </h4>Manage Geode servers from REPL: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-fallback" data-lang="fallback">geode> \connect production-db.example.com:3141 Connecting to production-db.example.com:3141... Connected to Geode v0.2.18 (cluster mode, 5 nodes) geode> \cluster status Cluster Status: ┌────────┬─────────────────────┬─────────┬────────┬────────────┐ │ Node │ Address │ Role │ Status │ Lag (ms) │ ├────────┼─────────────────────┼─────────┼────────┼────────────┤ │ node1 │ 10.0.1.10:7000 │ Leader │ Healthy│ 0 │ │ node2 │ 10.0.1.11:7000 │ Follower│ Healthy│ 2 │ │ node3 │ 10.0.1.12:7000 │ Follower│ Healthy│ 1 │ │ node4 │ 10.0.2.10:7000 │ Observer│ Healthy│ 45 │ │ node5 │ 10.0.2.11:7000 │ Observer│ Healthy│ 48 │ └────────┴─────────────────────┴─────────┴────────┴────────────┘ geode> \admin rebalance Initiating cluster rebalance... Progress: [████████████████████████████████] 100% (15.2s) Rebalanced 128 shards across 5 nodes geode> \admin backup /backups/prod-$(date +%Y%m%d) Starting backup to /backups/prod-20240115... Backing up data files... ████████████████ 100% (2.1GB) Backing up WAL files... ████████████████ 100% (512MB) Backup completed: /backups/prod-20240115.tar.gz (2.6GB) </code></pre></div> <h4 id="keyboard-shortcuts-reference" class="position-relative d-flex align-items-center group"> Keyboard Shortcuts Reference <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="keyboard-shortcuts-reference" aria-haspopup="dialog" aria-label="Share link: Keyboard Shortcuts Reference"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-fallback" data-lang="fallback">Navigation: Ctrl+A / Home - Beginning of line Ctrl+E / End - End of line Ctrl+F / → - Forward one character Ctrl+B / ← - Backward one character Alt+F - Forward one word Alt+B - Backward one word Editing: Ctrl+D / Delete - Delete character Ctrl+H / Backspace - Delete previous character Ctrl+K - Kill (cut) to end of line Ctrl+U - Kill to beginning of line Ctrl+W - Kill previous word Alt+D - Kill next word Ctrl+Y - Yank (paste) killed text History: Ctrl+R - Reverse search history Ctrl+S - Forward search history ↑ / Ctrl+P - Previous command ↓ / Ctrl+N - Next command Alt+< - First command in history Alt+> - Last command in history Completion: Tab - Auto-complete Alt+? - List all completions Control: Ctrl+C - Cancel current input Ctrl+D - Exit (if input empty) Ctrl+L - Clear screen Ctrl+X Ctrl+E - Edit query in $EDITOR </code></pre></div> <h4 id="scripting-with-repl" class="position-relative d-flex align-items-center group"> Scripting with REPL <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="scripting-with-repl" aria-haspopup="dialog" aria-label="Share link: Scripting with REPL"> Share link </button> </h4>Automate tasks with REPL scripts: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash">#!/usr/bin/env bash # Daily analytics script geode shell --non-interactive <<'EOF' -- Daily user activity report \output daily_report_$(date +%Y%m%d).csv \format csv MATCH (u:User)-[:PERFORMED]->(e:Event) WHERE e.timestamp > datetime().minusDays(1) WITH u, count(e) AS event_count, collect(DISTINCT e.type) AS event_types ORDER BY event_count DESC RETURN u.id, u.name, event_count, event_types LIMIT 1000; -- Export to JSON for downstream processing \output user_cohorts.json \format json MATCH (u:User) WITH u, duration.between(u.created_at, datetime()).days AS days_since_signup WITH CASE WHEN days_since_signup <= 7 THEN 'new' WHEN days_since_signup <= 30 THEN 'active' ELSE 'established' END AS cohort, count(u) AS user_count RETURN cohort, user_count; \quit EOF echo "Reports generated:" ls -lh daily_report_*.csv user_cohorts.json </code></pre></div> <h4 id="ide-integration" class="position-relative d-flex align-items-center group"> IDE Integration <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="ide-integration" aria-haspopup="dialog" aria-label="Share link: IDE Integration"> Share link </button> </h4>Use REPL output in development workflows: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash"># Generate schema documentation geode shell --execute "\dt" > docs/schema.txt # Extract sample data for testing geode shell --execute " MATCH (u:User) RETURN u LIMIT 100; \format json " > test/fixtures/users.json # Monitor query performance geode shell --execute " \timing on \profile MATCH (u:User)-[:PURCHASED]->(p:Product) WHERE p.category = 'Electronics' RETURN u.name, count(p) AS purchases ORDER BY purchases DESC LIMIT 10; " > performance_report.txt </code></pre></div> <h3 id="further-reading" class="position-relative d-flex align-items-center group"> Further Reading <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="further-reading" aria-haspopup="dialog" aria-label="Share link: Further Reading"> Share link </button> </h3><ul> <li><a href="/docs/development/repl-advanced/" >REPL Advanced Guide</a> - Complete REPL documentation</li> <li><a href="/docs/quick-reference/" >GQL Quick Reference</a> - GQL syntax cheat sheet</li> <li><a href="/docs/tutorials/repl-basics/" >REPL Basics Tutorial</a> - Hands-on REPL tutorial</li> <li><a href="https://tiswww.case.edu/php/chet/readline/rluserman.html" aria-label="Readline Documentation – opens in new window" target="_blank" rel="noopener noreferrer" >Readline Documentation ↗ </a> - Keyboard shortcuts</li> <li><a href="https://www.postgresql.org/docs/current/app-psql.html" aria-label="PostgreSQL psql – opens in new window" target="_blank" rel="noopener noreferrer" >PostgreSQL psql ↗ </a> - Inspiration for meta-commands</li> </ul>

Popular

Related Articles

Advanced REPL Features Guide

REPL Interactive Shell Basics