Editor Integrations for Geode GQL

Modern development workflows demand sophisticated editor support for productivity, code quality, and developer experience. Geode provides comprehensive editor integrations through Language Server Protocol (LSP) implementations, syntax highlighting packages, intelligent auto-completion, real-time diagnostics, and query execution capabilities across all major editors and IDEs. Whether you prefer Visual Studio Code, Neovim, classic Vim, Emacs, JetBrains IDEs, Sublime Text, or any LSP-compatible editor, Geode’s tooling ecosystem ensures you have the rich development experience developers expect from enterprise database platforms. This guide provides an overview of available editor integrations, common features, installation approaches, and guidance on choosing the right tools for your workflow. <h3 id="available-integrations" class="position-relative d-flex align-items-center group"> Available Integrations <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="available-integrations" aria-haspopup="dialog" aria-label="Share link: Available Integrations"> 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="visual-studio-code" class="position-relative d-flex align-items-center group"> Visual Studio Code <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="visual-studio-code" aria-haspopup="dialog" aria-label="Share link: Visual Studio Code"> Share link </button> </h4>The most feature-rich integration with full graphical support: <table> <thead> <tr> <th>Feature</th> <th>Support</th> </tr> </thead> <tbody> <tr> <td>Syntax Highlighting</td> <td>Full</td> </tr> <tr> <td>LSP Integration</td> <td>Full</td> </tr> <tr> <td>Auto-Completion</td> <td>Full</td> </tr> <tr> <td>Diagnostics</td> <td>Full</td> </tr> <tr> <td>Hover Documentation</td> <td>Full</td> </tr> <tr> <td>Go to Definition</td> <td>Full</td> </tr> <tr> <td>Find References</td> <td>Full</td> </tr> <tr> <td>Query Execution</td> <td>Full</td> </tr> <tr> <td>Result Visualization</td> <td>Table, Graph, JSON</td> </tr> <tr> <td>Schema Explorer</td> <td>Sidebar</td> </tr> <tr> <td>Debugging</td> <td>Full</td> </tr> <tr> <td>Snippets</td> <td>Built-in + Custom</td> </tr> </tbody> </table> Installation: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash">code --install-extension geodedb.geode-gql </code></pre></div>Best For: Developers who want a full-featured GUI experience with graph visualization and integrated debugging. <a href="/tags/vscode/" >Detailed VS Code Guide</a> <h4 id="neovim" class="position-relative d-flex align-items-center group"> Neovim <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="neovim" aria-haspopup="dialog" aria-label="Share link: Neovim"> Share link </button> </h4>Modern, Lua-based integration with native LSP support: <table> <thead> <tr> <th>Feature</th> <th>Support</th> </tr> </thead> <tbody> <tr> <td>Syntax Highlighting</td> <td>Tree-sitter</td> </tr> <tr> <td>LSP Integration</td> <td>Native</td> </tr> <tr> <td>Auto-Completion</td> <td>nvim-cmp</td> </tr> <tr> <td>Diagnostics</td> <td>Full</td> </tr> <tr> <td>Hover Documentation</td> <td>Full</td> </tr> <tr> <td>Go to Definition</td> <td>Full</td> </tr> <tr> <td>Find References</td> <td>Full</td> </tr> <tr> <td>Query Execution</td> <td>Full</td> </tr> <tr> <td>Result Display</td> <td>Split/Float</td> </tr> <tr> <td>Schema Explorer</td> <td>Telescope</td> </tr> <tr> <td>Snippets</td> <td>LuaSnip</td> </tr> </tbody> </table> Installation: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-lua" data-lang="lua">-- lazy.nvim { "geodedb/geode.nvim", dependencies = { "nvim-lspconfig" } } </code></pre></div>Best For: Developers who prefer modal editing, terminal workflows, and extensive customization through Lua. <a href="/tags/neovim/" >Detailed Neovim Guide</a> <h4 id="vim" class="position-relative d-flex align-items-center group"> Vim <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="vim" aria-haspopup="dialog" aria-label="Share link: Vim"> Share link </button> </h4>Classic Vim support with omni-completion and ALE integration: <table> <thead> <tr> <th>Feature</th> <th>Support</th> </tr> </thead> <tbody> <tr> <td>Syntax Highlighting</td> <td>Vimscript</td> </tr> <tr> <td>LSP Integration</td> <td>vim-lsp</td> </tr> <tr> <td>Auto-Completion</td> <td>Omni-func</td> </tr> <tr> <td>Diagnostics</td> <td>ALE</td> </tr> <tr> <td>Hover Documentation</td> <td>vim-lsp</td> </tr> <tr> <td>Query Execution</td> <td>Full</td> </tr> <tr> <td>Result Display</td> <td>Split</td> </tr> <tr> <td>Snippets</td> <td>UltiSnips</td> </tr> </tbody> </table> Installation: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-vim" data-lang="vim">Plug 'geodedb/vim-geode-gql' </code></pre></div>Best For: Traditional Vim users who prefer stability and broad compatibility. <a href="/tags/vim/" >Detailed Vim Guide</a> <h4 id="jetbrains-ides-intellij-datagrip" class="position-relative d-flex align-items-center group"> JetBrains IDEs (IntelliJ, DataGrip) <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="jetbrains-ides-intellij-datagrip" aria-haspopup="dialog" aria-label="Share link: JetBrains IDEs (IntelliJ, DataGrip)"> Share link </button> </h4>Professional IDE integration with database tooling: <table> <thead> <tr> <th>Feature</th> <th>Support</th> </tr> </thead> <tbody> <tr> <td>Syntax Highlighting</td> <td>Full</td> </tr> <tr> <td>Auto-Completion</td> <td>Full</td> </tr> <tr> <td>Diagnostics</td> <td>Full</td> </tr> <tr> <td>Database Explorer</td> <td>Full</td> </tr> <tr> <td>Query Console</td> <td>Full</td> </tr> <tr> <td>Result Viewer</td> <td>Table, Graph</td> </tr> <tr> <td>Schema Introspection</td> <td>Full</td> </tr> <tr> <td>Live Templates</td> <td>Full</td> </tr> </tbody> </table> Installation: Settings → Plugins → Search “Geode GQL” Best For: Teams already using JetBrains IDEs who want integrated database tooling. <h4 id="emacs" class="position-relative d-flex align-items-center group"> Emacs <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="emacs" aria-haspopup="dialog" aria-label="Share link: Emacs"> Share link </button> </h4>Emacs integration via lsp-mode: <table> <thead> <tr> <th>Feature</th> <th>Support</th> </tr> </thead> <tbody> <tr> <td>Syntax Highlighting</td> <td>Major Mode</td> </tr> <tr> <td>LSP Integration</td> <td>lsp-mode</td> </tr> <tr> <td>Auto-Completion</td> <td>company-mode</td> </tr> <tr> <td>Diagnostics</td> <td>Flycheck</td> </tr> <tr> <td>Query Execution</td> <td>Full</td> </tr> </tbody> </table> Installation: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-elisp" data-lang="elisp">(use-package geode-gql-mode :ensure t :mode "\\.gql\\'" :hook (geode-gql-mode . lsp)) </code></pre></div>Best For: Emacs users who want consistent LSP integration. <h4 id="sublime-text" class="position-relative d-flex align-items-center group"> Sublime Text <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="sublime-text" aria-haspopup="dialog" aria-label="Share link: Sublime Text"> Share link </button> </h4>Lightweight integration via LSP package: <table> <thead> <tr> <th>Feature</th> <th>Support</th> </tr> </thead> <tbody> <tr> <td>Syntax Highlighting</td> <td>Full</td> </tr> <tr> <td>LSP Integration</td> <td>LSP Package</td> </tr> <tr> <td>Auto-Completion</td> <td>Full</td> </tr> <tr> <td>Diagnostics</td> <td>Full</td> </tr> </tbody> </table> Installation: Package Control → Install “Geode GQL” Best For: Users who prefer a lightweight, fast editor. <h4 id="helix" class="position-relative d-flex align-items-center group"> Helix <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="helix" aria-haspopup="dialog" aria-label="Share link: Helix"> Share link </button> </h4>Modern terminal editor with built-in LSP: <table> <thead> <tr> <th>Feature</th> <th>Support</th> </tr> </thead> <tbody> <tr> <td>Syntax Highlighting</td> <td>Tree-sitter</td> </tr> <tr> <td>LSP Integration</td> <td>Built-in</td> </tr> <tr> <td>Auto-Completion</td> <td>Built-in</td> </tr> <tr> <td>Diagnostics</td> <td>Built-in</td> </tr> </tbody> </table> Configuration: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-toml" data-lang="toml"># ~/.config/helix/languages.toml [[language]] name = "gql" language-server = { command = "geode", args = ["lsp", "--stdio"] } </code></pre></div>Best For: Users exploring modern terminal-based editors. <h3 id="language-server-protocol-lsp" class="position-relative d-flex align-items-center group"> Language Server Protocol (LSP) <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="language-server-protocol-lsp" aria-haspopup="dialog" aria-label="Share link: Language Server Protocol (LSP)"> Share link </button> </h3> <h4 id="overview" class="position-relative d-flex align-items-center group"> Overview <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="overview" aria-haspopup="dialog" aria-label="Share link: Overview"> Share link </button> </h4>Geode implements the Language Server Protocol, enabling consistent language intelligence across all LSP-compatible editors. The LSP provides: <ul> <li>Syntax Highlighting: Context-aware colorization</li> <li>Auto-Completion: Keywords, labels, properties, functions</li> <li>Diagnostics: Errors, warnings, hints</li> <li>Hover Information: Documentation on hover</li> <li>Go to Definition: Navigate to bindings</li> <li>Find References: Locate all usages</li> <li>Rename Symbol: Rename across queries</li> <li>Code Formatting: Automatic query formatting</li> <li>Signature Help: Function parameter hints</li> </ul> <h4 id="starting-the-language-server" class="position-relative d-flex align-items-center group"> Starting the Language Server <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="starting-the-language-server" aria-haspopup="dialog" aria-label="Share link: Starting the Language Server"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash"># Standard stdio mode (recommended) geode lsp --stdio # TCP socket mode (for remote editing) geode lsp --listen 127.0.0.1:5007 # With debug logging geode lsp --stdio --log-level debug --log-file /tmp/geode-lsp.log </code></pre></div> <h4 id="lsp-capabilities" class="position-relative d-flex align-items-center group"> LSP Capabilities <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="lsp-capabilities" aria-haspopup="dialog" aria-label="Share link: LSP Capabilities"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-json" data-lang="json">{ "capabilities": { "textDocumentSync": { "openClose": true, "change": 2, "save": { "includeText": true } }, "completionProvider": { "triggerCharacters": [".", ":", "(", "[", " "], "resolveProvider": true }, "hoverProvider": true, "definitionProvider": true, "referencesProvider": true, "documentFormattingProvider": true, "renameProvider": { "prepareProvider": true }, "signatureHelpProvider": { "triggerCharacters": ["(", ","] }, "diagnosticProvider": { "interFileDependencies": false, "workspaceDiagnostics": false } } } </code></pre></div> <h4 id="connecting-to-database" class="position-relative d-flex align-items-center group"> Connecting to Database <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="connecting-to-database" aria-haspopup="dialog" aria-label="Share link: Connecting to Database"> Share link </button> </h4>The LSP server connects to a Geode database for schema introspection and validation: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-json" data-lang="json">// LSP initialization options { "connection": { "host": "localhost", "port": 3141, "database": "default", "tls": false }, "diagnostics": { "enabled": true, "validateLabels": true, "validateProperties": true, "validateRelationships": true } } </code></pre></div> <h3 id="common-features" class="position-relative d-flex align-items-center group"> Common 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="common-features" aria-haspopup="dialog" aria-label="Share link: Common 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>All integrations provide GQL syntax highlighting: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">-- Keywords in keyword color MATCH (user:User)-[:FOLLOWS]->(friend:User) WHERE user.active = true AND user.created_at > datetime('2024-01-01') RETURN friend.name AS friend_name, COUNT(*) AS mutual_friends GROUP BY friend.name ORDER BY mutual_friends DESC LIMIT 10; -- Different elements highlighted distinctly: -- - Keywords: MATCH, WHERE, RETURN, etc. -- - Labels: :User -- - Relationships: :FOLLOWS -- - Properties: .active, .created_at, .name -- - Functions: datetime(), COUNT() -- - Strings: '2024-01-01' -- - Numbers: 10 -- - Comments: -- this line </code></pre></div> <h4 id="auto-completion" class="position-relative d-flex align-items-center group"> 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="auto-completion" aria-haspopup="dialog" aria-label="Share link: Auto-Completion"> Share link </button> </h4>Context-aware suggestions: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">-- After typing "MATCH (u:" -- Completions: All labels from schema (User, Product, Order, etc.) -- After typing "WHERE u." -- Completions: Properties of User (id, name, email, active, etc.) -- After typing "-[:" -- Completions: Relationship types (FOLLOWS, PURCHASED, REVIEWED, etc.) -- After typing "RETURN UPPER(" -- Completions: Function signature with parameter info </code></pre></div> <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 as you type: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">-- Syntax Error MATCH (u:User) WHER u.email = 'test@example.com' -- Error: Unknown keyword 'WHER' RETURN u; -- Unknown Label Warning MATCH (u:UnknownLabel) -- Warning: Label not found in schema RETURN u; -- Property Warning MATCH (u:User) WHERE u.nonexistent = 'value' -- Warning: Property not in schema RETURN u; -- Type Error MATCH (u:User) WHERE u.age + 'string' -- Error: Cannot add Integer + String RETURN u; </code></pre></div> <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 without leaving the editor: <table> <thead> <tr> <th>Editor</th> <th>Execute</th> <th>Explain</th> <th>Profile</th> </tr> </thead> <tbody> <tr> <td>VS Code</td> <td>Ctrl+Enter</td> <td>Ctrl+E</td> <td>Ctrl+Shift+E</td> </tr> <tr> <td>Neovim</td> <td><code><leader>ge</code></td> <td><code><leader>gx</code></td> <td><code><leader>gp</code></td> </tr> <tr> <td>Vim</td> <td><code><leader>ge</code></td> <td><code><leader>gx</code></td> <td><code><leader>gp</code></td> </tr> <tr> <td>IntelliJ</td> <td>Ctrl+Enter</td> <td>Ctrl+E</td> <td>Ctrl+Shift+E</td> </tr> <tr> <td>Emacs</td> <td>C-c C-c</td> <td>C-c C-e</td> <td>C-c C-p</td> </tr> </tbody> </table> <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 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 return f.name,count(*) as cnt group by f.name order by cnt desc; -- After formatting MATCH (u:User)-[:FOLLOWS]->(f) WHERE u.active = true RETURN f.name, COUNT(*) AS cnt GROUP BY f.name ORDER BY cnt DESC; </code></pre></div> <h4 id="snippets" class="position-relative d-flex align-items-center group"> 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="snippets" aria-haspopup="dialog" aria-label="Share link: Snippets"> Share link </button> </h4>Common patterns available as snippets: <table> <thead> <tr> <th>Snippet</th> <th>Expansion</th> </tr> </thead> <tbody> <tr> <td><code>match</code></td> <td>Basic MATCH query</td> </tr> <tr> <td><code>create</code></td> <td>CREATE node</td> </tr> <tr> <td><code>crel</code></td> <td>CREATE relationship</td> </tr> <tr> <td><code>merge</code></td> <td>MERGE pattern</td> </tr> <tr> <td><code>path</code></td> <td>Variable-length path</td> </tr> <tr> <td><code>agg</code></td> <td>Aggregation query</td> </tr> <tr> <td><code>case</code></td> <td>CASE expression</td> </tr> <tr> <td><code>tx</code></td> <td>Transaction block</td> </tr> </tbody> </table> <h3 id="choosing-an-editor" class="position-relative d-flex align-items-center group"> Choosing an Editor <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="choosing-an-editor" aria-haspopup="dialog" aria-label="Share link: Choosing an Editor"> Share link </button> </h3> <h4 id="decision-guide" class="position-relative d-flex align-items-center group"> Decision Guide <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="decision-guide" aria-haspopup="dialog" aria-label="Share link: Decision Guide"> Share link </button> </h4>Choose VS Code if: <ul> <li>You want graph visualization for results</li> <li>You prefer a GUI-based debugging experience</li> <li>You need extensive extension ecosystem</li> <li>You’re new to GQL development</li> </ul> Choose Neovim if: <ul> <li>You prefer modal editing</li> <li>You want maximum customization via Lua</li> <li>You value terminal-based workflows</li> <li>You need fast startup times</li> </ul> Choose Vim if: <ul> <li>You need broad compatibility (SSH, minimal systems)</li> <li>You prefer traditional Vimscript configuration</li> <li>You have existing Vim workflows</li> </ul> Choose JetBrains IDEs if: <ul> <li>You’re already using IntelliJ/DataGrip</li> <li>You want integrated database tooling</li> <li>Your team uses JetBrains products</li> </ul> Choose Emacs if: <ul> <li>You’re an Emacs user</li> <li>You want consistent LSP integration</li> <li>You prefer Lisp-based configuration</li> </ul> <h4 id="feature-comparison" class="position-relative d-flex align-items-center group"> Feature Comparison <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="feature-comparison" aria-haspopup="dialog" aria-label="Share link: Feature Comparison"> Share link </button> </h4><table> <thead> <tr> <th>Feature</th> <th>VS Code</th> <th>Neovim</th> <th>Vim</th> <th>JetBrains</th> <th>Emacs</th> </tr> </thead> <tbody> <tr> <td>LSP Support</td> <td>Native</td> <td>Native</td> <td>Plugin</td> <td>Native</td> <td>Plugin</td> </tr> <tr> <td>Tree-sitter</td> <td>Yes</td> <td>Yes</td> <td>No</td> <td>N/A</td> <td>Limited</td> </tr> <tr> <td>Graph Viz</td> <td>Yes</td> <td>No</td> <td>No</td> <td>Yes</td> <td>No</td> </tr> <tr> <td>Debugging</td> <td>Yes</td> <td>Limited</td> <td>No</td> <td>Yes</td> <td>No</td> </tr> <tr> <td>Remote Dev</td> <td>Yes</td> <td>Yes</td> <td>Yes</td> <td>Yes</td> <td>Yes</td> </tr> <tr> <td>Startup Time</td> <td>Slow</td> <td>Fast</td> <td>Fast</td> <td>Slow</td> <td>Medium</td> </tr> <tr> <td>Memory</td> <td>High</td> <td>Low</td> <td>Low</td> <td>High</td> <td>Medium</td> </tr> </tbody> </table> <h3 id="configuration-best-practices" class="position-relative d-flex align-items-center group"> Configuration 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="configuration-best-practices" aria-haspopup="dialog" aria-label="Share link: Configuration Best Practices"> Share link </button> </h3> <h4 id="project-level-configuration" class="position-relative d-flex align-items-center group"> Project-Level 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="project-level-configuration" aria-haspopup="dialog" aria-label="Share link: Project-Level Configuration"> Share link </button> </h4>Create editor configuration files in your project: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-fallback" data-lang="fallback">project/ ├── .vscode/ │ └── settings.json # VS Code settings ├── .nvim.lua # Neovim project config ├── .geode.json # Geode connection config └── queries/ └── *.gql # Query files </code></pre></div>Geode Connection Config (<code>.geode.json</code>): <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-json" data-lang="json">{ "connections": { "development": { "host": "localhost", "port": 3141, "database": "dev" }, "staging": { "host": "staging.example.com", "port": 3141, "database": "staging", "tls": true } }, "defaultConnection": "development", "formatting": { "keywordCase": "UPPER", "indentSize": 2 } } </code></pre></div> <h4 id="team-configuration" class="position-relative d-flex align-items-center group"> Team 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="team-configuration" aria-haspopup="dialog" aria-label="Share link: Team Configuration"> Share link </button> </h4>Share consistent settings across the team: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-json" data-lang="json">// .vscode/settings.json (committed to repo) { "geode.formatting.formatOnSave": true, "geode.formatting.keywordCase": "UPPER", "geode.diagnostics.enabled": true, "[gql]": { "editor.tabSize": 2, "editor.formatOnSave": true } } </code></pre></div> <h4 id="environment-specific-settings" class="position-relative d-flex align-items-center group"> Environment-Specific 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="environment-specific-settings" aria-haspopup="dialog" aria-label="Share link: Environment-Specific Settings"> Share link </button> </h4>Use environment variables for sensitive configuration: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash"># Development export GEODE_HOST=localhost export GEODE_PORT=3141 # Production (read-only) export GEODE_HOST=prod.example.com export GEODE_READ_ONLY=true </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>LSP 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 echo '{"jsonrpc":"2.0","id":1,"method":"initialize","params":{}}' | geode lsp --stdio # Check permissions ls -la $(which geode) </code></pre></div>No Auto-Completion: <ul> <li>Ensure LSP is connected to database</li> <li>Check schema cache is populated</li> <li>Verify file type is detected as <code>gql</code></li> </ul> Slow Performance: <ul> <li>Reduce diagnostic debounce time</li> <li>Limit number of problems reported</li> <li>Check database connection latency</li> </ul> Connection Failures: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash"># Test connectivity nc -zv localhost 3141 # Test TLS openssl s_client -connect localhost:3141 # Check server status geode shell -h localhost -p 3141 </code></pre></div> <h4 id="debug-logging" class="position-relative d-flex align-items-center group"> Debug 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="debug-logging" aria-haspopup="dialog" aria-label="Share link: Debug Logging"> Share link </button> </h4>Enable verbose logging: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash"># LSP debug mode geode lsp --stdio --log-level debug --log-file /tmp/geode-lsp.log # View logs tail -f /tmp/geode-lsp.log </code></pre></div> <h4 id="getting-help" class="position-relative d-flex align-items-center group"> Getting Help <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="getting-help" aria-haspopup="dialog" aria-label="Share link: Getting Help"> Share link </button> </h4><ul> <li>Check editor-specific documentation</li> <li>Review LSP logs for errors</li> <li>Test with minimal configuration</li> <li>Report issues on GitHub</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/vscode/" >VS Code Extension</a> - Detailed VS Code guide</li> <li><a href="/tags/neovim/" >Neovim Plugin</a> - Neovim configuration</li> <li><a href="/tags/vim/" >Vim Plugin</a> - Classic Vim setup</li> <li><a href="/tags/ide/" >IDE Integration</a> - IDE-specific features</li> <li><a href="/tags/plugin/" >Plugin Development</a> - Creating custom plugins</li> <li><a href="/docs/development/lsp-guide/" >LSP Guide</a> - LSP implementation details</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>Language Server Protocol Specification</li> <li>Editor-Specific Documentation</li> <li>GQL Language Reference</li> <li>Query Development Best Practices</li> <li>Team Collaboration Workflows</li> <li>Performance Optimization Guide</li> </ul>

Popular

Related Articles

Neovim Plugin

Vim Plugin