Neovim Plugin for Geode GQL

Neovim has become the editor of choice for developers who value speed, extensibility, and keyboard-driven workflows. The Geode GQL plugin brings first-class graph database development support to Neovim through native LSP integration, Tree-sitter-powered syntax highlighting, Telescope integration for schema exploration, and seamless query execution capabilities. Built on Neovim’s modern Lua API and leveraging the Language Server Protocol, the Geode plugin provides intelligent auto-completion, real-time diagnostics, hover documentation, and code navigation while maintaining the lightning-fast performance Neovim users expect. This guide covers installation, configuration, features, keymappings, integration with popular Neovim plugins, and best practices for productive GQL development in Neovim. <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="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>Ensure you have the following installed: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash"># Neovim 0.9.0+ required nvim --version # Geode CLI must be in PATH which geode geode --version # Optional: Node.js for some features node --version </code></pre></div> <h4 id="using-lazynvim" class="position-relative d-flex align-items-center group"> Using lazy.nvim <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="using-lazynvim" aria-haspopup="dialog" aria-label="Share link: Using lazy.nvim"> Share link </button> </h4>The recommended package manager for Neovim: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-lua" data-lang="lua">-- ~/.config/nvim/lua/plugins/geode.lua return { { "geodedb/geode.nvim", dependencies = { "neovim/nvim-lspconfig", "nvim-treesitter/nvim-treesitter", "nvim-lua/plenary.nvim", "nvim-telescope/telescope.nvim", -- Optional "hrsh7th/nvim-cmp", -- Optional }, ft = { "gql" }, config = function() require("geode").setup({ -- Configuration options }) end, }, } </code></pre></div> <h4 id="using-packernvim" class="position-relative d-flex align-items-center group"> Using packer.nvim <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="using-packernvim" aria-haspopup="dialog" aria-label="Share link: Using packer.nvim"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-lua" data-lang="lua">-- ~/.config/nvim/lua/plugins.lua use { "geodedb/geode.nvim", requires = { "neovim/nvim-lspconfig", "nvim-treesitter/nvim-treesitter", "nvim-lua/plenary.nvim", }, config = function() require("geode").setup() end, } </code></pre></div> <h4 id="using-vim-plug" class="position-relative d-flex align-items-center group"> Using vim-plug <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="using-vim-plug" aria-haspopup="dialog" aria-label="Share link: Using vim-plug"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-vim" data-lang="vim">" ~/.config/nvim/init.vim Plug 'neovim/nvim-lspconfig' Plug 'nvim-treesitter/nvim-treesitter', {'do': ':TSUpdate'} Plug 'nvim-lua/plenary.nvim' Plug 'geodedb/geode.nvim' </code></pre></div> <h4 id="manual-installation" class="position-relative d-flex align-items-center group"> Manual 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="manual-installation" aria-haspopup="dialog" aria-label="Share link: Manual Installation"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash"># Clone to Neovim packages directory git clone https://github.com/geodedb/geode.nvim \ ~/.local/share/nvim/site/pack/geode/start/geode.nvim # Install Tree-sitter parser nvim -c "TSInstall gql" -c "q" </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="basic-setup" class="position-relative d-flex align-items-center group"> Basic 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="basic-setup" aria-haspopup="dialog" aria-label="Share link: Basic Setup"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-lua" data-lang="lua">-- ~/.config/nvim/lua/config/geode.lua local geode = require("geode") geode.setup({ -- LSP configuration lsp = { enabled = true, cmd = { "geode", "lsp", "--stdio" }, log_level = "info", settings = { diagnostics = { enabled = true, max_problems = 100, }, completion = { enabled = true, suggest_labels = true, suggest_properties = true, suggest_functions = true, }, }, }, -- Server connection connection = { host = "localhost", port = 3141, database = "default", tls = false, timeout = 30000, }, -- Query execution execution = { auto_commit = false, max_rows = 1000, format_results = true, }, -- UI settings ui = { results_window = "split", -- "split", "vsplit", "float", "tab" results_height = 15, results_width = 80, border = "rounded", icons = { label = "", property = "", relationship = "", function_icon = "󰊕", index = "", }, }, -- Formatting formatting = { enabled = true, format_on_save = true, keyword_case = "UPPER", indent_size = 2, max_line_length = 100, }, -- Keymaps (set to false to disable defaults) keymaps = { execute_query = "<leader>ge", execute_selection = "<leader>gs", explain_query = "<leader>gx", profile_query = "<leader>gp", format_query = "<leader>gf", toggle_results = "<leader>gr", schema_explorer = "<leader>gS", connect = "<leader>gc", }, }) </code></pre></div> <h4 id="lsp-configuration" class="position-relative d-flex align-items-center group"> LSP 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="lsp-configuration" aria-haspopup="dialog" aria-label="Share link: LSP Configuration"> Share link </button> </h4>Configure the Language Server with nvim-lspconfig: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-lua" data-lang="lua">-- ~/.config/nvim/lua/config/lsp.lua local lspconfig = require("lspconfig") local configs = require("lspconfig.configs") -- Define Geode GQL language server if not configs.geode_gql then configs.geode_gql = { default_config = { cmd = { "geode", "lsp", "--stdio" }, filetypes = { "gql" }, root_dir = function(fname) return lspconfig.util.find_git_ancestor(fname) or lspconfig.util.path.dirname(fname) end, single_file_support = true, settings = { geode = { connection = { host = "localhost", port = 3141, }, diagnostics = { enabled = true, }, }, }, }, } end -- Setup with capabilities local capabilities = require("cmp_nvim_lsp").default_capabilities() lspconfig.geode_gql.setup({ capabilities = capabilities, on_attach = function(client, bufnr) -- Enable completion triggered by <c-x><c-o> vim.api.nvim_buf_set_option(bufnr, "omnifunc", "v:lua.vim.lsp.omnifunc") -- Keybindings local opts = { buffer = bufnr, noremap = true, silent = true } vim.keymap.set("n", "gd", vim.lsp.buf.definition, opts) vim.keymap.set("n", "K", vim.lsp.buf.hover, opts) vim.keymap.set("n", "gr", vim.lsp.buf.references, opts) vim.keymap.set("n", "<leader>rn", vim.lsp.buf.rename, opts) vim.keymap.set("n", "<leader>ca", vim.lsp.buf.code_action, opts) vim.keymap.set("n", "[d", vim.diagnostic.goto_prev, opts) vim.keymap.set("n", "]d", vim.diagnostic.goto_next, opts) end, }) </code></pre></div> <h4 id="tree-sitter-configuration" class="position-relative d-flex align-items-center group"> Tree-sitter 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="tree-sitter-configuration" aria-haspopup="dialog" aria-label="Share link: Tree-sitter Configuration"> Share link </button> </h4>Enable Tree-sitter for enhanced syntax highlighting: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-lua" data-lang="lua">-- ~/.config/nvim/lua/config/treesitter.lua require("nvim-treesitter.configs").setup({ ensure_installed = { "gql" }, highlight = { enable = true, additional_vim_regex_highlighting = false, }, indent = { enable = true, }, incremental_selection = { enable = true, keymaps = { init_selection = "<CR>", node_incremental = "<CR>", scope_incremental = "<TAB>", node_decremental = "<BS>", }, }, textobjects = { select = { enable = true, lookahead = true, keymaps = { ["af"] = "@function.outer", ["if"] = "@function.inner", ["aq"] = "@query.outer", ["iq"] = "@query.inner", }, }, move = { enable = true, goto_next_start = { ["]q"] = "@query.outer", }, goto_previous_start = { ["[q"] = "@query.outer", }, }, }, }) </code></pre></div> <h4 id="nvim-cmp-integration" class="position-relative d-flex align-items-center group"> nvim-cmp 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="nvim-cmp-integration" aria-haspopup="dialog" aria-label="Share link: nvim-cmp Integration"> Share link </button> </h4>Configure auto-completion with nvim-cmp: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-lua" data-lang="lua">-- ~/.config/nvim/lua/config/cmp.lua local cmp = require("cmp") local luasnip = require("luasnip") cmp.setup({ snippet = { expand = function(args) luasnip.lsp_expand(args.body) end, }, mapping = cmp.mapping.preset.insert({ ["<C-b>"] = cmp.mapping.scroll_docs(-4), ["<C-f>"] = cmp.mapping.scroll_docs(4), ["<C-Space>"] = cmp.mapping.complete(), ["<C-e>"] = cmp.mapping.abort(), ["<CR>"] = cmp.mapping.confirm({ select = true }), ["<Tab>"] = cmp.mapping(function(fallback) if cmp.visible() then cmp.select_next_item() elseif luasnip.expand_or_jumpable() then luasnip.expand_or_jump() else fallback() end end, { "i", "s" }), }), sources = cmp.config.sources({ { name = "nvim_lsp", priority = 1000 }, { name = "luasnip", priority = 750 }, { name = "buffer", priority = 500 }, { name = "path", priority = 250 }, }), formatting = { format = function(entry, vim_item) local icons = { Text = "", Method = "󰆧", Function = "󰊕", Constructor = "", Field = "󰜢", Variable = "󰀫", Class = "󰠱", Interface = "", Module = "", Property = "󰜢", Keyword = "󰌋", Snippet = "", Color = "󰏘", File = "󰈙", Reference = "", Folder = "󰉋", EnumMember = "", Constant = "󰏿", Struct = "", } vim_item.kind = string.format("%s %s", icons[vim_item.kind], vim_item.kind) vim_item.menu = ({ nvim_lsp = "[LSP]", luasnip = "[Snip]", buffer = "[Buf]", path = "[Path]", })[entry.source.name] return vim_item end, }, }) -- GQL-specific completion cmp.setup.filetype("gql", { sources = cmp.config.sources({ { name = "nvim_lsp" }, { name = "geode_labels" }, { name = "geode_properties" }, { name = "luasnip" }, }), }) </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>Tree-sitter provides accurate, context-aware highlighting: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">-- Keywords highlighted distinctly MATCH (u:User)-[:FOLLOWS]->(f:User) WHERE u.active = true AND u.created_at > datetime('2024-01-01') RETURN f.name AS friend_name, COUNT(*) AS connection_count GROUP BY f.name ORDER BY connection_count DESC LIMIT 10; -- Labels in type color CREATE (p:Product:Featured { id: randomUUID(), name: 'Premium Widget', price: 99.99 }); -- Functions highlighted MATCH (u:User) RETURN UPPER(u.name), COALESCE(u.nickname, u.name), SIZE([(u)-[:FOLLOWS]->() | 1]); </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 completions powered by LSP: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">-- After typing "MATCH (u:" -- Completions: User, Product, Order, Category, etc. -- After typing "WHERE u." -- Completions: id, name, email, created_at, active, etc. -- After typing "-[:" -- Completions: FOLLOWS, PURCHASED, VIEWED, RATED, etc. -- After typing "RETURN COUNT(" -- Shows function signature: COUNT(expression) -> Integer </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 appear inline: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">MATCH (u:User) WHER u.email = 'test@example.com' -- ^ Error: Unknown keyword 'WHER'. Did you mean 'WHERE'? MATCH (u:UnknownLabel) -- ^^^^^^^^^^^^ Warning: Label 'UnknownLabel' not found MATCH (u:User) WHERE u.nonexistent = 'value' -- ^^^^^^^^^^^^^ Warning: Property 'nonexistent' not in schema </code></pre></div>View diagnostics: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-lua" data-lang="lua">-- Show all diagnostics in quickfix list vim.diagnostic.setqflist() -- Show diagnostics for current line vim.diagnostic.open_float() -- Navigate diagnostics vim.diagnostic.goto_next() vim.diagnostic.goto_prev() </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>Press <code>K</code> to see documentation: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">MATCH (u:User) -- ^^^^ K shows: "Label: User, Nodes: 1,234, Properties: id, name, email, ..." WHERE u.email LIKE '%@example.com' -- ^^^^^ K shows: "Property: email, Type: String, Indexed: true, Unique: true" RETURN COALESCE(u.nickname, u.name) -- ^^^^^^^^ K shows: "COALESCE(value, default, ...) -> T -- Returns first non-null value from arguments" </code></pre></div> <h4 id="code-navigation" class="position-relative d-flex align-items-center group"> Code Navigation <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-navigation" aria-haspopup="dialog" aria-label="Share link: Code Navigation"> Share link </button> </h4>Go to Definition (<code>gd</code>): <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 -- ^^^^^^ gd jumps to "(friend:User)" binding </code></pre></div>Find References (<code>gr</code>): <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">MATCH (u:User) -- ^ gr shows all 4 usages of 'u' in the query WHERE u.email LIKE '%@example.com' AND u.active = true RETURN u.name, u.email; </code></pre></div>Rename Symbol (<code><leader>rn</code>): <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">-- Rename 'u' to 'user' across entire query MATCH (u:User)-[:FOLLOWS]->(f:User) WHERE u.active = true RETURN u.name, f.name; </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 directly from Neovim: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-lua" data-lang="lua">-- Execute current query vim.keymap.set("n", "<leader>ge", function() require("geode").execute_query() end) -- Execute visual selection vim.keymap.set("v", "<leader>gs", function() require("geode").execute_selection() end) -- Execute with EXPLAIN vim.keymap.set("n", "<leader>gx", function() require("geode").explain_query() end) -- Execute with PROFILE vim.keymap.set("n", "<leader>gp", function() require("geode").profile_query() end) </code></pre></div>Results appear in a split window: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-fallback" data-lang="fallback">┌─ Query Results ──────────────────────────────────────────┐ │ ✓ Query executed successfully (12ms, 3 rows) │ ├──────────────────────────────────────────────────────────┤ │ name │ email │ created_at │ ├───────────────┼──────────────────────┼───────────────────┤ │ Alice Johnson │ [email protected] │ 2024-01-15 │ │ Bob Smith │ [email protected] │ 2024-02-20 │ │ Carol Davis │ [email protected] │ 2024-03-10 │ └──────────────────────────────────────────────────────────┘ </code></pre></div> <h4 id="telescope-integration" class="position-relative d-flex align-items-center group"> Telescope 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="telescope-integration" aria-haspopup="dialog" aria-label="Share link: Telescope Integration"> Share link </button> </h4>Browse schema and queries with Telescope: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-lua" data-lang="lua">-- Configure Telescope extension require("telescope").load_extension("geode") -- Keymaps vim.keymap.set("n", "<leader>gl", "<cmd>Telescope geode labels<CR>") vim.keymap.set("n", "<leader>gp", "<cmd>Telescope geode properties<CR>") vim.keymap.set("n", "<leader>gR", "<cmd>Telescope geode relationships<CR>") vim.keymap.set("n", "<leader>gq", "<cmd>Telescope geode saved_queries<CR>") vim.keymap.set("n", "<leader>gh", "<cmd>Telescope geode history<CR>") </code></pre></div>Telescope Pickers: <table> <thead> <tr> <th>Command</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td><code>:Telescope geode labels</code></td> <td>Browse all labels</td> </tr> <tr> <td><code>:Telescope geode properties</code></td> <td>Search properties</td> </tr> <tr> <td><code>:Telescope geode relationships</code></td> <td>Browse relationship types</td> </tr> <tr> <td><code>:Telescope geode functions</code></td> <td>Search GQL functions</td> </tr> <tr> <td><code>:Telescope geode saved_queries</code></td> <td>Open saved queries</td> </tr> <tr> <td><code>:Telescope geode history</code></td> <td>Query execution history</td> </tr> <tr> <td><code>:Telescope geode connections</code></td> <td>Switch connections</td> </tr> </tbody> </table> <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>LuaSnip snippets for common patterns: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-lua" data-lang="lua">-- ~/.config/nvim/lua/snippets/gql.lua local ls = require("luasnip") local s = ls.snippet local t = ls.text_node local i = ls.insert_node local c = ls.choice_node ls.add_snippets("gql", { -- Basic MATCH s("match", { t("MATCH ("), i(1, "n"), t(":"), i(2, "Label"), t(")"), t({ "", "WHERE " }), i(3, "condition"), t({ "", "RETURN " }), i(4, "n"), t(";"), }), -- CREATE node s("create", { t("CREATE ("), i(1, "n"), t(":"), i(2, "Label"), t(" {"), t({ "", " " }), i(3, "property"), t(": "), i(4, "value"), t({ "", "});" }), }), -- Path pattern s("path", { t("MATCH path = ("), i(1, "start"), t(":"), i(2, "Label"), t(")"), t("-[:"), i(3, "REL"), t("*"), i(4, "1..3"), t("]->("), i(5, "end"), t(":"), i(6, "Label"), t(")"), t({ "", "RETURN path;" }), }), -- Aggregation s("agg", { t("MATCH ("), i(1, "n"), t(":"), i(2, "Label"), t(")"), t({ "", "RETURN " }), c(3, { t("COUNT(*)"), t("SUM(n."), t("AVG(n."), t("MIN(n."), t("MAX(n."), }), t(" AS "), i(4, "result"), t(";"), }), }) </code></pre></div> <h3 id="keybindings" class="position-relative d-flex align-items-center group"> 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="keybindings" aria-haspopup="dialog" aria-label="Share link: Keybindings"> Share link </button> </h3> <h4 id="default-keymaps" class="position-relative d-flex align-items-center group"> Default Keymaps <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-keymaps" aria-haspopup="dialog" aria-label="Share link: Default Keymaps"> Share link </button> </h4><table> <thead> <tr> <th>Action</th> <th>Keymap</th> <th>Mode</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td>Execute Query</td> <td><code><leader>ge</code></td> <td>n</td> <td>Execute query under cursor</td> </tr> <tr> <td>Execute Selection</td> <td><code><leader>gs</code></td> <td>v</td> <td>Execute selected text</td> </tr> <tr> <td>Explain Query</td> <td><code><leader>gx</code></td> <td>n</td> <td>Show execution plan</td> </tr> <tr> <td>Profile Query</td> <td><code><leader>gp</code></td> <td>n</td> <td>Execute with profiling</td> </tr> <tr> <td>Format Query</td> <td><code><leader>gf</code></td> <td>n</td> <td>Format current buffer</td> </tr> <tr> <td>Toggle Results</td> <td><code><leader>gr</code></td> <td>n</td> <td>Toggle results window</td> </tr> <tr> <td>Schema Explorer</td> <td><code><leader>gS</code></td> <td>n</td> <td>Open schema explorer</td> </tr> <tr> <td>Connect</td> <td><code><leader>gc</code></td> <td>n</td> <td>Connect to server</td> </tr> <tr> <td>Go to Definition</td> <td><code>gd</code></td> <td>n</td> <td>Jump to definition</td> </tr> <tr> <td>Hover</td> <td><code>K</code></td> <td>n</td> <td>Show hover information</td> </tr> <tr> <td>Find References</td> <td><code>gr</code></td> <td>n</td> <td>Find all references</td> </tr> <tr> <td>Rename</td> <td><code><leader>rn</code></td> <td>n</td> <td>Rename symbol</td> </tr> <tr> <td>Code Action</td> <td><code><leader>ca</code></td> <td>n</td> <td>Show code actions</td> </tr> <tr> <td>Next Diagnostic</td> <td><code>]d</code></td> <td>n</td> <td>Go to next diagnostic</td> </tr> <tr> <td>Prev Diagnostic</td> <td><code>[d</code></td> <td>n</td> <td>Go to previous diagnostic</td> </tr> </tbody> </table> <h4 id="custom-keymaps" class="position-relative d-flex align-items-center group"> Custom Keymaps <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-keymaps" aria-haspopup="dialog" aria-label="Share link: Custom Keymaps"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-lua" data-lang="lua">-- ~/.config/nvim/after/ftplugin/gql.lua local opts = { buffer = true, noremap = true, silent = true } -- Query execution vim.keymap.set("n", "<C-CR>", function() require("geode").execute_query() end, opts) vim.keymap.set("v", "<C-CR>", function() require("geode").execute_selection() end, opts) -- Results navigation vim.keymap.set("n", "<leader>rn", function() require("geode.results").next_page() end, opts) vim.keymap.set("n", "<leader>rp", function() require("geode.results").prev_page() end, opts) -- View modes vim.keymap.set("n", "<leader>rt", function() require("geode.results").show_as_table() end, opts) vim.keymap.set("n", "<leader>rj", function() require("geode.results").show_as_json() end, opts) -- Connection management vim.keymap.set("n", "<leader>cs", function() require("geode").switch_connection() end, opts) vim.keymap.set("n", "<leader>cd", function() require("geode").switch_database() end, opts) </code></pre></div> <h3 id="advanced-configuration" class="position-relative d-flex align-items-center group"> Advanced 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="advanced-configuration" aria-haspopup="dialog" aria-label="Share link: Advanced Configuration"> Share link </button> </h3> <h4 id="multiple-connections" class="position-relative d-flex align-items-center group"> Multiple 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="multiple-connections" aria-haspopup="dialog" aria-label="Share link: Multiple Connections"> Share link </button> </h4>Configure multiple database connections: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-lua" data-lang="lua">require("geode").setup({ connections = { development = { host = "localhost", port = 3141, database = "dev", default = true, }, staging = { host = "staging.example.com", port = 3141, database = "staging", tls = true, }, production = { host = "prod.example.com", port = 3141, database = "production", tls = true, read_only = true, }, }, }) -- Switch connections vim.keymap.set("n", "<leader>c1", function() require("geode").use_connection("development") end) vim.keymap.set("n", "<leader>c2", function() require("geode").use_connection("staging") end) vim.keymap.set("n", "<leader>c3", function() require("geode").use_connection("production") end) </code></pre></div> <h4 id="custom-status-line" class="position-relative d-flex align-items-center group"> Custom Status Line <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-status-line" aria-haspopup="dialog" aria-label="Share link: Custom Status Line"> Share link </button> </h4>Show Geode connection status in lualine: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-lua" data-lang="lua">require("lualine").setup({ sections = { lualine_x = { { function() local geode = require("geode") if geode.is_connected() then return " " .. geode.current_connection() else return " disconnected" end end, cond = function() return vim.bo.filetype == "gql" end, color = function() local geode = require("geode") if geode.is_connected() then return { fg = "#98c379" } else return { fg = "#e06c75" } end end, }, }, }, }) </code></pre></div> <h4 id="which-key-integration" class="position-relative d-flex align-items-center group"> Which-key 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="which-key-integration" aria-haspopup="dialog" aria-label="Share link: Which-key Integration"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-lua" data-lang="lua">local wk = require("which-key") wk.register({ ["<leader>g"] = { name = "Geode", e = { "<cmd>GeodeExecute<CR>", "Execute Query" }, x = { "<cmd>GeodeExplain<CR>", "Explain Query" }, p = { "<cmd>GeodeProfile<CR>", "Profile Query" }, f = { "<cmd>GeodeFormat<CR>", "Format Query" }, r = { "<cmd>GeodeToggleResults<CR>", "Toggle Results" }, S = { "<cmd>GeodeSchema<CR>", "Schema Explorer" }, c = { "<cmd>GeodeConnect<CR>", "Connect" }, l = { "<cmd>Telescope geode labels<CR>", "Labels" }, R = { "<cmd>Telescope geode relationships<CR>", "Relationships" }, h = { "<cmd>Telescope geode history<CR>", "History" }, }, }, { mode = "n" }) </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-lua" data-lang="lua">-- Check LSP status :LspInfo -- View LSP logs :LspLog -- Manually start LSP :LspStart geode_gql </code></pre></div>No Completions: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-lua" data-lang="lua">-- Verify nvim-cmp sources :lua print(vim.inspect(require("cmp").get_config().sources)) -- Check LSP capabilities :lua print(vim.inspect(vim.lsp.get_active_clients()[1].server_capabilities)) </code></pre></div>Tree-sitter Not Working: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-vim" data-lang="vim">" Check parser status :TSInstallInfo " Reinstall parser :TSInstall gql " Check highlighting :TSHighlightCapturesUnderCursor </code></pre></div>Connection Failed: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-lua" data-lang="lua">-- Test connection manually :lua require("geode").test_connection() -- Check connection settings :lua print(vim.inspect(require("geode").get_config().connection)) -- View connection logs :GeodeConnectionLog </code></pre></div> <h4 id="debug-mode" class="position-relative d-flex align-items-center group"> Debug Mode <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-mode" aria-haspopup="dialog" aria-label="Share link: Debug Mode"> Share link </button> </h4>Enable verbose logging: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-lua" data-lang="lua">require("geode").setup({ debug = true, log_level = "debug", log_file = vim.fn.stdpath("cache") .. "/geode.log", }) -- View logs :edit ~/.cache/nvim/geode.log </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>Use Project-Local Config: Create <code>.geode.lua</code> in project root for project-specific settings. Leverage Telescope: Use Telescope pickers for schema exploration instead of manual queries. Set Up Snippets: Create LuaSnip snippets for frequently used query patterns. Configure Auto-Format: Enable format on save for consistent code style. Use Which-key: Document keybindings with which-key for discoverability. Profile Before Execute: Use EXPLAIN/PROFILE for complex queries before running them. Organize Queries: Keep .gql files in version control for team collaboration. Set Read-Only for Production: Configure production connections as read-only. Use Connection Switching: Set up quick keymaps to switch between environments. Check Diagnostics: Address warnings about unknown labels and properties. <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/vim/" >Vim Plugin</a> - Classic Vim support</li> <li><a href="/tags/vscode/" >VS Code Extension</a> - VS Code 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> </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>Neovim LSP Documentation</li> <li>nvim-lspconfig Configuration Guide</li> <li>Tree-sitter Query Documentation</li> <li>LuaSnip Snippet Guide</li> <li>Telescope Extension Development</li> <li>Neovim Lua API Reference</li> </ul>

Popular

Related Articles

Neovim Plugin