Vim-dadbod-completion 使用教程

Vim-dadbod-completion 使用教程

vim-dadbod-completion Database autocompletion powered by https://github.com/tpope/vim-dadbod 项目地址: https://gitcode.com/gh_mirrors/vi/vim-dadbod-completion

1. 项目的目录结构及介绍

Vim-dadbod-completion 项目的主要目录结构如下：

vim-dadbod-completion/
├── after/
│   └── plugin/
├── autoload/
│   └── denops/
│       └── @ddc-sources/
├── doc/
├── lua/
├── plugin/
├── rplugin/
│   └── python3/
│       └── deoplete/
│           └── source/
├── src/
├── .gitignore
├── LICENSE
├── README.md
├── package.json
└── yarn.lock

• after/plugin/: Vim 插件加载完成后会执行这里的文件。
• autoload/: 自动加载的 Vim 脚本，用于实现插件的自动加载。
• denops/: 包含 Denops 相关的代码，这是一个 Vim 插件开发框架。
• doc/: 此目录应包含项目的文档，但在这个项目中未提供。
• lua/: Lua 脚本目录。
• plugin/: Vim 插件的主要脚本文件。
• rplugin/: 用于远程插件的 Python 脚本。
• src/: 源代码目录。
• .gitignore: 指定 Git 忽略的文件列表。
• LICENSE: 项目许可证文件。
• README.md: 项目说明文件。
• package.json: Node.js 项目配置文件。
• yarn.lock: Yarn 包管理器锁文件。

2. 项目的启动文件介绍

在这个项目中，并没有一个特定的“启动文件”。Vim-dadbod-completion 是作为 Vim 插件设计的，因此它通过 Vim 的插件系统加载。通常情况下，用户需要通过他们的 Vim 插件管理器（如 Vim-plug、Pathogen 或 Vundle）来安装和启动这个插件。

在插件加载完成后，它会根据用户的配置自动工作。例如，对于 deoplete 用户，他们需要在他们的 .vimrc 文件中添加以下配置：

call deoplete#custom#patch_filetype([
    'sql',
    'mysql',
    'plsql'
], 'sources', 'dadbod-completion')

3. 项目的配置文件介绍

Vim-dadbod-completion 的配置主要通过 Vim 变量进行。用户可以在他们的 .vimrc 文件中设置这些变量以改变插件的行为。

以下是一些可配置的设置：

• g:vim_dadbod_completion_mark: 用于更改完成项的默认标记。
• w:db, t:db, b:db, g:db: 用于设置数据库连接字符串。
• b:db_table: 用于限制列完成仅针对特定的表。

例如，如果你想要设置全局数据库连接字符串，你可以在 .vimrc 中添加：

let g:db = 'postgresql://user:pass@localhost:5432/db_name'

此外，如果需要清除数据库表和列的缓存，可以使用以下命令：

:DBCompletionClearCache

以上是 Vim-dadbod-completion 的基本目录结构、启动方式及配置文件介绍。用户可以根据自己的需求进行相应的配置和调整。

vim-dadbod-completion Database autocompletion powered by https://github.com/tpope/vim-dadbod 项目地址: https://gitcode.com/gh_mirrors/vi/vim-dadbod-completion