Can VIM autoindent SQL?

Question

"SQL Statement indentation good practice" appears to be the accepted format for writing SQL blocks.

Is there a Vim indent/syntax file that would adhere to this standard, or at least be close?

Currently my Vim left alights pretty much everything and only indents certain keywords.

score 27 · Accepted Answer · edited Jan 05 '22 at 15:31

27

By installing the python module sqlparse, which makes the sqlformat command available in your terminal.

pip install sqlparse

from vim you can use

:%!sqlformat --reindent --keywords upper --identifiers lower -

in order to attach a shortcut ,pt I added following configuration to my .vimrc config file:

autocmd FileType sql call SqlFormatter()
augroup end
function SqlFormatter()
    set noai
    " set mappings...
    map ,pt  :%!sqlformat --reindent --keywords upper --identifiers lower -<CR>
endfunction

You can customize sqlformat a bit. See

sqlformat --help

edited Jan 05 '22 at 15:31

petrus-jvrensburg

1,353
15
19

answered Apr 26 '17 at 13:33

Valerio Crini

1,829
3
13
14

I mapped \f to call _sqlformat_ by adding this one line to my _~/.vimrc_: ```map \f :%!sqlformat --reindent --indent_columns --keywords upper --identifiers lower -``` – petrus-jvrensburg Jan 04 '22 at 13:26
Mind that `autocmd FileType sql call SqlFormatter()` will make this work only in a sql file. If you want it to be called at the start of any file so that the shortcut is always available, use `nnoremap call SqlFormatter()` instead. This might be interesting if you have SQL strings embedded in another language. Since sqlformat works on a whole file, you need to use another formatter, see [Is there a way to let sqlformat change only a selection within a file in VIM?](https://vi.stackexchange.com/questions/36643/is-there-a-way-to-let-sqlformat-or-another-sql-formatter-change-only-a-selection). – questionto42 Jan 28 '22 at 11:13

score 11 · Answer 2 · edited Apr 20 '17 at 00:41

11

"SQLUtilities : SQL utilities - Formatting, generate - columns lists, procedures for databases" has the SQL Utilities plugin, which is capable. And "How to auto-format and auto-capitalize SQL in Vim" is a related discussion.

edited Apr 20 '17 at 00:41

the Tin Man

158,662
42
215
303

answered Dec 20 '11 at 15:27

Zsolt Botykai

50,406
14
85
110

score 8 · Answer 3 · answered Aug 19 '19 at 04:30

8

If you use coc.nvim then you can add the coc-sql extension.

answered Aug 19 '19 at 04:30

Dzamo Norton

1,194
11
17

3

This was the solution I went with... `:CocCommand` takes you to a fuzzy finder - Type in `sql.Format` and you're golden. – Kevin Friedheim Nov 21 '19 at 21:21

score 6 · Answer 4 · answered Jul 07 '17 at 15:13

You can use the vim-autoformat plugin:

Install vim-autoformat with your favourite plugin-manager (I prefer lightweight vim-plug)
Install sqlparse with pip
Add the following lines to your vim/nvim config

noremap <F3> :Autoformat<CR>
let g:formatdef_sql = '"sqlformat --reindent --keywords upper - identifiers lower -"'
let g:formatters_sql = ['sql']

If you see this message: vim has no support for python, you should rebuild your vim with python support or install python-client for neovim

Vim-autoformat now has support for sqlformat by default. – chtenb Aug 07 '18 at 09:39 — chtenb, Aug 07 '18 at 09:39

score 3 · Answer 5 · answered Jun 24 '22 at 10:15

Like Valerio's answer, I recommend using sqlformat albiet with Vim's builtin formatprg, which is gq by default.

setlocal formatprg=sqlformat\ --reindent\ --keywords\ upper\ --identifiers\ lower\ -

I have the line above under my ~/.vim/after/ftplugin/sql.vim file.

This allows you to use Vim's builtin gq against any selection, or against known Vim's objects within sql, or simply gggqG to reindent the entire buffer.

Can VIM autoindent SQL?

5 Answers5

Linked