Tag: Language Server Protocol (LSP)

Geode documentation tagged with Language Server Protocol (LSP). LSP is a standardized protocol for language tooling that enables IDE features like auto-completion, error checking, and refactoring across editors without requiring editor-specific implementations. <h3 id="introduction-to-language-server-protocol" class="position-relative d-flex align-items-center group"> Introduction to Language Server Protocol <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-language-server-protocol" aria-haspopup="dialog" aria-label="Share link: Introduction to Language Server Protocol"> 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>The Language Server Protocol (LSP) was created by Microsoft in 2016 to solve a long-standing problem in developer tooling: implementing sophisticated language features for every editor/language combination required M × N implementations. With LSP, a single language server can provide features to any LSP-compliant editor, reducing the implementation burden from M × N to M + N. This architectural shift has enabled rich IDE experiences across VS Code, Vim, Emacs, Sublime Text, and many other editors. For query languages like GQL, LSP integration transforms the development experience. Rather than writing queries in plain text and discovering syntax errors at execution time, developers get immediate feedback as they type. Auto-completion suggests table names, column names, and functions. Hover tooltips display documentation. Go-to-definition jumps to label definitions. These features, commonplace for programming languages, dramatically improve productivity when working with database queries. Geode’s LSP server provides comprehensive GQL language support to any LSP-compatible editor. The server understands GQL syntax, connects to your database to fetch schema information, and provides intelligent suggestions based on your actual graph structure. Whether you write queries in VS Code, Vim, or any other modern editor, you get the same high-quality development experience with syntax validation, smart auto-completion, and real-time error checking. <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="language-server-architecture" class="position-relative d-flex align-items-center group"> Language Server Architecture <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-architecture" aria-haspopup="dialog" aria-label="Share link: Language Server Architecture"> Share link </button> </h4>LSP uses a client-server architecture: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-fallback" data-lang="fallback">┌─────────────┐ ┌─────────────────┐ │ Editor │ JSON-RPC/stdio │ Language │ │ (Client) │<------------------>│ Server │ │ │ │ (Geode LSP) │ └─────────────┘ └─────────────────┘ │ │ QUIC ▼ ┌─────────────────┐ │ Geode │ │ Database │ └─────────────────┘ </code></pre></div><ul> <li>Client: Editor plugin that implements LSP client protocol</li> <li>Server: Geode LSP server that provides language intelligence</li> <li>Communication: JSON-RPC messages over stdin/stdout</li> <li>Database Connection: LSP server connects to Geode for schema info</li> </ul> <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>The protocol defines standard capabilities: <ul> <li>textDocument/completion: Auto-completion suggestions</li> <li>textDocument/hover: Hover tooltips with documentation</li> <li>textDocument/definition: Go-to-definition navigation</li> <li>textDocument/references: Find all references</li> <li>textDocument/documentSymbol: Document outline</li> <li>textDocument/formatting: Code formatting</li> <li>textDocument/diagnostics: Real-time error checking</li> <li>textDocument/codeAction: Quick fixes and refactorings</li> </ul> <h4 id="document-synchronization" class="position-relative d-flex align-items-center group"> Document Synchronization <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="document-synchronization" aria-haspopup="dialog" aria-label="Share link: Document Synchronization"> Share link </button> </h4>LSP tracks document state: <ul> <li>didOpen: Editor opens a GQL file</li> <li>didChange: User edits the document</li> <li>didSave: User saves changes</li> <li>didClose: Editor closes the document</li> </ul> The server maintains a synchronized copy of each document to provide accurate suggestions. <h4 id="schema-aware-features" class="position-relative d-flex align-items-center group"> Schema-Aware 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="schema-aware-features" aria-haspopup="dialog" aria-label="Share link: Schema-Aware Features"> Share link </button> </h4>Geode’s LSP server uses database schema for intelligent suggestions: <ul> <li>Label Completion: Suggests available node labels</li> <li>Property Completion: Suggests properties for specific labels</li> <li>Relationship Types: Suggests valid relationship types</li> <li>Function Signatures: Shows parameter lists for functions</li> <li>Index Hints: Suggests indexes for query optimization</li> </ul> <h3 id="how-lsp-works-in-geode" class="position-relative d-flex align-items-center group"> How LSP 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-lsp-works-in-geode" aria-haspopup="dialog" aria-label="Share link: How LSP Works in Geode"> Share link </button> </h3> <h4 id="installation-and-setup" class="position-relative d-flex align-items-center group"> Installation and Setup <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="installation-and-setup" aria-haspopup="dialog" aria-label="Share link: Installation and Setup"> Share link </button> </h4>Install the Geode LSP server: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash"># Install globally npm install -g @geodedb/language-server # Or use with editor plugin (VS Code example) code --install-extension geodedb.gql-language-server </code></pre></div>Configure connection to your database: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-json" data-lang="json">// .vscode/settings.json { "gql.server.host": "localhost", "gql.server.port": 3141, "gql.server.database": "mydb", "gql.server.tls": true, "gql.validation.enabled": true, "gql.completion.autoComplete": true } </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>The LSP server provides context-aware suggestions: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">MATCH (p:Pe| ^^ Person [label] Product [label] Pet [label] </code></pre></div>After selecting a label, property suggestions appear: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">MATCH (p:Person {na| ^^ name [property: STRING] nationality [property: STRING] </code></pre></div>Relationship type completion: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">MATCH (p:Person)-[:WO| ^^ WORKS_AT [relationship type] WORKED_WITH [relationship type] </code></pre></div> <h4 id="error-checking" class="position-relative d-flex align-items-center group"> Error Checking <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="error-checking" aria-haspopup="dialog" aria-label="Share link: Error Checking"> Share link </button> </h4>Real-time diagnostics highlight issues: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">MATCH (p:Person) WHERE p.age > 'thirty' ^^^^^^^^ Error: Type mismatch: cannot compare INTEGER with STRING </code></pre></div><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">MATCH (p:UnknownLabel) ^^^^^^^^^^^^ Warning: Label 'UnknownLabel' does not exist in schema </code></pre></div> <h4 id="hover-documentation" class="position-relative d-flex align-items-center group"> Hover Documentation <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-documentation" aria-haspopup="dialog" aria-label="Share link: Hover Documentation"> Share link </button> </h4>Hovering over keywords shows documentation: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">MATCH (n:Person) ^^^^^ MATCH clause: Specify graph patterns to match against the database. Syntax: MATCH <pattern> [WHERE <condition>] </code></pre></div>Hovering over properties shows type information: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">RETURN p.email ^^^^^ Property: email Type: STRING Indexed: UNIQUE BTREE Description: User's email address (unique identifier) </code></pre></div> <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>Jump to label or property definitions: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">MATCH (p:Person) // Ctrl+Click on "Person" jumps to schema definition ^^^^^^ -- Jump to: CREATE LABEL Person ( id INTEGER PRIMARY KEY, name STRING NOT NULL, email STRING UNIQUE, age INTEGER ); </code></pre></div> <h4 id="query-formatting" class="position-relative d-flex align-items-center group"> Query 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="query-formatting" aria-haspopup="dialog" aria-label="Share link: Query Formatting"> Share link </button> </h4>Auto-format GQL queries: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">// Before formatting MATCH(p:Person)-[:KNOWS]->(f)WHERE p.age>30RETURN p.name,f.name // After formatting (Shift+Alt+F) MATCH (p:Person)-[:KNOWS]->(f) WHERE p.age > 30 RETURN p.name, f.name </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="vs-code-integration" class="position-relative d-flex align-items-center group"> VS Code 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="vs-code-integration" aria-haspopup="dialog" aria-label="Share link: VS Code Integration"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-json" data-lang="json">// .vscode/settings.json { "gql.server.host": "localhost", "gql.server.port": 3141, "gql.validation.enabled": true, "gql.completion.autoComplete": true, "gql.format.enable": true, "gql.hover.documentation": true, "gql.trace.server": "verbose" } </code></pre></div>Create GQL file and get full IDE support: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">// queries.gql - Full LSP support enabled MATCH (p:Person)-[:WORKS_AT]->(c:Company) WHERE p.age > $minAge AND c.industry = $industry RETURN p.name AS employee, c.name AS company, p.salary AS salary ORDER BY p.salary DESC LIMIT 10 </code></pre></div> <h4 id="vimneovim-integration" class="position-relative d-flex align-items-center group"> Vim/Neovim 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="vimneovim-integration" aria-haspopup="dialog" aria-label="Share link: Vim/Neovim Integration"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-lua" data-lang="lua">-- init.lua require('lspconfig').geode_gql.setup({ cmd = { 'geode-language-server', '--stdio' }, filetypes = { 'gql', 'geode' }, root_dir = require('lspconfig').util.root_pattern('.git'), settings = { geode = { server = { host = 'localhost', port = 3141 }, validation = { enabled = true } } } }) </code></pre></div> <h4 id="emacs-integration" class="position-relative d-flex align-items-center group"> Emacs 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="emacs-integration" aria-haspopup="dialog" aria-label="Share link: Emacs Integration"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-elisp" data-lang="elisp">;; init.el (use-package lsp-mode :hook ((gql-mode . lsp)) :config (lsp-register-client (make-lsp-client :new-connection (lsp-stdio-connection "geode-language-server") :major-modes '(gql-mode) :server-id 'geode-gql))) (setq lsp-geode-server-host "localhost") (setq lsp-geode-server-port 3141) </code></pre></div> <h4 id="jupyter-notebook-integration" class="position-relative d-flex align-items-center group"> Jupyter Notebook 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="jupyter-notebook-integration" aria-haspopup="dialog" aria-label="Share link: Jupyter Notebook Integration"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-python" data-lang="python"># Enable LSP in Jupyter cells with %%gql magic %load_ext geode_jupyter %%gql MATCH (p:Person) WHERE p.age > 30 # Auto-completion works here! RETURN p.name, p.email </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="editor-configuration" class="position-relative d-flex align-items-center group"> Editor 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="editor-configuration" aria-haspopup="dialog" aria-label="Share link: Editor Configuration"> Share link </button> </h4><ol> <li>Enable All Features: Turn on validation, completion, and formatting</li> <li>Configure Connection: Set database connection parameters</li> <li>File Associations: Associate <code>.gql</code> files with GQL language mode</li> <li>Keybindings: Set up convenient shortcuts for common operations</li> <li>Diagnostics Level: Configure warning/error severity</li> </ol> <h4 id="query-development" class="position-relative d-flex align-items-center group"> Query Development <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" aria-haspopup="dialog" aria-label="Share link: Query Development"> Share link </button> </h4><ol> <li>Let LSP Guide: Follow auto-completion suggestions</li> <li>Fix Errors Early: Address red squiggles immediately</li> <li>Use Hover: Read documentation without leaving editor</li> <li>Format Frequently: Format queries for consistency</li> <li>Navigate with LSP: Use go-to-definition for exploration</li> </ol> <h4 id="schema-management" class="position-relative d-flex align-items-center group"> Schema 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="schema-management" aria-haspopup="dialog" aria-label="Share link: Schema Management"> Share link </button> </h4><ol> <li>Keep Schema Updated: LSP reflects current database schema</li> <li>Reload After Changes: Refresh LSP after schema modifications</li> <li>Document Schema: Add comments that appear in hover tooltips</li> <li>Use Type Hints: Leverage type information for correctness</li> </ol> <h4 id="performance-optimization" class="position-relative d-flex align-items-center group"> Performance 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="performance-optimization" aria-haspopup="dialog" aria-label="Share link: Performance Optimization"> Share link </button> </h4><ol> <li>Lazy Loading: Configure LSP to load schema on demand</li> <li>Cache Settings: Enable schema caching for large databases</li> <li>Selective Completion: Limit suggestions for very large schemas</li> <li>Debounce Validation: Adjust validation debounce time</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="startup-time" class="position-relative d-flex align-items-center group"> Startup Time <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="startup-time" aria-haspopup="dialog" aria-label="Share link: Startup Time"> Share link </button> </h4>LSP server initialization is fast: <ul> <li>Server Start: 100-300ms cold start</li> <li>Schema Loading: 50-200ms depending on schema size</li> <li>First Completion: <10ms after initialization</li> <li>Incremental Updates: <5ms for document changes</li> </ul> <h4 id="memory-usage" class="position-relative d-flex align-items-center group"> Memory Usage <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="memory-usage" aria-haspopup="dialog" aria-label="Share link: Memory Usage"> Share link </button> </h4>LSP server is lightweight: <ul> <li>Base Memory: ~50MB for server process</li> <li>Schema Cache: ~1-5MB for typical schemas</li> <li>Document State: ~10KB per open document</li> <li>Total: <100MB for typical usage</li> </ul> <h4 id="completion-performance" class="position-relative d-flex align-items-center group"> Completion 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="completion-performance" aria-haspopup="dialog" aria-label="Share link: Completion Performance"> Share link </button> </h4>Auto-completion is very responsive: <ul> <li>Keyword Completion: <1ms (pre-computed)</li> <li>Label Completion: 1-5ms (schema lookup)</li> <li>Property Completion: 2-10ms (filtered by label)</li> <li>Complex Queries: <20ms even with large schemas</li> </ul> <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="lsp-server-not-starting" class="position-relative d-flex align-items-center group"> LSP Server Not Starting <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-server-not-starting" aria-haspopup="dialog" aria-label="Share link: LSP Server Not Starting"> Share link </button> </h4>Symptom: Editor shows “Language server failed to start” Solutions: <ul> <li>Verify <code>geode-language-server</code> is in PATH</li> <li>Check server logs in editor output panel</li> <li>Confirm Node.js version >= 16</li> <li>Test server manually: <code>geode-language-server --stdio</code></li> <li>Review editor’s LSP configuration</li> </ul> <h4 id="no-auto-completion" class="position-relative d-flex align-items-center group"> No 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="no-auto-completion" aria-haspopup="dialog" aria-label="Share link: No Auto-Completion"> Share link </button> </h4>Symptom: Auto-completion not appearing Solutions: <ul> <li>Verify file has <code>.gql</code> extension</li> <li>Check LSP client is enabled for GQL files</li> <li>Confirm database connection settings</li> <li>Test schema loading: hover over existing label</li> <li>Restart LSP server</li> </ul> <h4 id="incorrect-suggestions" class="position-relative d-flex align-items-center group"> Incorrect Suggestions <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="incorrect-suggestions" aria-haspopup="dialog" aria-label="Share link: Incorrect Suggestions"> Share link </button> </h4>Symptom: Wrong or outdated suggestions Solutions: <ul> <li>Refresh schema cache</li> <li>Verify LSP connected to correct database</li> <li>Check for schema changes not yet loaded</li> <li>Clear LSP cache and restart</li> <li>Review database connection status</li> </ul> <h4 id="performance-issues" class="position-relative d-flex align-items-center group"> Performance Issues <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="performance-issues" aria-haspopup="dialog" aria-label="Share link: Performance Issues"> Share link </button> </h4>Symptom: Slow auto-completion or validation Solutions: <ul> <li>Enable schema caching</li> <li>Increase debounce time for validation</li> <li>Limit completion result count</li> <li>Check network latency to database</li> <li>Review LSP trace logs for bottlenecks</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/ide/" >IDE Integration</a> - Editor and IDE features</li> <li><a href="/tags/tools/" >Developer Tools</a> - Development tooling</li> <li><a href="/tags/gql-syntax/" >GQL Syntax</a> - GQL language syntax</li> <li><a href="/tags/development/" >Query Development</a> - Query development workflow</li> <li><a href="/tags/productivity/" >Productivity</a> - Developer productivity</li> <li><a href="/tags/tooling/" >Tooling</a> - Development tools ecosystem</li> </ul> <h3 id="implementation-details" class="position-relative d-flex align-items-center group"> Implementation Details <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="implementation-details" aria-haspopup="dialog" aria-label="Share link: Implementation Details"> Share link </button> </h3> <h4 id="language-server-architecture-1" class="position-relative d-flex align-items-center group"> Language Server Architecture <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-architecture-1" aria-haspopup="dialog" aria-label="Share link: Language Server Architecture"> Share link </button> </h4>Geode’s LSP server implements the full LSP specification: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-fallback" data-lang="fallback">┌──────────────────────────────────────────────┐ │ Editor (VS Code, Vim, Emacs, etc.) │ │ - UI rendering │ │ - User input handling │ │ - LSP client implementation │ └────────────────┬─────────────────────────────┘ │ JSON-RPC over stdio/socket ┌────────────────▼─────────────────────────────┐ │ Geode Language Server │ │ ┌──────────────────────────────────────┐ │ │ │ Protocol Handler │ │ │ │ - Message routing │ │ │ │ - Request/response matching │ │ │ └────────────┬─────────────────────────┘ │ │ │ │ │ ┌────────────▼─────────────────────────┐ │ │ │ Document Manager │ │ │ │ - Tracks open documents │ │ │ │ - Synchronizes changes │ │ │ │ - Caches parsed ASTs │ │ │ └────────────┬─────────────────────────┘ │ │ │ │ │ ┌────────────▼─────────────────────────┐ │ │ │ GQL Parser & Analyzer │ │ │ │ - Lexical analysis │ │ │ │ - Syntax parsing │ │ │ │ - Semantic analysis │ │ │ │ - Type checking │ │ │ └────────────┬─────────────────────────┘ │ │ │ │ │ ┌────────────▼─────────────────────────┐ │ │ │ Schema Provider │ │ │ │ - Connects to Geode database │ │ │ │ - Caches schema information │ │ │ │ - Provides label/property metadata │ │ │ └────────────┬─────────────────────────┘ │ │ │ │ │ ┌────────────▼─────────────────────────┐ │ │ │ Feature Providers │ │ │ │ - Completion │ │ │ │ - Hover │ │ │ │ - Definition │ │ │ │ - Diagnostics │ │ │ │ - Formatting │ │ │ └──────────────────────────────────────┘ │ └──────────────┬───────────────────────────────┘ │ QUIC/TLS ┌──────────────▼───────────────────────────────┐ │ Geode Database Server │ │ - Schema metadata │ │ - Index information │ │ - Query validation │ └──────────────────────────────────────────────┘ </code></pre></div> <h4 id="completion-provider-implementation" class="position-relative d-flex align-items-center group"> Completion Provider Implementation <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="completion-provider-implementation" aria-haspopup="dialog" aria-label="Share link: Completion Provider Implementation"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-typescript" data-lang="typescript">// Simplified TypeScript pseudocode class CompletionProvider { async provideCompletionItems( document: TextDocument, position: Position ): Promise<CompletionItem[]> { const line = document.lineAt(position.line).text; const context = this.getContext(line, position.character); if (context.type === 'LABEL') { // Provide label completions const labels = await this.schemaProvider.getLabels(); return labels.map(label => ({ label: label.name, kind: CompletionItemKind.Class, detail: `Label with ${label.propertyCount} properties`, documentation: label.description, insertText: label.name })); } if (context.type === 'PROPERTY') { // Provide property completions for specific label const properties = await this.schemaProvider.getProperties( context.labelName ); return properties.map(prop => ({ label: prop.name, kind: CompletionItemKind.Property, detail: `${prop.type}${prop.nullable ? ' | null' : ''}`, documentation: prop.description, insertText: prop.name })); } if (context.type === 'RELATIONSHIP_TYPE') { // Provide relationship type completions const types = await this.schemaProvider.getRelationshipTypes(); return types.map(type => ({ label: type.name, kind: CompletionItemKind.Reference, detail: `${type.fromLabel} -> ${type.toLabel}`, documentation: type.description, insertText: type.name })); } // Default: GQL keywords return this.getKeywordCompletions(context); } private getKeywordCompletions(context: Context): CompletionItem[] { const keywords = [ 'MATCH', 'WHERE', 'RETURN', 'CREATE', 'DELETE', 'SET', 'MERGE', 'WITH', 'ORDER BY', 'LIMIT', 'SKIP', ... ]; return keywords .filter(kw => kw.startsWith(context.prefix.toUpperCase())) .map(kw => ({ label: kw, kind: CompletionItemKind.Keyword, insertText: kw + ' ' })); } } </code></pre></div> <h4 id="diagnostic-provider-implementation" class="position-relative d-flex align-items-center group"> Diagnostic Provider Implementation <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="diagnostic-provider-implementation" aria-haspopup="dialog" aria-label="Share link: Diagnostic Provider Implementation"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-typescript" data-lang="typescript">class DiagnosticProvider { async provideDiagnostics( document: TextDocument ): Promise<Diagnostic[]> { const diagnostics: Diagnostic[] = []; try { // Parse query const ast = this.parser.parse(document.getText()); // Validate against schema const schemaErrors = await this.validateSchema(ast); diagnostics.push(...schemaErrors); // Type checking const typeErrors = this.checkTypes(ast); diagnostics.push(...typeErrors); // Best practices warnings const warnings = this.checkBestPractices(ast); diagnostics.push(...warnings); } catch (syntaxError) { // Syntax error from parser diagnostics.push({ range: this.getErrorRange(syntaxError), message: syntaxError.message, severity: DiagnosticSeverity.Error, source: 'gql-parser' }); } return diagnostics; } private async validateSchema(ast: ASTNode): Promise<Diagnostic[]> { const diagnostics: Diagnostic[] = []; for (const node of ast.matchClauses) { if (node.label) { // Check if label exists const labelExists = await this.schemaProvider.hasLabel( node.label ); if (!labelExists) { diagnostics.push({ range: node.labelRange, message: `Label '${node.label}' does not exist in schema`, severity: DiagnosticSeverity.Warning, source: 'gql-schema', code: 'unknown-label' }); } } // Check properties for (const prop of node.properties) { const propExists = await this.schemaProvider.hasProperty( node.label, prop.name ); if (!propExists) { diagnostics.push({ range: prop.range, message: `Property '${prop.name}' does not exist on label '${node.label}'`, severity: DiagnosticSeverity.Error, source: 'gql-schema', code: 'unknown-property' }); } } } return diagnostics; } private checkTypes(ast: ASTNode): Diagnostic[] { const diagnostics: Diagnostic[] = []; // Type check comparisons for (const comparison of ast.comparisons) { const leftType = this.inferType(comparison.left); const rightType = this.inferType(comparison.right); if (!this.typesCompatible(leftType, rightType)) { diagnostics.push({ range: comparison.range, message: `Type mismatch: cannot compare ${leftType} with ${rightType}`, severity: DiagnosticSeverity.Error, source: 'gql-type-checker', code: 'type-mismatch' }); } } return diagnostics; } private checkBestPractices(ast: ASTNode): Diagnostic[] { const diagnostics: Diagnostic[] = []; // Check for unbounded traversals for (const pattern of ast.patterns) { if (pattern.isVariableLength && !pattern.hasMaxDepth) { diagnostics.push({ range: pattern.range, message: 'Unbounded variable-length pattern may cause performance issues', severity: DiagnosticSeverity.Warning, source: 'gql-best-practices', code: 'unbounded-traversal' }); } } // Check for missing LIMIT if (!ast.hasLimit && ast.matchClauses.length > 0) { diagnostics.push({ range: ast.range, message: 'Consider adding LIMIT clause to bound result set', severity: DiagnosticSeverity.Hint, source: 'gql-best-practices', code: 'missing-limit' }); } return diagnostics; } } </code></pre></div> <h4 id="schema-caching-strategy" class="position-relative d-flex align-items-center group"> Schema Caching Strategy <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-caching-strategy" aria-haspopup="dialog" aria-label="Share link: Schema Caching Strategy"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-typescript" data-lang="typescript">class SchemaProvider { private cache: Map<string, CacheEntry> = new Map(); private cacheTimeout = 300000; // 5 minutes async getLabels(): Promise<Label[]> { const cacheKey = 'labels'; if (this.isCached(cacheKey)) { return this.cache.get(cacheKey)!.data; } // Fetch from database const labels = await this.client.execute(` SHOW LABELS `); this.cache.set(cacheKey, { data: labels, timestamp: Date.now() }); return labels; } async getProperties(label: string): Promise<Property[]> { const cacheKey = `properties:${label}`; if (this.isCached(cacheKey)) { return this.cache.get(cacheKey)!.data; } const properties = await this.client.execute(` SHOW PROPERTIES FOR (:${label}) `); this.cache.set(cacheKey, { data: properties, timestamp: Date.now() }); return properties; } invalidateCache() { this.cache.clear(); } private isCached(key: string): boolean { const entry = this.cache.get(key); if (!entry) return false; const age = Date.now() - entry.timestamp; if (age > this.cacheTimeout) { this.cache.delete(key); return false; } return true; } } </code></pre></div> <h3 id="advanced-ide-features" class="position-relative d-flex align-items-center group"> Advanced IDE 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-ide-features" aria-haspopup="dialog" aria-label="Share link: Advanced IDE Features"> Share link </button> </h3> <h4 id="inlay-hints" class="position-relative d-flex align-items-center group"> Inlay Hints <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="inlay-hints" aria-haspopup="dialog" aria-label="Share link: Inlay Hints"> Share link </button> </h4>Display inferred types inline: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">MATCH (u:User)-[:PURCHASED]->(p:Product) ^^User ^^Product WHERE p.price > 100 ^^number WITH u, count(p) AS purchase_count ^^number RETURN u.name, purchase_count ^^string ^^number </code></pre></div> <h4 id="code-actions-quick-fixes" class="position-relative d-flex align-items-center group"> Code Actions (Quick Fixes) <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-actions-quick-fixes" aria-haspopup="dialog" aria-label="Share link: Code Actions (Quick Fixes)"> Share link </button> </h4>Provide automated fixes for common issues: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">// Before: unbounded traversal MATCH (u:User)-[:KNOWS*]->(friend) ▲ Quick fix: Add depth limit // After: quick fix applied MATCH (u:User)-[:KNOWS*1..3]->(friend) </code></pre></div><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-typescript" data-lang="typescript">class CodeActionProvider { async provideCodeActions( document: TextDocument, range: Range, context: CodeActionContext ): Promise<CodeAction[]> { const actions: CodeAction[] = []; for (const diagnostic of context.diagnostics) { if (diagnostic.code === 'unbounded-traversal') { actions.push({ title: 'Add depth limit (1..3)', kind: CodeActionKind.QuickFix, diagnostics: [diagnostic], edit: { changes: { [document.uri]: [{ range: diagnostic.range, newText: this.addDepthLimit(diagnostic.range, '1..3') }] } } }); } if (diagnostic.code === 'missing-limit') { actions.push({ title: 'Add LIMIT clause', kind: CodeActionKind.QuickFix, diagnostics: [diagnostic], edit: { changes: { [document.uri]: [{ range: new Range(document.lineCount, 0, document.lineCount, 0), newText: '\nLIMIT 100;' }] } } }); } } return actions; } } </code></pre></div> <h4 id="semantic-highlighting" class="position-relative d-flex align-items-center group"> Semantic 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="semantic-highlighting" aria-haspopup="dialog" aria-label="Share link: Semantic Highlighting"> Share link </button> </h4>Syntax highlighting based on semantic meaning: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">MATCH (u:User {id: $user_id})-[:PURCHASED]->(p:Product) ▲ ▲ ▲ ▲ ▲ │ │ │ │ │ variable label property relationship label (blue) (green) (yellow) (purple) (green) WHERE p.price > 100 ▲ ▲ ▲ ▲ │ │ │ │ variable │ │ number property operator (literal) RETURN u.name AS user_name ▲ ▲▲ ▲ │ ││ │ variable ││ alias property keyword </code></pre></div> <h4 id="workspace-symbol-search" class="position-relative d-flex align-items-center group"> Workspace Symbol 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="workspace-symbol-search" aria-haspopup="dialog" aria-label="Share link: Workspace Symbol Search"> Share link </button> </h4>Find symbols across all GQL files: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-fallback" data-lang="fallback">Ctrl+T → "User" Results: ┌────────────────────────────────────────┐ │ (:User) - queries/users.gql:1 │ │ (:User:Admin) - queries/admin.gql:15 │ │ user_events - streams/events.gql:42 │ └────────────────────────────────────────┘ </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="https://microsoft.github.io/language-server-protocol/" aria-label="LSP Specification – opens in new window" target="_blank" rel="noopener noreferrer" >LSP Specification ↗ </a> - Official LSP documentation</li> <li><a href="/docs/development/lsp-guide/" >Geode LSP Guide</a> - Installation and configuration</li> <li><a href="/docs/gql-reference/" >GQL Language Reference</a> - Complete GQL documentation</li> <li><a href="/docs/development/repl-advanced/" >REPL Advanced Guide</a> - Advanced REPL usage</li> <li><a href="https://code.visualstudio.com/api/language-extensions/language-server-extension-guide" aria-label="Language Server Implementation Guide – opens in new window" target="_blank" rel="noopener noreferrer" >Language Server Implementation Guide ↗ </a> - VS Code LSP guide</li> </ul>

Popular

Related Articles

Neovim Plugin

Editor Plugins

VSCode Extension

Claude Code Plugin