Sql

info

You can enable the extra with the :LazyExtras command. Plugins marked as optional will only be configured if they are installed.

Options

Additional options for this extra can be configured in your lua/config/options.lua file:

lua/config/options.lua

-- The setup below will automatically configure connections without the need for manual input each time.

-- Example configuration using dictionary with keys:
--    vim.g.dbs = {
--      dev = "Replace with your database connection URL.",
--      staging = "Replace with your database connection URL.",
--    }
-- or
-- Example configuration using a list of dictionaries:
--    vim.g.dbs = {
--      { name = "dev", url = "Replace with your database connection URL." },
--      { name = "staging", url = "Replace with your database connection URL." },
--    }

-- or
-- Create a `.lazy.lua` file in your project and set your connections like this:
-- ```lua
--    vim.g.dbs = {...}
--
--    return {}
-- ```

-- Alternatively, you can also use other methods to inject your environment variables.

-- Finally, please make sure to add `.lazy.lua` to your `.gitignore` file to protect your secrets.

Below you can find a list of included plugins and their default settings.

caution

You don't need to copy the default settings to your config. They are only shown here for reference.

vim-dadbod

Options

opts = nil

Full Spec

{
  "tpope/vim-dadbod",
  cmd = "DB",
}

vim-dadbod-completion

Options

opts = nil

Full Spec

{
  "kristijanhusak/vim-dadbod-completion",
  dependencies = "vim-dadbod",
  ft = sql_ft,
  init = function()
    vim.api.nvim_create_autocmd("FileType", {
      pattern = sql_ft,
      callback = function()
        if LazyVim.has("nvim-cmp") then
          local cmp = require("cmp")

          -- global sources
          ---@param source cmp.SourceConfig
          local sources = vim.tbl_map(function(source)
            return { name = source.name }
          end, cmp.get_config().sources)

          -- add vim-dadbod-completion source
          table.insert(sources, { name = "vim-dadbod-completion" })

          -- update sources for the current buffer
          cmp.setup.buffer({ sources = sources })
        end
      end,
    })
  end,
}

vim-dadbod-ui

Options

opts = nil

Full Spec

{
  "kristijanhusak/vim-dadbod-ui",
  cmd = { "DBUI", "DBUIToggle", "DBUIAddConnection", "DBUIFindBuffer" },
  dependencies = "vim-dadbod",
  keys = {
    { "<leader>D", "<cmd>DBUIToggle<CR>", desc = "Toggle DBUI" },
  },
  init = function()
    local data_path = vim.fn.stdpath("data")

    vim.g.db_ui_auto_execute_table_helpers = 1
    vim.g.db_ui_save_location = data_path .. "/dadbod_ui"
    vim.g.db_ui_show_database_icon = true
    vim.g.db_ui_tmp_query_location = data_path .. "/dadbod_ui/tmp"
    vim.g.db_ui_use_nerd_fonts = true
    vim.g.db_ui_use_nvim_notify = true

    -- NOTE: The default behavior of auto-execution of queries on save is disabled
    -- this is useful when you have a big query that you don't want to run every time
    -- you save the file running those queries can crash neovim to run use the
    -- default keymap: <leader>S
    vim.g.db_ui_execute_on_save = false
  end,
}

vim-dadbod-completion

Options

opts = nil

Full Spec

{
  "kristijanhusak/vim-dadbod-completion",
}

mason.nvim

Linters & formatters

Options

opts = { ensure_installed = { "sqlfluff" } }

Full Spec

{
  "williamboman/mason.nvim",
  opts = { ensure_installed = { "sqlfluff" } },
}

nvim-treesitter (optional)

Treesitter

Options

opts = { ensure_installed = { "sql" } }

Full Spec

{
  "nvim-treesitter/nvim-treesitter",
  optional = true,
  opts = { ensure_installed = { "sql" } },
}

edgy.nvim (optional)

Edgy integration

Options

opts = function(_, opts)
  opts.right = opts.right or {}
  table.insert(opts.right, {
    title = "Database",
    ft = "dbui",
    pinned = true,
    width = 0.3,
    open = function()
      vim.cmd("DBUI")
    end,
  })

  opts.bottom = opts.bottom or {}
  table.insert(opts.bottom, {
    title = "DB Query Result",
    ft = "dbout",
  })
end

Full Spec

{
  "folke/edgy.nvim",
  optional = true,
  opts = function(_, opts)
    opts.right = opts.right or {}
    table.insert(opts.right, {
      title = "Database",
      ft = "dbui",
      pinned = true,
      width = 0.3,
      open = function()
        vim.cmd("DBUI")
      end,
    })

    opts.bottom = opts.bottom or {}
    table.insert(opts.bottom, {
      title = "DB Query Result",
      ft = "dbout",
    })
  end,
}

blink.cmp (optional)

blink.cmp integration

Options

opts = {
  sources = {
    default = { "dadbod" },
    providers = {
      dadbod = { name = "Dadbod", module = "vim_dadbod_completion.blink" },
    },
  },
}

Full Spec

{
  "saghen/blink.cmp",
  optional = true,
  opts = {
    sources = {
      default = { "dadbod" },
      providers = {
        dadbod = { name = "Dadbod", module = "vim_dadbod_completion.blink" },
      },
    },
  },
  dependencies = {
    "kristijanhusak/vim-dadbod-completion",
  },
}

nvim-lint (optional)

Options

opts = function(_, opts)
  for _, ft in ipairs(sql_ft) do
    opts.linters_by_ft[ft] = opts.linters_by_ft[ft] or {}
    table.insert(opts.linters_by_ft[ft], "sqlfluff")
  end
end

Full Spec

{
  "mfussenegger/nvim-lint",
  optional = true,
  opts = function(_, opts)
    for _, ft in ipairs(sql_ft) do
      opts.linters_by_ft[ft] = opts.linters_by_ft[ft] or {}
      table.insert(opts.linters_by_ft[ft], "sqlfluff")
    end
  end,
}

conform.nvim (optional)

Options

opts = function(_, opts)
  opts.formatters.sqlfluff = {
    args = { "format", "--dialect=ansi", "-" },
  }
  for _, ft in ipairs(sql_ft) do
    opts.formatters_by_ft[ft] = opts.formatters_by_ft[ft] or {}
    table.insert(opts.formatters_by_ft[ft], "sqlfluff")
  end
end

Full Spec

{
  "stevearc/conform.nvim",
  optional = true,
  opts = function(_, opts)
    opts.formatters.sqlfluff = {
      args = { "format", "--dialect=ansi", "-" },
    }
    for _, ft in ipairs(sql_ft) do
      opts.formatters_by_ft[ft] = opts.formatters_by_ft[ft] or {}
      table.insert(opts.formatters_by_ft[ft], "sqlfluff")
    end
  end,
}