PostgresTools：VS Code的PostgreSQL扩展，提升开发效率

PostgresTools扩展为Visual Studio Code带来了强大的PostgreSQL功能，包括内联建议、语法检查和类型检查，极大地提升了开发者的工作效率。

什么是LSP？

LSP（Language Server Protocol）是由微软定义的协议，旨在跨多个编辑器标准化语言功能。如果您使用现代IDE并使用过自动完成或语法检查功能，您已经在使用LSP了。LSP服务器在后台分析您打开的文件，客户端则向服务器发送请求，如自动完成或代码操作。

设置LSP服务器

首先，您需要LSP服务器的二进制文件。Postgres语言服务器使用Rust编写，因此为不同机器编译了不同的二进制文件。您可以通过以下五种策略之一进行设置，扩展将按以下顺序检查：

• postgrestools.bin VSCode设置可以指向具有相对或绝对路径的二进制文件。如果您想从Postgres语言服务器发布中下载特定二进制文件并将其放置在您的项目中，可以使用此方法。
• 推荐：如果您使用Node.js，可以简单地运行npm i -D @postgrestools/postgrestools。重新启动扩展后，它将在您的node_modules中查找服务器二进制文件。
• 如果您使用Node.js但通过Yarn Plug'n'Play安装包，您仍然可以安装@postgrestools/postgrestools，扩展将检查您的.pnp.cjs文件以查找二进制文件。
• 您可以全局安装LSP服务器（例如通过brew或从GitHub发布中下载二进制文件）。确保其二进制文件在您的$PATH中暴露 - 扩展将在Darwin/Linux上搜索postgrestools，在Windows上搜索postgrestools.exe。
• 如果通过上述策略找不到LSP服务器二进制文件，并且您的存储库根目录没有package.json文件，您将被提示从postgrestools的GitHub发布中下载二进制文件。您也可以稍后通过下载服务器命令来执行此操作。请注意，上述策略仍将优先。

找到的二进制文件将被复制到您的VS Code扩展文件夹中的临时位置，并从那里运行。当您重新启动扩展时，将使用复制的二进制文件，并且不会搜索上述位置。

设置您的项目

其次，您需要在存储库根目录创建一个postgrestools.jsonc文件（或者，使用自定义文件位置并通过postgrestools.configFile设置指向它）。您可以在文档中找到合理的默认值。

当您指定db部分时，LSP服务器将连接到您的数据库并从中收集信息。这使得提供自动完成和类型检查成为可能。

另一方面，如果您省略该部分，这些功能将不会启用，您将仅获得语法检查。

验证其工作

要验证服务器是否已正确安装并运行，您可以使用“获取当前版本”命令，该命令列在有用命令中。

要验证客户端是否按预期工作，请打开一个.sql文件并编写一些乱码 - 您应该会看到来自pg(syntax)的红色波浪线。

与Supabase一起工作

Postgres语言服务器并非专门为与Supabase一起工作而定制 - 它适用于任何Postgres数据库。

如果您确实使用Supabase，可以通过在本地Supabase数据库上使用它来充分利用LSP（这是如何安装Supabase CLI的）。

一旦您在本地运行所有内容，运行supabase status以查看您的本地DB URL。

它的格式如下：postgresql://:@:/。

如果您提取这些值，将它们添加到您的postgrestools.jsonc文件中，并重新启动扩展，您应该准备就绪。

您也可以在远程数据库上运行LSP服务器，但这可能会导致小的延迟和小的性能开销（LSP服务器针对您的数据库运行准备语句以进行类型检查）。

您可以在https://supabase.com/dashboard/project//settings/database?showConnect=true找到您的远程数据库设置。

有用命令

扩展为您的VS Code命令面板添加了六个命令。它们都以PostgresTools为前缀。

• PostgresTools: Hard Reset（删除所有临时和全局二进制文件）是您的故障排除武器。它将基本删除所有由扩展复制和下载的二进制文件（不是您自己安装或复制的那些）。然后，扩展将再次通过设置中提到的策略搜索服务器二进制文件。
• PostgresTools: Download Server让您选择并下载服务器二进制文件。它将是与您的机器匹配的版本。如果您在您的VS Code设置中将postgrestools.allowDownloadPrereleases设置为true，您将能够选择预发布版本。
• PostgresTools: Get Current Version将在LSP服务器运行时打印当前版本。
• PostgresTools: Start和PostgresTools: Stop将停止或启动LSP服务器和客户端。
• PostgresTools: Restart连续运行stop和start。

故障排除

1. 首先，尝试通过上述提到的PostgresTools: Hard Reset（...）命令重新启动扩展。
2. 打开您的VS Code终端，选择输出选项卡，并在右侧选择postgrestools扩展之一。您可能会在日志中看到出了什么问题。

问题

如果您遇到任何问题，请在postgres语言服务器存储库中报告 - 我们最常阅读那里的问题。