Vim Plugin for Geode GQL

Vim remains one of the most powerful and efficient text editors, favored by developers who value modal editing, extensive customization, and terminal-based workflows. The Geode GQL plugin for Vim brings comprehensive graph database development support including syntax highlighting, intelligent omni-completion, query execution, linting integration, and seamless workflow tools. While Neovim users may prefer the native LSP integration, classic Vim users can achieve excellent GQL development experiences through the Geode Vim plugin, which provides syntax files, filetype detection, omnicompletion via external tools, ALE linter integration, and convenient commands for query execution. This guide covers installation, configuration, features, key mappings, integration with popular Vim plugins, and best practices for productive GQL development in Vim. <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"># Vim 8.0+ required (or Vim 7.4 with patches) vim --version | head -1 # Geode CLI must be in PATH which geode geode --version # Optional: ctags for tag generation which ctags </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>The most popular Vim plugin manager: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-vim" data-lang="vim">" ~/.vimrc call plug#begin('~/.vim/plugged') " Geode GQL plugin Plug 'geodedb/vim-geode-gql' " Recommended companion plugins Plug 'dense-analysis/ale' " Async linting Plug 'prabirshrestha/vim-lsp' " LSP support (optional) Plug 'prabirshrestha/asyncomplete.vim' " Async completion call plug#end() </code></pre></div>Install plugins: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-vim" data-lang="vim">:PlugInstall </code></pre></div> <h4 id="using-vundle" class="position-relative d-flex align-items-center group"> Using Vundle <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-vundle" aria-haspopup="dialog" aria-label="Share link: Using Vundle"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-vim" data-lang="vim">" ~/.vimrc set nocompatible filetype off set rtp+=~/.vim/bundle/Vundle.vim call vundle#begin() Plugin 'VundleVim/Vundle.vim' Plugin 'geodedb/vim-geode-gql' Plugin 'dense-analysis/ale' call vundle#end() filetype plugin indent on </code></pre></div>Install: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-vim" data-lang="vim">:PluginInstall </code></pre></div> <h4 id="using-pathogen" class="position-relative d-flex align-items-center group"> Using Pathogen <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-pathogen" aria-haspopup="dialog" aria-label="Share link: Using Pathogen"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash"># Clone to bundle directory cd ~/.vim/bundle git clone https://github.com/geodedb/vim-geode-gql.git </code></pre></div> <h4 id="using-native-vim-packages-vim-8" class="position-relative d-flex align-items-center group"> Using Native Vim Packages (Vim 8+) <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-native-vim-packages-vim-8" aria-haspopup="dialog" aria-label="Share link: Using Native Vim Packages (Vim 8&#43;)"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash"># Create pack directory mkdir -p ~/.vim/pack/geode/start # Clone plugin git clone https://github.com/geodedb/vim-geode-gql.git \ ~/.vim/pack/geode/start/vim-geode-gql </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"># Download and extract curl -LO https://github.com/geodedb/vim-geode-gql/archive/main.tar.gz tar xzf main.tar.gz # Copy files cp -r vim-geode-gql-main/syntax/* ~/.vim/syntax/ cp -r vim-geode-gql-main/ftplugin/* ~/.vim/ftplugin/ cp -r vim-geode-gql-main/ftdetect/* ~/.vim/ftdetect/ cp -r vim-geode-gql-main/autoload/* ~/.vim/autoload/ cp -r vim-geode-gql-main/plugin/* ~/.vim/plugin/ </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>Add to your <code>.vimrc</code>: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-vim" data-lang="vim">" ~/.vimrc " Enable file type detection and plugins filetype plugin indent on syntax on " Geode GQL configuration let g:geode_server_host = 'localhost' let g:geode_server_port = 3141 let g:geode_default_database = 'default' let g:geode_auto_connect = 1 " Query execution settings let g:geode_execution_timeout = 30000 let g:geode_max_rows = 1000 let g:geode_auto_commit = 0 " Formatting settings let g:geode_format_on_save = 1 let g:geode_keyword_case = 'UPPER' let g:geode_indent_size = 2 " Results display let g:geode_results_position = 'bottom' " bottom, right, tab let g:geode_results_height = 15 let g:geode_results_width = 80 " UI options let g:geode_show_line_numbers = 1 let g:geode_highlight_current_row = 1 </code></pre></div> <h4 id="gql-file-settings" class="position-relative d-flex align-items-center group"> GQL File 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="gql-file-settings" aria-haspopup="dialog" aria-label="Share link: GQL File Settings"> Share link </button> </h4>Create filetype-specific settings: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-vim" data-lang="vim">" ~/.vim/ftplugin/gql.vim " Indentation setlocal tabstop=2 setlocal shiftwidth=2 setlocal softtabstop=2 setlocal expandtab setlocal smartindent " Text width for formatting setlocal textwidth=100 " Enable omni-completion setlocal omnifunc=geode#Complete " Folding (fold on query boundaries) setlocal foldmethod=syntax setlocal foldlevel=99 " Comments setlocal commentstring=--\ %s " Key mappings (buffer local) nnoremap <buffer> <leader>ge :GeodeExecute<CR> nnoremap <buffer> <leader>gx :GeodeExplain<CR> nnoremap <buffer> <leader>gp :GeodeProfile<CR> nnoremap <buffer> <leader>gf :GeodeFormat<CR> nnoremap <buffer> <leader>gc :GeodeConnect<CR> nnoremap <buffer> <leader>gr :GeodeToggleResults<CR> vnoremap <buffer> <leader>ge :GeodeExecuteSelection<CR> " Execute with Ctrl+Enter nnoremap <buffer> <C-CR> :GeodeExecute<CR> inoremap <buffer> <C-CR> <Esc>:GeodeExecute<CR> vnoremap <buffer> <C-CR> :GeodeExecuteSelection<CR> </code></pre></div> <h4 id="connection-profiles" class="position-relative d-flex align-items-center group"> Connection Profiles <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="connection-profiles" aria-haspopup="dialog" aria-label="Share link: Connection Profiles"> Share link </button> </h4>Define multiple connection profiles: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-vim" data-lang="vim">" ~/.vimrc " Connection profiles let g:geode_connections = { \ 'development': { \ 'host': 'localhost', \ 'port': 3141, \ 'database': 'dev', \ }, \ 'staging': { \ 'host': 'staging.example.com', \ 'port': 3141, \ 'database': 'staging', \ 'tls': 1, \ }, \ 'production': { \ 'host': 'prod.example.com', \ 'port': 3141, \ 'database': 'production', \ 'tls': 1, \ 'read_only': 1, \ }, \ } " Default connection let g:geode_default_connection = 'development' " Quick connection switching nnoremap <leader>c1 :GeodeUseConnection development<CR> nnoremap <leader>c2 :GeodeUseConnection staging<CR> nnoremap <leader>c3 :GeodeUseConnection production<CR> </code></pre></div> <h3 id="features" class="position-relative d-flex align-items-center group"> Features <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="features" aria-haspopup="dialog" aria-label="Share link: Features"> Share link </button> </h3> <h4 id="syntax-highlighting" class="position-relative d-flex align-items-center group"> Syntax Highlighting <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="syntax-highlighting" aria-haspopup="dialog" aria-label="Share link: Syntax Highlighting"> Share link </button> </h4>The plugin provides comprehensive syntax highlighting: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-vim" data-lang="vim">" ~/.vim/syntax/gql.vim (excerpt) " Keywords syntax keyword gqlKeyword MATCH WHERE RETURN CREATE DELETE MERGE SET REMOVE syntax keyword gqlKeyword WITH UNWIND CALL YIELD ORDER BY SKIP LIMIT syntax keyword gqlKeyword AND OR NOT IN IS NULL TRUE FALSE syntax keyword gqlKeyword CASE WHEN THEN ELSE END syntax keyword gqlKeyword OPTIONAL DISTINCT AS syntax keyword gqlKeyword BEGIN COMMIT ROLLBACK TRANSACTION " Functions syntax keyword gqlFunction COUNT SUM AVG MIN MAX syntax keyword gqlFunction COLLECT REDUCE syntax keyword gqlFunction UPPER LOWER TRIM SUBSTRING REPLACE syntax keyword gqlFunction SIZE LENGTH TYPE ID LABELS PROPERTIES syntax keyword gqlFunction COALESCE NULLIF syntax keyword gqlFunction DATE DATETIME TIME DURATION " Types syntax keyword gqlType Integer Float String Boolean Date DateTime Duration syntax keyword gqlType Point List Map Node Relationship Path " Labels (:Label) syntax match gqlLabel ":\w\+" " Properties (.property) syntax match gqlProperty "\.\w\+" " Variables syntax match gqlVariable "\$\w\+" " Strings syntax region gqlString start=/"/ skip=/\\"/ end=/"/ syntax region gqlString start=/'/ skip=/\\'/ end=/'/ " Comments syntax match gqlComment "--.*$" syntax region gqlComment start="/\*" end="\*/" " Numbers syntax match gqlNumber "\<\d\+\>" syntax match gqlNumber "\<\d\+\.\d\+\>" " Highlighting groups highlight link gqlKeyword Keyword highlight link gqlFunction Function highlight link gqlType Type highlight link gqlLabel Structure highlight link gqlProperty Identifier highlight link gqlVariable Special highlight link gqlString String highlight link gqlComment Comment highlight link gqlNumber Number </code></pre></div> <h4 id="omni-completion" class="position-relative d-flex align-items-center group"> Omni-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="omni-completion" aria-haspopup="dialog" aria-label="Share link: Omni-Completion"> Share link </button> </h4>Intelligent completion via <code><C-x><C-o></code>: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-vim" data-lang="vim">" Completion function in autoload/geode.vim function! geode#Complete(findstart, base) if a:findstart " Find start of word let line = getline('.') let start = col('.') - 1 while start > 0 && line[start - 1] =~ '\w' let start -= 1 endwhile return start else " Get completions from LSP or cache let completions = [] " Context-aware completions let context = geode#GetContext() if context.after_colon " Complete labels let completions = geode#GetLabels(a:base) elseif context.after_dot " Complete properties let completions = geode#GetProperties(context.label, a:base) elseif context.after_bracket " Complete relationship types let completions = geode#GetRelationships(a:base) else " Complete keywords and functions let completions = geode#GetKeywordsAndFunctions(a:base) endif return completions endif endfunction </code></pre></div>Using Completion: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-vim" data-lang="vim">" In insert mode: " <C-x><C-o> - Trigger omni-completion " <C-n> - Next completion item " <C-p> - Previous completion item " <C-y> - Accept completion " <C-e> - Cancel completion </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 Vim: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-vim" data-lang="vim">" Execute entire buffer :GeodeExecute " Execute current query (query under cursor) :GeodeExecuteCurrent " Execute visual selection :'<,'>GeodeExecuteSelection " Execute with EXPLAIN :GeodeExplain " Execute with PROFILE :GeodeProfile " Cancel running query :GeodeCancel </code></pre></div>Results Window: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-fallback" data-lang="fallback">┌─ Geode Results ──────────────────────────────────────────┐ │ Query: MATCH (u:User) WHERE u.active = true RETURN u... │ │ Status: Success | Time: 12ms | Rows: 3 │ ├──────────────────────────────────────────────────────────┤ │ 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 │ ├──────────────────────────────────────────────────────────┤ │ [j/k] navigate | [y] yank row | [Y] yank all | [q] close │ └──────────────────────────────────────────────────────────┘ </code></pre></div>Results Window Keys: <table> <thead> <tr> <th>Key</th> <th>Action</th> </tr> </thead> <tbody> <tr> <td><code>j</code> / <code>k</code></td> <td>Navigate rows</td> </tr> <tr> <td><code>h</code> / <code>l</code></td> <td>Scroll horizontally</td> </tr> <tr> <td><code>gg</code> / <code>G</code></td> <td>Go to first/last row</td> </tr> <tr> <td><code>y</code></td> <td>Yank current row</td> </tr> <tr> <td><code>Y</code></td> <td>Yank all results</td> </tr> <tr> <td><code>/</code></td> <td>Search results</td> </tr> <tr> <td><code>n</code> / <code>N</code></td> <td>Next/previous search match</td> </tr> <tr> <td><code>q</code></td> <td>Close results window</td> </tr> <tr> <td><code><CR></code></td> <td>Expand row details</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 GQL queries for consistency: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-vim" data-lang="vim">" Format entire buffer :GeodeFormat " Format visual selection :'<,'>GeodeFormatSelection " Format on save (if enabled) autocmd BufWritePre *.gql :GeodeFormat </code></pre></div>Before/After Formatting: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">" Before match(u:User)-[:FOLLOWS]->(f) where u.active=true and u.created>'2024-01-01' return f.name,count(*) as cnt group by f.name order by cnt desc limit 10; " After MATCH (u:User)-[:FOLLOWS]->(f) WHERE u.active = true AND u.created > '2024-01-01' RETURN f.name, COUNT(*) AS cnt GROUP BY f.name ORDER BY cnt DESC LIMIT 10; </code></pre></div> <h4 id="ale-integration" class="position-relative d-flex align-items-center group"> ALE 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="ale-integration" aria-haspopup="dialog" aria-label="Share link: ALE Integration"> Share link </button> </h4>Integrate with ALE for asynchronous linting: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-vim" data-lang="vim">" ~/.vimrc " Enable ALE for GQL let g:ale_linters = { \ 'gql': ['geode'], \ } " ALE Geode linter settings let g:ale_gql_geode_executable = 'geode' let g:ale_gql_geode_options = 'lint --format=ale' " ALE display settings let g:ale_sign_error = '✗' let g:ale_sign_warning = '⚠' let g:ale_echo_msg_error_str = 'E' let g:ale_echo_msg_warning_str = 'W' let g:ale_echo_msg_format = '[%linter%] %s [%severity%]' " Navigate errors nmap <silent> [e <Plug>(ale_previous_wrap) nmap <silent> ]e <Plug>(ale_next_wrap) " Fix on save let g:ale_fix_on_save = 1 let g:ale_fixers = { \ 'gql': ['geode_format'], \ } </code></pre></div>Error Display: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-fallback" data-lang="fallback"> 1 │ MATCH (u:User) 2 │ WHER u.email = '[email protected]' │ ✗ E: Unknown keyword 'WHER'. Did you mean 'WHERE'? 3 │ RETURN u; </code></pre></div> <h4 id="vim-lsp-integration" class="position-relative d-flex align-items-center group"> vim-lsp 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="vim-lsp-integration" aria-haspopup="dialog" aria-label="Share link: vim-lsp Integration"> Share link </button> </h4>For LSP support in classic Vim: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-vim" data-lang="vim">" ~/.vimrc " Register Geode LSP if executable('geode') au User lsp_setup call lsp#register_server({ \ 'name': 'geode-gql', \ 'cmd': {server_info->['geode', 'lsp', '--stdio']}, \ 'allowlist': ['gql'], \ }) endif " LSP keymaps function! s:on_lsp_buffer_enabled() abort setlocal omnifunc=lsp#complete setlocal signcolumn=yes nmap <buffer> gd <plug>(lsp-definition) nmap <buffer> gr <plug>(lsp-references) nmap <buffer> K <plug>(lsp-hover) nmap <buffer> <leader>rn <plug>(lsp-rename) nmap <buffer> [g <plug>(lsp-previous-diagnostic) nmap <buffer> ]g <plug>(lsp-next-diagnostic) endfunction augroup lsp_install au! autocmd User lsp_buffer_enabled call s:on_lsp_buffer_enabled() augroup END </code></pre></div> <h4 id="asyncomplete-integration" class="position-relative d-flex align-items-center group"> asyncomplete 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="asyncomplete-integration" aria-haspopup="dialog" aria-label="Share link: asyncomplete Integration"> Share link </button> </h4>Async completion for better performance: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-vim" data-lang="vim">" ~/.vimrc " Register Geode source au User asyncomplete_setup call asyncomplete#register_source( \ asyncomplete#sources#geode#get_source_options({ \ 'name': 'geode', \ 'allowlist': ['gql'], \ 'completor': function('asyncomplete#sources#geode#completor'), \ })) " Tab completion inoremap <expr> <Tab> pumvisible() ? "\<C-n>" : "\<Tab>" inoremap <expr> <S-Tab> pumvisible() ? "\<C-p>" : "\<S-Tab>" inoremap <expr> <CR> pumvisible() ? "\<C-y>" : "\<CR>" </code></pre></div> <h3 id="key-mappings" class="position-relative d-flex align-items-center group"> Key Mappings <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-mappings" aria-haspopup="dialog" aria-label="Share link: Key Mappings"> Share link </button> </h3> <h4 id="default-mappings" class="position-relative d-flex align-items-center group"> Default Mappings <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-mappings" aria-haspopup="dialog" aria-label="Share link: Default Mappings"> Share link </button> </h4><table> <thead> <tr> <th>Action</th> <th>Mapping</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>ge</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 Buffer</td> <td><code><leader>gf</code></td> <td>n</td> <td>Format entire 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>Connect</td> <td><code><leader>gc</code></td> <td>n</td> <td>Connect to server</td> </tr> <tr> <td>Schema Explorer</td> <td><code><leader>gS</code></td> <td>n</td> <td>Open schema browser</td> </tr> <tr> <td>Next Error</td> <td><code>]e</code></td> <td>n</td> <td>Go to next error</td> </tr> <tr> <td>Prev Error</td> <td><code>[e</code></td> <td>n</td> <td>Go to previous error</td> </tr> </tbody> </table> <h4 id="custom-mappings" class="position-relative d-flex align-items-center group"> Custom Mappings <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-mappings" aria-haspopup="dialog" aria-label="Share link: Custom Mappings"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-vim" data-lang="vim">" ~/.vim/ftplugin/gql.vim " Quick execute with Ctrl+Enter nnoremap <buffer> <C-CR> :GeodeExecute<CR> inoremap <buffer> <C-CR> <Esc>:GeodeExecute<CR>a vnoremap <buffer> <C-CR> :GeodeExecuteSelection<CR> " Execute and stay in insert mode inoremap <buffer> <C-S-CR> <C-o>:GeodeExecute<CR> " Format with = (like other languages) nnoremap <buffer> = :GeodeFormat<CR> " Quick explain nnoremap <buffer> <leader>e :GeodeExplain<CR> " Quick profile nnoremap <buffer> <leader>p :GeodeProfile<CR> " Navigate queries in buffer nnoremap <buffer> [q :GeodePrevQuery<CR> nnoremap <buffer> ]q :GeodeNextQuery<CR> " Copy results to clipboard nnoremap <buffer> <leader>yy :GeodeYankResults<CR> nnoremap <buffer> <leader>yj :GeodeYankResultsJSON<CR> " Insert common patterns inoremap <buffer> <C-g>m MATCH ()<Left> inoremap <buffer> <C-g>w WHERE inoremap <buffer> <C-g>r RETURN inoremap <buffer> <C-g>c CREATE ()<Left> </code></pre></div> <h3 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> </h3> <h4 id="ultisnips-integration" class="position-relative d-flex align-items-center group"> UltiSnips 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="ultisnips-integration" aria-haspopup="dialog" aria-label="Share link: UltiSnips Integration"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-vim" data-lang="vim">" ~/.vim/UltiSnips/gql.snippets # Basic MATCH query snippet match "MATCH query" b MATCH (${1:n}:${2:Label}) WHERE ${3:condition} RETURN ${4:$1}; endsnippet # CREATE node snippet create "CREATE node" b CREATE (${1:n}:${2:Label} { ${3:property}: ${4:value} }); endsnippet # CREATE relationship snippet rel "CREATE relationship" b MATCH (a:${1:Label} {${2:prop}: ${3:value}}) MATCH (b:${4:Label} {${5:prop}: ${6:value}}) CREATE (a)-[:${7:REL_TYPE} {${8:}}]->(b); endsnippet # MERGE pattern snippet merge "MERGE pattern" b MERGE (${1:n}:${2:Label} {${3:id}: ${4:value}}) ON CREATE SET ${5:$1.created_at = datetime()} ON MATCH SET ${6:$1.updated_at = datetime()} RETURN $1; endsnippet # Path query snippet path "Path query" b MATCH path = (${1:start}:${2:Label})-[:${3:REL}*${4:1..3}]->(${5:end}:${6:Label}) WHERE ${7:condition} RETURN path; endsnippet # Aggregation snippet agg "Aggregation query" b MATCH (${1:n}:${2:Label}) WHERE ${3:condition} RETURN ${4:n.property}, ${5:COUNT}(*) AS ${6:count} GROUP BY $4 ORDER BY $6 DESC LIMIT ${7:10}; endsnippet # Transaction block snippet tx "Transaction block" b BEGIN TRANSACTION; ${1:-- Your GQL statements here} COMMIT; endsnippet # CASE expression snippet case "CASE expression" b CASE WHEN ${1:condition} THEN ${2:result} WHEN ${3:condition} THEN ${4:result} ELSE ${5:default} END endsnippet </code></pre></div> <h4 id="snipmate-snippets" class="position-relative d-flex align-items-center group"> SnipMate 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="snipmate-snippets" aria-haspopup="dialog" aria-label="Share link: SnipMate Snippets"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-fallback" data-lang="fallback"># ~/.vim/snippets/gql.snippets snippet match MATCH (${1:n}:${2:Label}) WHERE ${3:condition} RETURN ${4:$1}; snippet create CREATE (${1:n}:${2:Label} { ${3:property}: ${4:value} }); snippet path MATCH path = (${1:start}:${2:Label})-[:${3:REL}*${4:1..3}]->(${5:end}:${6:Label}) RETURN path; </code></pre></div> <h3 id="commands-reference" class="position-relative d-flex align-items-center group"> Commands Reference <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="commands-reference" aria-haspopup="dialog" aria-label="Share link: Commands Reference"> Share link </button> </h3> <h4 id="execution-commands" class="position-relative d-flex align-items-center group"> Execution Commands <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="execution-commands" aria-haspopup="dialog" aria-label="Share link: Execution Commands"> Share link </button> </h4><table> <thead> <tr> <th>Command</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td><code>:GeodeExecute</code></td> <td>Execute query under cursor or entire buffer</td> </tr> <tr> <td><code>:GeodeExecuteSelection</code></td> <td>Execute visual selection</td> </tr> <tr> <td><code>:GeodeExecuteCurrent</code></td> <td>Execute current query only</td> </tr> <tr> <td><code>:GeodeExplain</code></td> <td>Show execution plan</td> </tr> <tr> <td><code>:GeodeProfile</code></td> <td>Execute with profiling</td> </tr> <tr> <td><code>:GeodeCancel</code></td> <td>Cancel running query</td> </tr> </tbody> </table> <h4 id="connection-commands" class="position-relative d-flex align-items-center group"> Connection Commands <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="connection-commands" aria-haspopup="dialog" aria-label="Share link: Connection Commands"> Share link </button> </h4><table> <thead> <tr> <th>Command</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td><code>:GeodeConnect</code></td> <td>Connect to server</td> </tr> <tr> <td><code>:GeodeDisconnect</code></td> <td>Disconnect from server</td> </tr> <tr> <td><code>:GeodeReconnect</code></td> <td>Reconnect to server</td> </tr> <tr> <td><code>:GeodeUseConnection {name}</code></td> <td>Switch to named connection</td> </tr> <tr> <td><code>:GeodeUseDatabase {name}</code></td> <td>Switch database</td> </tr> <tr> <td><code>:GeodeConnectionStatus</code></td> <td>Show connection status</td> </tr> </tbody> </table> <h4 id="formatting-commands" class="position-relative d-flex align-items-center group"> Formatting Commands <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="formatting-commands" aria-haspopup="dialog" aria-label="Share link: Formatting Commands"> Share link </button> </h4><table> <thead> <tr> <th>Command</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td><code>:GeodeFormat</code></td> <td>Format entire buffer</td> </tr> <tr> <td><code>:GeodeFormatSelection</code></td> <td>Format visual selection</td> </tr> <tr> <td><code>:GeodeSetIndent {n}</code></td> <td>Set indent size</td> </tr> <tr> <td><code>:GeodeSetKeywordCase {case}</code></td> <td>Set keyword case (UPPER/lower)</td> </tr> </tbody> </table> <h4 id="schema-commands" class="position-relative d-flex align-items-center group"> Schema Commands <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="schema-commands" aria-haspopup="dialog" aria-label="Share link: Schema Commands"> Share link </button> </h4><table> <thead> <tr> <th>Command</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td><code>:GeodeSchema</code></td> <td>Open schema explorer</td> </tr> <tr> <td><code>:GeodeLabels</code></td> <td>List all labels</td> </tr> <tr> <td><code>:GeodeRelationships</code></td> <td>List relationship types</td> </tr> <tr> <td><code>:GeodeProperties {label}</code></td> <td>List properties for label</td> </tr> <tr> <td><code>:GeodeIndexes</code></td> <td>List all indexes</td> </tr> <tr> <td><code>:GeodeRefreshSchema</code></td> <td>Refresh schema cache</td> </tr> </tbody> </table> <h4 id="results-commands" class="position-relative d-flex align-items-center group"> Results Commands <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="results-commands" aria-haspopup="dialog" aria-label="Share link: Results Commands"> Share link </button> </h4><table> <thead> <tr> <th>Command</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td><code>:GeodeToggleResults</code></td> <td>Toggle results window</td> </tr> <tr> <td><code>:GeodeShowResults</code></td> <td>Show results window</td> </tr> <tr> <td><code>:GeodeHideResults</code></td> <td>Hide results window</td> </tr> <tr> <td><code>:GeodeYankResults</code></td> <td>Copy results to clipboard</td> </tr> <tr> <td><code>:GeodeYankResultsJSON</code></td> <td>Copy results as JSON</td> </tr> <tr> <td><code>:GeodeExportResults {file}</code></td> <td>Export to file</td> </tr> </tbody> </table> <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>Syntax Highlighting Not Working: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-vim" data-lang="vim">" Check filetype detection :set ft? " Should show: filetype=gql " Force filetype :set ft=gql " Check syntax loaded :syntax list </code></pre></div>Completion Not Working: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-vim" data-lang="vim">" Check omnifunc :set omnifunc? " Should show: omnifunc=geode#Complete " Test completion manually :call geode#Complete(0, '') </code></pre></div>Connection Failures: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-vim" data-lang="vim">" Check connection status :GeodeConnectionStatus " Test connection :GeodeTestConnection " View connection log :GeodeConnectionLog </code></pre></div>Plugin Not Loading: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-vim" data-lang="vim">" Check plugin loaded :scriptnames | grep geode " Check for errors :messages " Reload plugin :source ~/.vim/plugged/vim-geode-gql/plugin/geode.vim </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 debug logging: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-vim" data-lang="vim">" Enable debug mode let g:geode_debug = 1 let g:geode_log_file = '/tmp/geode-vim.log' " View debug log :edit /tmp/geode-vim.log " Or tail in terminal :terminal tail -f /tmp/geode-vim.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>Organize Query Files: Keep <code>.gql</code> files in version control for collaboration. Use Connection Profiles: Define profiles for different environments. Enable Format on Save: Ensure consistent code style. Leverage Snippets: Create snippets for common query patterns. Use ALE for Linting: Get real-time feedback on syntax errors. Set Up Key Mappings: Create efficient mappings for frequent operations. Profile Complex Queries: Always profile before running expensive queries. Use Read-Only for Production: Mark production connections as read-only. Check Schema Before Writing: Use schema explorer to verify labels and properties. Document Custom Mappings: Comment your mappings for future reference. <h3 id="related-topics" class="position-relative d-flex align-items-center group"> Related Topics <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="related-topics" aria-haspopup="dialog" aria-label="Share link: Related Topics"> Share link </button> </h3><ul> <li><a href="/tags/editor/" >Editor Integrations</a> - Overview of all editor integrations</li> <li><a href="/tags/neovim/" >Neovim Plugin</a> - Modern Neovim integration with LSP</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>Vim Script Documentation</li> <li>ALE Documentation</li> <li>vim-lsp Configuration Guide</li> <li>UltiSnips Documentation</li> <li>Vim Plugin Development Guide</li> <li>Modal Editing Best Practices</li> </ul>

Popular

Related Articles

Vim Plugin