PgcliSublime

一个支持通过Sublime Text 3使用pgcli进行数据库感知智能自动补全的插件

要求

在Python 3.3上运行的pgcli（这是Sublime Text 3附带Python的版本）。我建议在虚拟环境中安装pgcli。

安装

通过Package Control

首选项 | Package Control | 安装包 | PgcliSublime

通过Git：将此存储库克隆到ST3 / Packages目录下的子目录。

可选

• 如果您想在Sublime Text中直接运行pgcli PostgreSQL命令行提示，请通过Package Control安装非常酷的SublimeREPL：首选项 | Package Control | 安装包 | SublimeREPL

配置

设置

打开默认设置文件：首选项 | 包设置 | PgcliSublime | 设置 - 默认和用户设置文件

首选项 | 包设置 | PgcliSublime | 设置 - 用户。将默认文件的全部内容复制并粘贴到用户文件中。您可以直接编辑默认设置文件，但每次更新PgcliSublime时您的更改都会被覆盖。

最重要的配置是设置正确的路径，以便Sublime Text 3 Python解释器可以导入pgcli。如果您将Python 3.3作为系统解释器运行，并且pgcli已安装在全局site-packages中，那么您不需要做任何事情。如果您是将pgcli安装在虚拟环境中，最简单的方法是将该虚拟环境的site-packages目录添加到pgcli_site_dirs设置中。注意，路径字符串需要使用“双引号”包围，反斜杠需要转义。下面是配置的示例。注意：您需要重新启动Sublime Text才能使更改的pgcli路径生效。

接下来，请在 pgcli_url 设置中指定您的默认数据库URL。您可以选择将其保留为 postgresql:// 以使用 PGHOSTNAME、PGDATABASE 和 PGUSER 值。

最后，如果您想启用一个到 pgcli 命令提示符的快捷方式，请填写“pgcli_system_cmd”。这将是针对特定操作系统而定的。

配置示例

以下是我使用的 Windows 系统配置。我有一个名为 pgcli3 的 pgcli Python 3.3虚拟环境，因为目前 windows 中 Python 3 和 python-prompt-toolkit 存在问题，所以我还有一个名为 pgcli2 的 Python 2.7虚拟环境，用于运行命令提示符。

{
   // Use pgcli to for autocomplete? If false, standard sublime autocompletion is used
   "pgcli_autocomplete":             true,

   // List of python directories to add to python path so pgcli can be imported
   "pgcli_dirs":                     [],

   // List of python site directories to add to python path so pgcli can be imported
   "pgcli_site_dirs":                 ["C:\\Users\\dg\\Anaconda3\\envs\\pgcli3\\Lib\\site-packages"],

   // The path to the postgresql database. This may also be overridden in project-specific settings
   "pgcli_url":                     "postgresql://postgres@localhost/test",

   // The command to send to os.system to open a pgcli command prompt
   // {url} is automatically formatted with the appropriate database url
   "pgcli_system_cmd":             "start cmd.exe /k \"activate pgcli2 && pgcli {url}\"",
}

键盘快捷键

您可以在 偏好设置 | 扩展包设置 | PgcliSublime | 键位绑定 - 默认 和用户覆盖文件中查看默认键盘快捷键。

偏好设置 | 扩展包设置 | PgcliSublime | 键位绑定 - 用户。同样，您可以将默认文件的全部内容复制粘贴到用户文件中。

使用方法

自动完成

PgcliSublime 在具有 SQL语法的文件中运行自动完成。创建一个新文件，并通过菜单 查看 | 语法 | SQL 手动设置语法，或者保存一个以 .sql 扩展名保存的文件，或者使用 PgcliSublime 快捷键 <ctrl-alt-shift-N> 打开一个新的文件并将语法自动设置为 SQL。在 SQL 文件中输入查询时，按 <tab> 或

<ctrl-space> 应触发一个自动完成菜单。

运行查询

使用快捷键 <alt-enter> 或通过菜单 工具 | PgcliSublime | 运行查询 将当前视图的内容作为 pgcli 查询运行。查询的输出将打印到 sublime 文本控制台 – 按

ctrl-~ 切换它，或者菜单 查看 - 显示控制台。

打开 pgcli 命令提示符

如果您已配置 pgcli_system_cmd 设置，您可以使用快捷键 <ctrl-F12> 打开 pgcli REPL，或通过菜单 工具 | PgcliSublime | 打开命令提示符

打开 pgcli SublimeREPL

如果您已安装 SublimeREPL，

<alt-F12 或菜单选项 在 SublimeREPL 中打开新的 pgcli REPL 应该会在新的标签页中打开与当前数据库连接的 pgcli 实例。有关更多快捷键和功能，请参阅 SublimeREPL 文档。

故障排除

我只在 Windows 上测试了此配置，因此欢迎提交错误报告。检查 sublime 控制台 (<ctrl-~>) 中是否有任何错误消息。