vim-dadbod-ui configuration for treesitter

Question

I want to know if there is a way to activate the sql tree-sitter while making queries in the vim-dadbod-ui. Currently I only get a different color for keywords, but it is still much different from what you get when opening an actual .sql file, If someone know something related to this topic please let me know.

I tried reading the documentation but there was nothing related that could help me.

Answer 1

I haven't worked with vim-dadbod-ui before, but I've had similar use cases. Treesitter operates by attaching the parser based on file types (as per my understanding). To apply SQL parsing (and highlighting) to these files, you need to inform Treesitter explicitly to do so.

Simplest method first

Requires Neovim >= 0.9.0

1. Confirm the filetype by executing :echo &filetype with the buffer open and focused.
2. Assuming it returns a value, let's denote it as <vim-dadbod-ui-query-filetype> (If not, this approach won't work, move on to the next one).
3. Add the following line to your script:

vim.treesitter.language.register("sql", "<vim-dadbod-ui-query-filetype>")

This is mentioned in the Tree-sitter README.

Neovim should treat it as SQL

If the previous approach did not work, it means you do not have a filetype associated with these files. So, you would have to explicitly assign it a SQL filetype. To do this, we tell Neovim filetype for such files using vim.filetype.add(). Assuming it's a pattern that consistently includes the -query- field and lacks an extension (basically a . after -query-) and we want it to be treated as SQL by Neovim (and Treesitter):

vim.filetype.add({
    pattern = { [".*-query-[^%.]*"] = "sql" },
})

Note: This approach also activates any plugins designed to work with SQL, such as formatters and/or linters, specified in your Neovim configuration.

Only Tree-sitter should treat it as SQL

Requires Neovim >= 0.9.0

If you would rather not prefer this, you have to assign such a files a custom filetype, and tell Treesitter to use SQL parser to parse these files.

vim.filetype.add({
    pattern = { [".*-query-[^%.]*"] = "dadbod-sql-custom" },
})
vim.treesitter.language.register("dadbod-sql-custom", "<filetype>")

The shared pattern should match with the filename in the screenshot, but you might have to adjust it to match your exact needs. Additionally, various other methods exist for specifying how to apply filetypes. One of them might suit your needs better.