🐱 sqmeow.nvim

Query your database from your favorite editor — fast, keyboard-driven, and Rust-powered.

Features • Databases • Installation • Quick Start • Configuration • Contributing

✨ Features

• ⚡ Rust engine — queries run off the editor thread with paged results; large results never freeze Neovim.
• 🐘 Multiple connections — keep several databases open at once.
• 🌲 Schema drawer — browse schemas, tables, views, routines and columns with types and keys.
• 📄 Scratchpads — persistent query buffers; press u on a connection to make it active.
• ✏️ In-grid editing — edit cells, add or delete rows, review staged changes before applying.
• 🔎 Filter and sort — WHERE / ORDER BY bar runs on the database (or in-memory for Redis/ScyllaDB/SurrealDB).
• ▶️ Flexible execution — run the statement under the cursor, a visual selection, or the whole buffer.
• 🧭 EXPLAIN — query plans and errors render in the result window.
• 🕘 Query log — reopen any past result, even after restart.
• 📤 Export — to CSV, JSON or SQL INSERT (single or batched, with optional CREATE TABLE) — to file or clipboard.
• 🔐 Secrets — passwords are masked; URLs can read {{ env "VAR" }}, {{ exec "cmd" }} or {{ file "path" }}.
• ⌨️ Buffer-local keymaps — no global mappings; <Plug> for everything worth a global key.

🗄️ Supported Databases

👀 Preview

✏️ In-grid editing

🔍 Table structure

🚀 Installation

Requirements: Neovim 0.10+ and nui.nvim.

With lazy.nvim:

{
  "2giosangmitom/sqmeow.nvim",
  dependencies = { "MunifTanjim/nui.nvim" },
  version = "*",
  build = function()
    -- Downloads the matching release binary; pass 'curl', 'wget', 'powershell' or 'cargo' to choose.
    require("sqmeow").install()
  end,
  opts = {},
  cmd = "Sqmeow",
  keys = {
    { "<leader>Dd", "<cmd>Sqmeow toggle<cr>", desc = "Toggle" },
    { "<leader>Dc", "<cmd>Sqmeow cancel<cr>", desc = "Cancel" },
    { "<leader>Da", "<cmd>Sqmeow add<cr>", desc = "Add Connection" },
    { "<leader>Ds", "<cmd>Sqmeow scratch<cr>", desc = "New Scratchpad" },
  },
}

[!NOTE] To track master, remove version and build with install('cargo') (needs Rust toolchain + DuckDB). Run :checkhealth sqmeow to verify.

⚡ Quick Start

1. :Sqmeow opens the drawer and result window.
2. A in the drawer (or :Sqmeow add) adds a connection.
3. <CR> on a connection connects; a creates a scratchpad; u makes it active.
4. Write a query and press <CR> to run the statement under cursor (or a visual selection).

[!TIP] Press ? in the drawer or result window to list its keymaps. See :h sqmeow-keymaps for the full reference.

Dialect Notes

• SQL — <CR> runs statement under cursor; <leader>E runs whole buffer.
• Redis — one command per line, e.g. GET key. Drawer lists keys by type. Cluster: redis+cluster://host:7000,host:7001. Sentinel: redis+sentinel://host:26379,host:26380/mymaster/0.
• MongoDB — database commands as Extended JSON, e.g. {"find": "users"}. use db_name switches database.
• ScyllaDB — ?ssl=true for TLS, ?sslrootcert=/path/ca.pem for custom CA.
• SurrealDB — surrealdb://user:pass@host:8000/namespace/database; leave out the database to list every one in the namespace. surrealdbs:// for TLS, ?auth=namespace or ?auth=database for a non-root user, ?sslrootcert=/path/ca.pem for custom CA. USE DB name switches database. Scratchpads ending in .surql get the surql filetype.

SSH Tunnels

Fill SSH in the connection dialog or add "ssh": "user@bastion" (or user@bastion:2222) to a saved connection. Uses your own ssh, so keys, agent and ~/.ssh/config all apply, and the URL host is resolved from the bastion.

Environment Connections

Define connections in SQMEOW_CONNECTIONS:

export SQMEOW_CONNECTIONS='[{"name": "dev", "url": "postgres://app:{{ env \"PGPASSWORD\" }}@localhost/dev"}]'

Safety

• Tick Read only in the dialog or add "read_only": true to a connection (or connections.json) to allow only reads. PostgreSQL, MySQL, ClickHouse, SQLite and DuckDB enforce it in the database session (a server that speaks the PostgreSQL protocol without read-only sessions falls back to the check below, with a warning); Redis, MongoDB, ScyllaDB and SurrealDB only check commands against a list of reads, so use a read-only database user where it matters.
• Before DELETE/UPDATE without WHERE, DROP, TRUNCATE, or emptying a Redis/MongoDB database, sqmeow asks first. Set query.confirm_destructive = false to disable.

⌨️ Commands

🗺️ Keymaps

Drawer

Result Window

Filter Bar

gf/go open a bar above the grid with WHERE and ORDER BY. The query reruns as a subquery; = adds cell value to WHERE, s fills ORDER BY. MongoDB takes filter/sort documents; Redis/ScyllaDB/SurrealDB and closed connections filter in-memory with AND/OR/NOT, IS NULL, LIKE/ILIKE, IN, BETWEEN.

Editing Results

A column is editable when it is a plain table column and its table's whole primary (or unique) key is in the result. Joined rows update each table by its own key; deleted row removes from first editable column's table; rows only addable to single-table results.

Scratchpad

⚙️ Configuration

setup() is optional. Defaults:

require('sqmeow').setup({
  sources = { { type = 'file' }, { type = 'env' } }, -- where connections are loaded from
  core = {
    path = vim.fs.joinpath(vim.fn.stdpath('data'), 'sqmeow'), -- engine, connections, scratchpads, log
    log_level = 'warn',
  },
  ui = {
    drawer = { width = 36 },
    result = { height = 16, page_size = 100, max_column_width = 48, column_icons = true, null_text = 'NULL' },
    border = 'default', -- 'default' follows 'winborder'; or a nui style such as 'rounded'
    winbar = true,
    persist_session = false, -- reopen last session's connections and drawer nodes
  },
  query = {
    max_rows = 100000,
    timeout_ms = 0, -- 0 disables timeout
    history_size = 32, -- results kept in memory
    persist_history = true, -- save log and results to disk
    history_limit = 500,
    confirm_destructive = true, -- ask before destructive statements
  },
  icons = {}, -- Nerd Font glyphs; recolour via SqmeowIcon* highlight groups
  keymaps = {},
  redact_urls = true, -- mask passwords wherever a URL is shown
})

See :h sqmeow-config for every option.

🤝 Contributing

Toolchain is pinned with mise and tasks are just recipes:

mise install   # rust, just, stylua, selene, lua-language-server
just db-up     # start test databases in Docker
just           # lint, test and check help file, as CI does
just docs      # regenerate doc/sqmeow.txt

Commit messages follow Conventional Commits.

📜 License

MIT. Thanks to all contributors 💛

🎖️ Acknowledgments

Inspired by vim-dadbod, vim-dadbod-ui, and nvim-dbee.