VS Code Extension for Geode GQL

Visual Studio Code is one of the most popular code editors for modern development, and the Geode GQL extension brings first-class graph database development support to VS Code. The extension provides comprehensive Language Server Protocol (LSP) integration, enabling intelligent auto-completion, real-time diagnostics, query execution, result visualization, and debugging capabilities directly within the editor. Whether you are writing complex graph traversal queries, exploring database schemas, or debugging performance issues, the Geode VS Code extension transforms your editor into a powerful graph database development environment with the productivity features developers expect from modern tooling. This guide covers installation, configuration, features, keyboard shortcuts, customization options, and best practices for productive GQL development in VS Code. <h3 id="installation" class="position-relative d-flex align-items-center group"> 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="installation" aria-haspopup="dialog" aria-label="Share link: Installation"> 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> <h4 id="from-vs-code-marketplace" class="position-relative d-flex align-items-center group"> From VS Code Marketplace <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="from-vs-code-marketplace" aria-haspopup="dialog" aria-label="Share link: From VS Code Marketplace"> Share link </button> </h4>Install the extension directly from the VS Code Marketplace: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash"># Install via command line code --install-extension geodedb.geode-gql # Or search in VS Code # 1. Open VS Code # 2. Press Ctrl+Shift+X (Cmd+Shift+X on macOS) # 3. Search for "Geode GQL" # 4. Click Install </code></pre></div> <h4 id="manual-installation-from-vsix" class="position-relative d-flex align-items-center group"> Manual Installation from VSIX <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="manual-installation-from-vsix" aria-haspopup="dialog" aria-label="Share link: Manual Installation from VSIX"> Share link </button> </h4>For offline installation or development builds: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash"># Download the VSIX file curl -LO https://releases.geodedb.com/vscode/geode-gql-1.0.0.vsix # Install from VSIX code --install-extension geode-gql-1.0.0.vsix # Or in VS Code: Extensions → ... → Install from VSIX </code></pre></div> <h4 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> </h4>The extension requires: <ul> <li>VS Code 1.85.0 or later</li> <li>Geode CLI installed and accessible in PATH</li> <li>Running Geode server for query execution and schema introspection</li> </ul> <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash"># Verify Geode installation geode --version # Start Geode server geode serve --listen 0.0.0.0:3141 # Verify connectivity geode shell geode> RETURN 'Hello, Geode!'; </code></pre></div> <h3 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> </h3> <h4 id="extension-settings" class="position-relative d-flex align-items-center group"> Extension Settings <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="extension-settings" aria-haspopup="dialog" aria-label="Share link: Extension Settings"> Share link </button> </h4>Configure the extension in VS Code settings (<code>settings.json</code>): <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-json" data-lang="json">{ // Server connection "geode.serverPath": "/usr/local/bin/geode", "geode.connectionString": "quic://localhost:3141", "geode.defaultDatabase": "default", "geode.username": "", "geode.password": "", // Language Server "geode.lsp.enabled": true, "geode.lsp.logLevel": "info", "geode.lsp.logFile": "", // Diagnostics "geode.diagnostics.enabled": true, "geode.diagnostics.maxProblems": 100, "geode.diagnostics.debounceMs": 300, "geode.diagnostics.validateProperties": true, "geode.diagnostics.validateLabels": true, // Formatting "geode.formatting.enabled": true, "geode.formatting.formatOnSave": true, "geode.formatting.keywordCase": "UPPER", "geode.formatting.indentSize": 2, "geode.formatting.maxLineLength": 100, "geode.formatting.alignClauses": true, // Query execution "geode.execution.timeout": 30000, "geode.execution.maxRows": 1000, "geode.execution.autoCommit": false, // Visualization "geode.visualization.defaultView": "table", "geode.visualization.graphLayout": "force-directed", "geode.visualization.maxNodes": 500, // Editor "geode.editor.suggestLabels": true, "geode.editor.suggestProperties": true, "geode.editor.suggestFunctions": true, "geode.editor.showHints": true } </code></pre></div> <h4 id="workspace-configuration" class="position-relative d-flex align-items-center group"> Workspace 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="workspace-configuration" aria-haspopup="dialog" aria-label="Share link: Workspace Configuration"> Share link </button> </h4>Create workspace-specific settings for different projects: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-json" data-lang="json">// .vscode/settings.json { "geode.connectionString": "quic://dev-server:3141", "geode.defaultDatabase": "project_db", "[gql]": { "editor.formatOnSave": true, "editor.tabSize": 2, "editor.insertSpaces": true } } </code></pre></div> <h4 id="environment-specific-connections" class="position-relative d-flex align-items-center group"> Environment-Specific Connections <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="environment-specific-connections" aria-haspopup="dialog" aria-label="Share link: Environment-Specific Connections"> Share link </button> </h4>Use VS Code profiles or workspace settings for different environments: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-json" data-lang="json">// Development { "geode.connectionString": "quic://localhost:3141", "geode.defaultDatabase": "dev" } // Staging { "geode.connectionString": "quic://staging.example.com:3141", "geode.defaultDatabase": "staging" } // Production (read-only) { "geode.connectionString": "quic://prod.example.com:3141", "geode.defaultDatabase": "production", "geode.execution.readOnly": true } </code></pre></div> <h3 id="features" class="position-relative d-flex align-items-center group"> 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="features" aria-haspopup="dialog" aria-label="Share link: Features"> Share link </button> </h3> <h4 id="syntax-highlighting" class="position-relative d-flex align-items-center group"> Syntax Highlighting <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="syntax-highlighting" aria-haspopup="dialog" aria-label="Share link: Syntax Highlighting"> Share link </button> </h4>The extension provides context-aware syntax highlighting for GQL: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">-- Keywords highlighted in purple/blue MATCH (u:User)-[:FOLLOWS]->(f:User) WHERE u.active = true AND u.created_at > '2024-01-01' RETURN f.name AS friend_name, COUNT(*) AS mutual_count GROUP BY f.name ORDER BY mutual_count DESC LIMIT 10; -- Labels highlighted in orange CREATE (p:Product:Featured { name: 'Premium Widget', price: 99.99, category: 'Electronics' }); -- Functions highlighted in yellow MATCH (u:User) RETURN UPPER(u.name) AS name_upper, COALESCE(u.nickname, u.name) AS display_name, DURATION.between(u.created_at, datetime()) AS account_age; </code></pre></div> <h4 id="intelligent-auto-completion" class="position-relative d-flex align-items-center group"> Intelligent Auto-Completion <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="intelligent-auto-completion" aria-haspopup="dialog" aria-label="Share link: Intelligent Auto-Completion"> Share link </button> </h4>Context-aware suggestions as you type: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">-- After typing "MATCH (u:" -- Suggestions: All labels from schema (User, Product, Order, etc.) -- After typing "WHERE u." -- Suggestions: All properties of User (id, name, email, created_at, etc.) -- After typing "RETURN UPPER(" -- Suggestions: Function signature with parameter hints -- After typing "-[:" -- Suggestions: All relationship types (FOLLOWS, PURCHASED, VIEWED, etc.) </code></pre></div>Completion Categories: <ul> <li>Keywords: MATCH, WHERE, RETURN, CREATE, DELETE, SET, etc.</li> <li>Labels: All labels discovered from schema introspection</li> <li>Properties: Properties available on the current label context</li> <li>Functions: All GQL functions with signatures and documentation</li> <li>Variables: Variables bound earlier in the query</li> <li>Relationship Types: All relationship types from schema</li> </ul> <h4 id="real-time-diagnostics" class="position-relative d-flex align-items-center group"> Real-Time 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="real-time-diagnostics" aria-haspopup="dialog" aria-label="Share link: Real-Time Diagnostics"> Share link </button> </h4>Errors and warnings appear as you type: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">-- Syntax Error (red squiggly underline) MATCH (u:User) WHER u.email = 'test@example.com' -- Error: Expected WHERE, got WHER RETURN u; -- Unknown Label Warning (yellow squiggly) MATCH (u:UnknownLabel) -- Warning: Label 'UnknownLabel' not found in schema RETURN u; -- Property Warning (yellow squiggly) MATCH (u:User) WHERE u.nonexistent_property = 'value' -- Warning: Property not in schema RETURN u; -- Type Error (red squiggly) MATCH (u:User) WHERE u.age + 'string' -- Error: Cannot add Integer + String RETURN u; -- Unused Variable Warning (gray) MATCH (u:User), (p:Product) -- Warning: Variable 'p' declared but never used RETURN u.name; </code></pre></div> <h4 id="hover-information" class="position-relative d-flex align-items-center group"> Hover Information <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="hover-information" aria-haspopup="dialog" aria-label="Share link: Hover Information"> Share link </button> </h4>Hover over elements to see documentation: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">MATCH (u:User) -- Hover over :User to see label statistics WHERE u.email LIKE '%@example.com' -- Hover over .email to see property type RETURN COALESCE(u.nickname, u.name); -- Hover over COALESCE for function docs </code></pre></div>Hover Details Include: <ul> <li>Labels: Node count, property list, index information</li> <li>Properties: Data type, nullable status, index coverage</li> <li>Functions: Signature, description, examples, return type</li> <li>Variables: Type inferred from binding, properties available</li> <li>Relationship Types: Count, connected labels</li> </ul> <h4 id="go-to-definition" class="position-relative d-flex align-items-center group"> Go to Definition <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-to-definition" aria-haspopup="dialog" aria-label="Share link: Go to Definition"> Share link </button> </h4>Navigate to variable bindings and schema elements: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">MATCH (user:User)-[:FOLLOWS]->(friend:User) WHERE user.active = true RETURN friend.name; ^^^^^^ -- Ctrl+Click jumps to "(friend:User)" binding </code></pre></div>Keyboard Shortcut: <code>F12</code> or <code>Ctrl+Click</code> <h4 id="find-all-references" class="position-relative d-flex align-items-center group"> Find All References <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="find-all-references" aria-haspopup="dialog" aria-label="Share link: Find All References"> Share link </button> </h4>Locate all usages of variables, labels, or properties: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">MATCH (u:User) WHERE u.email LIKE '%@example.com' AND u.active = true RETURN u.name, u.email; ^ -- Right-click → Find All References -- Shows all 4 usages of variable 'u' </code></pre></div>Keyboard Shortcut: <code>Shift+F12</code> <h4 id="rename-symbol" class="position-relative d-flex align-items-center group"> Rename Symbol <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="rename-symbol" aria-haspopup="dialog" aria-label="Share link: Rename Symbol"> Share link </button> </h4>Rename variables across the query: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">-- Before rename MATCH (u:User)-[:FOLLOWS]->(f:User) WHERE u.active = true RETURN u.name, f.name; -- After renaming 'u' to 'user' (F2) MATCH (user:User)-[:FOLLOWS]->(f:User) WHERE user.active = true RETURN user.name, f.name; </code></pre></div>Keyboard Shortcut: <code>F2</code> <h4 id="code-formatting" class="position-relative d-flex align-items-center group"> Code 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="code-formatting" aria-haspopup="dialog" aria-label="Share link: Code Formatting"> Share link </button> </h4>Format GQL queries for consistency: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">-- Before formatting match(u:User)-[:FOLLOWS]->(f) where u.active=true and u.created_at>'2024-01-01' return f.name,count(*) as cnt group by f.name order by cnt desc limit 10; -- After formatting (Shift+Alt+F) MATCH (u:User)-[:FOLLOWS]->(f) WHERE u.active = true AND u.created_at > '2024-01-01' RETURN f.name, COUNT(*) AS cnt GROUP BY f.name ORDER BY cnt DESC LIMIT 10; </code></pre></div>Keyboard Shortcut: <code>Shift+Alt+F</code> <h4 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> </h4>Execute queries directly from the editor: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">-- Execute current query -- Keyboard: Ctrl+Enter (Cmd+Enter on macOS) -- Or right-click → Execute Query MATCH (u:User) WHERE u.active = true RETURN u.name, u.email LIMIT 10; </code></pre></div>Execution Commands: <table> <thead> <tr> <th>Command</th> <th>Shortcut</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td>Execute Query</td> <td><code>Ctrl+Enter</code></td> <td>Run current query</td> </tr> <tr> <td>Execute Selection</td> <td><code>Ctrl+Shift+Enter</code></td> <td>Run selected text</td> </tr> <tr> <td>Explain Query</td> <td><code>Ctrl+E</code></td> <td>Show execution plan</td> </tr> <tr> <td>Profile Query</td> <td><code>Ctrl+Shift+E</code></td> <td>Run with profiling</td> </tr> <tr> <td>Cancel Query</td> <td><code>Escape</code></td> <td>Cancel running query</td> </tr> </tbody> </table> <h4 id="result-visualization" class="position-relative d-flex align-items-center group"> Result Visualization <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-visualization" aria-haspopup="dialog" aria-label="Share link: Result Visualization"> Share link </button> </h4>View query results in multiple formats: Table View (default): <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-fallback" data-lang="fallback">┌─────────┬─────────────────┬──────────────────────────┐ │ name │ email │ created_at │ ├─────────┼─────────────────┼──────────────────────────┤ │ Alice │ [email protected]│ 2024-01-15T10:30:00Z │ │ Bob │ [email protected] │ 2024-02-20T14:45:00Z │ │ Carol │ [email protected]│ 2024-03-10T09:15:00Z │ └─────────┴─────────────────┴──────────────────────────┘ </code></pre></div>Graph View (for path queries): <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">MATCH path = (u:User)-[:FOLLOWS*1..3]->(f:User) WHERE u.name = 'Alice' RETURN path; -- Opens interactive graph visualization: -- - Nodes displayed with labels and properties -- - Relationships shown as directed edges -- - Zoom, pan, and drag controls -- - Click node to see details -- - Export to PNG/SVG </code></pre></div>JSON View: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-json" data-lang="json">[ { "name": "Alice", "email": "[email protected]", "created_at": "2024-01-15T10:30:00Z" } ] </code></pre></div> <h4 id="schema-explorer" class="position-relative d-flex align-items-center group"> Schema Explorer <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="schema-explorer" aria-haspopup="dialog" aria-label="Share link: Schema Explorer"> Share link </button> </h4>Browse database schema in the sidebar: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-fallback" data-lang="fallback">GEODE EXPLORER ├── 📊 Connections │ └── localhost:3141 (connected) ├── 🏷️ Labels │ ├── User (1,234 nodes) │ │ ├── Properties │ │ │ ├── id (Integer, indexed) │ │ │ ├── name (String) │ │ │ ├── email (String, unique) │ │ │ └── created_at (Timestamp, indexed) │ │ └── Indexes │ │ ├── user_email_unique │ │ └── user_created_idx │ ├── Product (567 nodes) │ └── Order (890 nodes) ├── 🔗 Relationships │ ├── FOLLOWS (5,678 edges) │ ├── PURCHASED (3,456 edges) │ └── VIEWED (12,345 edges) └── 📁 Saved Queries ├── active_users.gql └── popular_products.gql </code></pre></div> <h4 id="code-snippets" class="position-relative d-flex align-items-center group"> Code Snippets <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="code-snippets" aria-haspopup="dialog" aria-label="Share link: Code Snippets"> Share link </button> </h4>Built-in snippets for common patterns: <table> <thead> <tr> <th>Prefix</th> <th>Snippet</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td><code>match</code></td> <td>MATCH pattern</td> <td>Basic match query</td> </tr> <tr> <td><code>create</code></td> <td>CREATE node</td> <td>Create node</td> </tr> <tr> <td><code>crel</code></td> <td>CREATE relationship</td> <td>Create relationship</td> </tr> <tr> <td><code>merge</code></td> <td>MERGE pattern</td> <td>Merge node or relationship</td> </tr> <tr> <td><code>delete</code></td> <td>DELETE pattern</td> <td>Delete query</td> </tr> <tr> <td><code>update</code></td> <td>SET properties</td> <td>Update properties</td> </tr> <tr> <td><code>agg</code></td> <td>Aggregation query</td> <td>Query with COUNT, SUM, etc.</td> </tr> <tr> <td><code>path</code></td> <td>Path pattern</td> <td>Variable-length path</td> </tr> <tr> <td><code>case</code></td> <td>CASE expression</td> <td>Conditional expression</td> </tr> <tr> <td><code>tx</code></td> <td>Transaction block</td> <td>BEGIN/COMMIT wrapper</td> </tr> </tbody> </table> Example Snippet Expansion: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">-- Type: match<Tab> -- Expands to: MATCH (n:${1:Label}) WHERE ${2:condition} RETURN ${3:n}; </code></pre></div>Custom Snippets (<code>.vscode/gql.code-snippets</code>): <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-json" data-lang="json">{ "Find Connected Users": { "prefix": "connected", "body": [ "MATCH (u:User {email: '${1:email}'})-[:${2:FOLLOWS}*1..${3:3}]->(connected:User)", "RETURN DISTINCT connected.name, connected.email", "ORDER BY connected.name", "LIMIT ${4:10};" ], "description": "Find users connected within N hops" }, "Create User": { "prefix": "newuser", "body": [ "CREATE (u:User {", " id: randomUUID(),", " name: '${1:name}',", " email: '${2:email}',", " created_at: datetime()", "})", "RETURN u;" ], "description": "Create a new user node" } } </code></pre></div> <h3 id="keyboard-shortcuts" class="position-relative d-flex align-items-center group"> Keyboard Shortcuts <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" aria-haspopup="dialog" aria-label="Share link: Keyboard Shortcuts"> Share link </button> </h3> <h4 id="default-keybindings" class="position-relative d-flex align-items-center group"> Default Keybindings <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="default-keybindings" aria-haspopup="dialog" aria-label="Share link: Default Keybindings"> Share link </button> </h4><table> <thead> <tr> <th>Action</th> <th>Windows/Linux</th> <th>macOS</th> </tr> </thead> <tbody> <tr> <td>Execute Query</td> <td><code>Ctrl+Enter</code></td> <td><code>Cmd+Enter</code></td> </tr> <tr> <td>Execute Selection</td> <td><code>Ctrl+Shift+Enter</code></td> <td><code>Cmd+Shift+Enter</code></td> </tr> <tr> <td>Explain Query</td> <td><code>Ctrl+E</code></td> <td><code>Cmd+E</code></td> </tr> <tr> <td>Profile Query</td> <td><code>Ctrl+Shift+E</code></td> <td><code>Cmd+Shift+E</code></td> </tr> <tr> <td>Format Document</td> <td><code>Shift+Alt+F</code></td> <td><code>Shift+Option+F</code></td> </tr> <tr> <td>Go to Definition</td> <td><code>F12</code></td> <td><code>F12</code></td> </tr> <tr> <td>Find References</td> <td><code>Shift+F12</code></td> <td><code>Shift+F12</code></td> </tr> <tr> <td>Rename Symbol</td> <td><code>F2</code></td> <td><code>F2</code></td> </tr> <tr> <td>Show Hover</td> <td><code>Ctrl+K Ctrl+I</code></td> <td><code>Cmd+K Cmd+I</code></td> </tr> <tr> <td>Trigger Suggestions</td> <td><code>Ctrl+Space</code></td> <td><code>Cmd+Space</code></td> </tr> <tr> <td>Toggle Schema Explorer</td> <td><code>Ctrl+Shift+G</code></td> <td><code>Cmd+Shift+G</code></td> </tr> <tr> <td>Connect to Server</td> <td><code>Ctrl+Shift+C</code></td> <td><code>Cmd+Shift+C</code></td> </tr> <tr> <td>New Query File</td> <td><code>Ctrl+N</code></td> <td><code>Cmd+N</code></td> </tr> </tbody> </table> <h4 id="custom-keybindings" class="position-relative d-flex align-items-center group"> Custom Keybindings <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="custom-keybindings" aria-haspopup="dialog" aria-label="Share link: Custom Keybindings"> Share link </button> </h4>Add custom keybindings in <code>keybindings.json</code>: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-json" data-lang="json">[ { "key": "ctrl+shift+r", "command": "geode.executeQuery", "when": "editorLangId == gql" }, { "key": "ctrl+shift+p", "command": "geode.profileQuery", "when": "editorLangId == gql" }, { "key": "ctrl+shift+t", "command": "geode.showResultsAsTable", "when": "editorLangId == gql" }, { "key": "ctrl+shift+v", "command": "geode.showResultsAsGraph", "when": "editorLangId == gql" } ] </code></pre></div> <h3 id="debugging" class="position-relative d-flex align-items-center group"> Debugging <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="debugging" aria-haspopup="dialog" aria-label="Share link: Debugging"> Share link </button> </h3> <h4 id="query-debugging" class="position-relative d-flex align-items-center group"> Query Debugging <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-debugging" aria-haspopup="dialog" aria-label="Share link: Query Debugging"> Share link </button> </h4>Debug queries step-by-step: <ol> <li>Set breakpoints by clicking in the gutter</li> <li>Press <code>F5</code> to start debugging</li> <li>Step through query execution stages</li> <li>Inspect intermediate results and variables</li> </ol> <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">-- Set breakpoint on line 2 MATCH (u:User)-[:FOLLOWS]->(f:User) -- ● Breakpoint WHERE u.active = true AND f.followers_count > 100 RETURN f.name, f.followers_count ORDER BY f.followers_count DESC; </code></pre></div>Debug Panel Shows: <ul> <li>Query Plan: Visual execution plan</li> <li>Variables: Bound variables and their values</li> <li>Intermediate Results: Rows at current stage</li> <li>Statistics: Rows processed, time elapsed</li> <li>Indexes Used: Which indexes are being utilized</li> </ul> <h4 id="debug-console-commands" class="position-relative d-flex align-items-center group"> Debug Console 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="debug-console-commands" aria-haspopup="dialog" aria-label="Share link: Debug Console Commands"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gdscript3" data-lang="gdscript3">> SHOW PLAN → Displays query execution plan > SHOW VARIABLES → Lists all bound variables > SHOW ROWS → Shows intermediate result set > STEP → Advance to next execution stage > CONTINUE → Run to next breakpoint or end > EVALUATE u.name → Evaluate expression in current context </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="common-issues" class="position-relative d-flex align-items-center group"> Common 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="common-issues" aria-haspopup="dialog" aria-label="Share link: Common Issues"> Share link </button> </h4>Extension Not Loading: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash"># Check VS Code version code --version # Requires 1.85.0+ # Check extension logs # View → Output → Select "Geode GQL" from dropdown # Reinstall extension code --uninstall-extension geodedb.geode-gql code --install-extension geodedb.geode-gql </code></pre></div>LSP Server Not Starting: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash"># Verify Geode installation which geode geode --version # Test LSP manually geode lsp --stdio # Check extension settings # Ensure geode.serverPath is correct </code></pre></div>No Auto-Completion: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-json" data-lang="json">// Verify these settings are enabled { "geode.lsp.enabled": true, "geode.diagnostics.enabled": true, "geode.editor.suggestLabels": true, "geode.editor.suggestProperties": true } </code></pre></div>Connection Failures: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash"># Test server connectivity geode shell --host localhost --port 3141 # Check firewall rules nc -zv localhost 3141 # Verify TLS certificates if using secure connection openssl s_client -connect localhost:3141 </code></pre></div>Slow Performance: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-json" data-lang="json">{ "geode.diagnostics.maxProblems": 50, "geode.diagnostics.debounceMs": 500, "geode.visualization.maxNodes": 200 } </code></pre></div> <h4 id="logging" class="position-relative d-flex align-items-center group"> Logging <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="logging" aria-haspopup="dialog" aria-label="Share link: Logging"> Share link </button> </h4>Enable detailed logging for troubleshooting: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-json" data-lang="json">{ "geode.lsp.logLevel": "debug", "geode.lsp.logFile": "/tmp/geode-lsp.log", "geode.trace.server": "verbose" } </code></pre></div>View logs: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash"># LSP server logs tail -f /tmp/geode-lsp.log # VS Code extension logs # View → Output → "Geode GQL" </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>Organize Query Files: Use <code>.gql</code> files in version control for team collaboration. Use Workspace Settings: Configure project-specific connections and settings. Leverage Snippets: Create custom snippets for frequently used patterns. Enable Format on Save: Ensure consistent code style across the team. Use Schema Explorer: Verify labels and properties before writing queries. Test with EXPLAIN: Review query plans before executing expensive queries. Set Appropriate Limits: Use LIMIT during development to avoid large result sets. Use Transactions: Wrap mutations in transactions for safety. Profile Performance: Use Profile Query to identify bottlenecks. Keep Extension Updated: Update regularly for bug fixes and new features. <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/editor/" >Editor Integrations</a> - Overview of all editor integrations</li> <li><a href="/tags/neovim/" >Neovim Plugin</a> - Neovim/Vim integration</li> <li><a href="/tags/ide/" >IDE Integration</a> - General IDE support</li> <li><a href="/tags/plugin/" >Plugin Development</a> - Creating editor plugins</li> <li><a href="/docs/development/lsp-guide/" >LSP Guide</a> - Language Server Protocol details</li> <li><a href="/docs/gql-reference/" >GQL Reference</a> - GQL language reference</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>VS Code Extension API Documentation</li> <li>Language Server Protocol Specification</li> <li>GQL Syntax and Semantics Guide</li> <li>Query Optimization Best Practices</li> <li>Debugging Complex Graph Queries</li> <li>Team Development Workflows</li> </ul>

Popular

Related Articles

VSCode Extension