Watch
1
0
Fork
You've already forked vim-dadbod
0
mirror of https://github.com/tpope/vim-dadbod.git synced 2026-11-17 02:11:42 +00:00
dadbod.vim: Modern database interface for Vim
  • Vim Script 100%
Find a file
Repository files (latest commit first)
Filename Latest commit message Latest commit date
2026-01-06 19:18:27 -05:00
.github Add sponsor button 2019-11-12 18:45:12 -05:00
autoload Always URL encode "$" 2026-01-06 19:18:27 -05:00
doc Clean up Redis contribution 2025-05-11 14:58:09 -04:00
plugin Add support for tls redis (rediss) 2025-05-11 14:56:45 -04:00
.gitattributes Add .gitattributes 2018-04-25 00:08:54 -04:00
.gitignore Ignore generated doc tags 2018-05-22 13:55:51 -04:00
CONTRIBUTING.markdown db.vim 1.0 2018-03-08 00:23:52 -05:00
README.markdown Add Snowflake support (#174) 2024-10-18 19:26:31 -04:00

dadbod.vim

Dadbod is a Vim plugin for interacting with databases. It's a more modern take on dbext.vim, improving on it on the following ways:

  • Connections are specified with a single URL, rather than prompting you for 14 separate variables
  • All interaction is through invoking :DB, not 53 different commands and 35 different maps (omitting many of the more esoteric features, of course)
  • Supports a modern array of backends, including NoSQL databases:
    • Big Query
    • ClickHouse
    • DuckDB
    • Impala
    • jq
    • MongoDB
    • MySQL
    • MariaDB
    • Oracle
    • osquery
    • PostgreSQL
    • Presto
    • Redis
    • Snowflake
    • SQL Server
    • SQLite
    • Your own easily implemented adapter
  • Easily configurable based on a project directory (as seen in rails.vim, for example), rather than just globally or in a per-file modeline
  • For those that just can't live without some piece of dbext functionality, the option g:dadbod_manage_dbext is provided to force dbext to use Dadbod's default database.

Usage

The :DB command has a few different usages. All forms accept a URL as the first parameter, which can be omitted if a default is configured or provided by a plugin.

Omit further arguments to spawn an interactive console (like psql or redis-cli).

:DB postgresql:///foobar
:DB redis:

If additional arguments are provided, they are interpreted as a query string to pass to the database. Results are displayed in a preview window.

:DB sqlite:myfile.sqlite3 select count(*) from widgets
:DB redis:/// CLIENT LIST

Give a range to run part or all of the current buffer as a query.

:%DB mysql://root@localhost/bazquux

Use < to pass in a filename.

:DB mongodb:///test < big_query.js

There's also a special assignment syntax for saving a URL to a Vim variable for later use.

:DB g:prod = postgres://user:pass@db.example.com/production_database
:DB g:prod drop table users

A few additional URL like formats are accepted for interop:

  • :DB jdbc:sqlserver://...
  • :DB dbext:profile=profile_name
  • :DB dbext:type=PGSQL:host=...
  • :DB $DATABASE_URL (with optional dotenv.vim support)

Plugins can provide their own URL handlers as well. For example, heroku.vim provides support for heroku:appname style URLs.

If you want to manage multiple connections at once through UI, try dadbod-ui.

Installation

Install using your favorite package manager, or use Vim's built-in package support:

mkdir -p ~/.vim/pack/tpope/start
cd ~/.vim/pack/tpope/start
git clone https://tpope.io/vim/dadbod.git
vim -u NONE -c "helptags dadbod/doc" -c q

Promotion

Like dadbod.vim? Star the repository on GitHub and vote for it on vim.org.

Love dadbod.vim? Follow tpope on GitHub and Twitter.

License

Copyright © Tim Pope. Distributed under the same terms as Vim itself. See :help license.