Awesome
vim-dadbod-ui
Simple UI for vim-dadbod. It allows simple navigation through databases and allows saving queries for later use.
With nerd fonts:
Video presentation by TJ:
Tested on Linux, Mac and Windows, Vim 8.1+ and Neovim.
Features:
- Navigate through multiple databases and it's tables and schemas
- Several ways to define your connections
- Save queries on single location for later use
- Define custom table helpers
- Bind parameters (see
:help vim-dadbod-ui-bind-parameters
) - Autocompletion with vim-dadbod-completion
- Jump to foreign keys from the dadbod output (see
:help <Plug>(DBUI_JumpToForeignKey)
) - Support for nerd fonts (see
:help g:db_ui_use_nerd_fonts
) - Async query execution
Installation
Configuration with lazy.nvim
return {
'kristijanhusak/vim-dadbod-ui',
dependencies = {
{ 'tpope/vim-dadbod', lazy = true },
{ 'kristijanhusak/vim-dadbod-completion', ft = { 'sql', 'mysql', 'plsql' }, lazy = true }, -- Optional
},
cmd = {
'DBUI',
'DBUIToggle',
'DBUIAddConnection',
'DBUIFindBuffer',
},
init = function()
-- Your DBUI configuration
vim.g.db_ui_use_nerd_fonts = 1
end,
}
Or vim-plug
Plug 'tpope/vim-dadbod'
Plug 'kristijanhusak/vim-dadbod-ui'
Plug 'kristijanhusak/vim-dadbod-completion' "Optional
After installation, run :DBUI
, which should open up a drawer with all databases provided.
When you finish writing your query, just write the file (:w
) and it will automatically execute the query for that database.
Databases
There are 3 ways to provide database connections to UI:
Through environment variables
If $DBUI_URL
env variable exists, it will be added as a connection. Name for the connection will be parsed from the url.
If you want to use a custom name, pass $DBUI_NAME
alongside the url.
Env variables that will be read can be customized like this:
let g:db_ui_env_variable_url = 'DATABASE_URL'
let g:db_ui_env_variable_name = 'DATABASE_NAME'
Optionally you can leverage dotenv.vim
to specific any number of connections in an .env
file by using a specific
prefix (defaults to DB_UI_
). The latter part of the env variable becomes the
name of the connection (lowercased)
# .env
DB_UI_DEV=... # becomes the `dev` connection
DB_UI_PRODUCTION=... # becomes the `production` connection
The prefix can be customized like this:
let g:db_ui_dotenv_variable_prefix = 'MYPREFIX_'
Via g:dbs global variable
Provide list with all databases that you want to use through g:dbs
variable as an array of objects or an object:
function s:resolve_production_url()
let url = system('get-prod-url')
return url
end
let g:dbs = {
\ 'dev': 'postgres://postgres:mypassword@localhost:5432/my-dev-db',
\ 'staging': 'postgres://postgres:mypassword@localhost:5432/my-staging-db',
\ 'wp': 'mysql://root@localhost/wp_awesome',
\ 'production': function('s:resolve_production_url')
\ }
Or if you want them to be sorted in the order you define them, this way is also available:
function s:resolve_production_url()
let url = system('get-prod-url')
return url
end
let g:dbs = [
\ { 'name': 'dev', 'url': 'postgres://postgres:mypassword@localhost:5432/my-dev-db' }
\ { 'name': 'staging', 'url': 'postgres://postgres:mypassword@localhost:5432/my-staging-db' },
\ { 'name': 'wp', 'url': 'mysql://root@localhost/wp_awesome' },
\ { 'name': 'production', 'url': function('s:resolve_production_url') },
\ ]
In case you use Neovim, here's an example with Lua:
vim.g.dbs = {
{ name = 'dev', url = 'postgres://postgres:mypassword@localhost:5432/my-dev-db' },
{ name = 'staging', url = 'postgres://postgres:mypassword@localhost:5432/my-staging-db' },
{ name = 'wp', url = 'mysql://root@localhost/wp_awesome' },
{
name = 'production',
url = function()
return vim.fn.system('get-prod-url')
end
},
}
Just make sure to NOT COMMIT these. I suggest using project local vim config (:help exrc
)
Via :DBUIAddConnection command
Using :DBUIAddConnection
command or pressing A
in dbui drawer opens up a prompt to enter database url and name,
that will be saved in g:db_ui_save_location
connections file. These connections are available from everywhere.
Connection related notes
It is possible to have two connections with same name, but from different source.
for example, you can have my-db
in env variable, in g:dbs
and in saved connections.
To view from which source the database is, press H
in drawer.
If there are duplicate connection names from same source, warning will be shown and first one added will be preserved.
Settings
An overview of all settings and their default values can be found at :help vim-dadbod-ui
.
Table helpers
Table helper is a predefined query that is available for each table in the list.
Currently, default helper that each scheme has for it's tables is List
, which for most schemes defaults to g:db_ui_default_query
.
Postgres, Mysql and Sqlite has some additional helpers defined, like "Indexes", "Foreign Keys", "Primary Keys".
Predefined query can inject current db name and table name via {table}
and {dbname}
.
To add your own for a specific scheme, provide it through .g:db_ui_table_helpers
.
For example, to add a "count rows" helper for postgres, you would add this as a config:
let g:db_ui_table_helpers = {
\ 'postgresql': {
\ 'Count': 'select count(*) from "{table}"'
\ }
\ }
Or if you want to override any of the defaults, provide the same name as part of config:
let g:db_ui_table_helpers = {
\ 'postgresql': {
\ 'List': 'select * from "{table}" order by id asc'
\ }
\ }
Auto execute query
If this is set to 1
, opening any of the table helpers will also automatically execute the query.
Default value is: 0
To enable it, add this to vimrc:
let g:db_ui_auto_execute_table_helpers = 1
Icons
These are the default icons used:
let g:db_ui_icons = {
\ 'expanded': '▾',
\ 'collapsed': '▸',
\ 'saved_query': '*',
\ 'new_query': '+',
\ 'tables': '~',
\ 'buffers': '»',
\ 'connection_ok': '✓',
\ 'connection_error': '✕',
\ }
You can override any of these:
let g:db_ui_icons = {
\ 'expanded': '+',
\ 'collapsed': '-',
\ }
Help text
To hide Press ? for help
add this to vimrc:
let g:db_ui_show_help = 0
Pressing ?
will show/hide help no matter if this option is set or not.
Drawer width
What should be the drawer width when opened. Default is 40
.
let g:db_ui_winwidth = 30
Default query
DEPRECATED: Use Table helpers instead.
When opening up a table, buffer will be prepopulated with some basic select, which defaults to:
select * from table LIMIT 200;
To change the default value, use g:db_ui_default_query
, where {table}
is placeholder for table name.
let g:db_ui_default_query = 'select * from "{table}" limit 10'
Save location
All queries are by default written to tmp folder. There's a mapping to save them permanently for later to the specific location.
That location is by default ~/.local/share/db_ui
. To change it, addd g:db_ui_save_location
to your vimrc.
let g:db_ui_save_location = '~/Dropbox/db_ui_queries'
Mappings
These are the default mappings for dbui
drawer:
- o / <CR> - Open/Toggle Drawer options (
<Plug>(DBUI_SelectLine)
) - S - Open in vertical split (
<Plug>(DBUI_SelectLineVsplit)
) - d - Delete buffer or saved sql (
<Plug>(DBUI_DeleteLine)
) - R - Redraw (
<Plug>(DBUI_Redraw)
) - A - Add connection (
<Plug>(DBUI_AddConnection)
) - H - Toggle database details (
<Plug>(DBUI_ToggleDetails)
)
For queries, filetype is automatically set to sql
. Also, two mappings is added for the sql
filetype:
- <Leader>W - Permanently save query for later use (
<Plug>(DBUI_SaveQuery)
) - <Leader>E - Edit bind parameters (
<Plug>(DBUI_EditBindParameters)
)
Any of these mappings can be overridden:
autocmd FileType dbui nmap <buffer> v <Plug>(DBUI_SelectLineVsplit)
If you don't want mappings to be added, add this to vimrc:
let g:db_ui_disable_mappings = 1 " Disable all mappings
let g:db_ui_disable_mappings_dbui = 1 " Disable mappings in DBUI drawer
let g:db_ui_disable_mappings_dbout = 1 " Disable mappings in DB output
let g:db_ui_disable_mappings_sql = 1 " Disable mappings in SQL buffers
let g:db_ui_disable_mappings_javascript = 1 " Disable mappings in Javascript buffers (for Mongodb)
Toggle showing postgres views in the drawer
If you don't want to see any views in the drawer, add this to vimrc: This option must be disabled (set to 0) for Redshift.
let g:db_ui_use_postgres_views = 0
Disable builtin progress bar
If you want to utilize *DBExecutePre or *DBExecutePost to make your own progress bar or if you want to disable the progress entirely set to 1.
let g:db_ui_disable_progress_bar = 1
TODO
- Test with more db types