你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

快速入门:使用用于 Visual Studio Code 预览的 PostgreSQL 扩展连接和查询数据库

Visual Studio Code 的 PostgreSQL 扩展是一种功能强大的工具,旨在简化 PostgreSQL 数据库的开发和管理。 本指南逐步讲解如何连接到 PostgreSQL 数据库并在 Visual Studio Code 环境中执行查询。

先决条件

在开始之前,请验证是否已下载并安装正确的工具和资源。

这些工具和资源可帮助你遵循本文,充分利用 Visual Studio Code 中 PostgreSQL 扩展的 GitHub Copilot 集成。

安装 PostgreSQL 扩展

安装 PostgreSQL 扩展:

  1. 打开 Visual Studio Code,并通过选择活动栏中的“扩展”图标或使用 “视图:扩展”命令导航到“扩展”视图
  2. 在扩展市场中搜索 PostgreSQL
  3. 选择由Microsoft创作的 PostgreSQL 扩展,然后选择“ 安装”。

安装后,由大象图标表示的 PostgreSQL 页面将显示在 Visual Studio Code 边栏中。

添加与 PostgreSQL 的连接

无论是在本地托管还是远程服务器上,连接到 PostgreSQL 数据库都是管理和与数据交互的基本步骤。 此过程涉及提供必要的连接详细信息,例如服务器地址、端口和身份验证凭据,以在客户端应用程序和数据库之间建立安全链接。 借助适用于 Visual Studio Code 的 PostgreSQL 扩展,可以无缝连接到数据库,并使用功能强大的工具高效查询、管理和浏览数据。

  1. 选择侧栏中的大象图标以打开 PostgreSQL 扩展页。

  2. 选择“添加连接”按钮。

  3. 手动输入连接详细信息或使用连接字符串格式:

      psql -h <server>.postgres.database.azure.com -p 5432 -U
    
  4. 如果使用 Azure,请登录到 Azure 帐户并浏览数据库实例。 按订阅、资源组、服务器和数据库名称进行筛选。

身份验证

该扩展支持两种身份验证方法:

  • 用户名/密码:直接在连接字段中输入数据库凭据。
  • Microsoft Entra ID 身份验证:为 Azure 托管的数据库添加Microsoft Entra ID 帐户。

VS Code 连接对话框的 PostgreSQL 扩展的屏幕截图。

测试和保存连接

  1. 选择“测试连接”以验证连接详细信息。
  2. 测试成功后,测试框将显示一个勾号。
  3. 选择“连接”以建立连接。
  4. 连接会自动保存并显示在“连接”窗口中。

浏览数据库对象

对象资源管理器提供数据库对象的分层视图:

  • 展开数据库项以查看架构、表、视图、函数和存储过程。
  • 右键单击数据库,可以看到以下选项:- 启动新查询 - 使用此数据库聊天(启动 pgsql 聊天体验) - 使用 PSQL 连接以启动 psql 终端连接
  • 右键单击某个表,然后选择“选择前 1000 个”以查看其数据。 查询将在查询编辑器中打开,结果将显示在“结果查看器”选项卡中。

执行查询

使用查询编辑器起草和执行 SQL 查询:

  • 利用上下文感知 IntelliSense 自动完成 SQL 关键字和对象名称。
  • 语法突出显示和自动格式化可确保提高可读性和准确性。
  • 通过“查询历史记录”窗格访问以前执行的查询。

查看查询结果

结果查看器提供与查询结果交互的高级功能:

  • 将结果导出到 CSV、JSON 或 Excel 格式以供进一步分析。
  • 使用搜索、筛选和排序选项优化数据。
  • 持久数据视图可在选项卡之间切换时保持上下文。

使用 GitHub Copilot 获取高级帮助

GitHub Copilot 集成通过提供 AI 支持的代码建议、查询优化提示和交互式数据库帮助来增强 PostgreSQL 开发体验。 借助此功能,可以简化工作流、缩短开发时间,并深入了解数据库作。 本部分指导你完成在适用于 Visual Studio Code 的 PostgreSQL 扩展中激活和使用 Copilot 的步骤。

确保已安装 GitHub Copilot 和 Copilot Chat 扩展。

登录到 GitHub 帐户并在扩展设置中启用 @pgsql Copilot Chat 代理。

交互式数据库提示

右键单击某个数据库,然后选择 “与此数据库聊天 ”以与 Copilot 交互。

编写以下示例等提示,以接收详细的见解和建议。

@pgsql tell me about the tables in the HR schema

若要了解详细信息,请访问 配置 GitHub Copilot

使用 VS Code 从 Azure 门户连接到 Azure Database for PostgreSQL 灵活服务器实例

若要使用 Visual Studio Code 连接到 Azure Database for PostgreSQL 灵活服务器实例,请执行以下步骤:

  1. 登录到 Azure 门户,找到 Azure Database for PostgreSQL 灵活服务器实例。
  2. 转到服务器实例的“概述”页。

使用 VS Code 进行连接

Azure 门户中的“使用 Visual Studio Code 进行连接”选项简化了连接到 Azure Database for PostgreSQL 灵活服务器。 此功能通过指导你完成必要的先决条件并自动配置连接详细信息来简化设置。 使用此集成,可以快速建立连接并直接在 Visual Studio Code 环境中管理数据库。

  • 在“概述”页面上选择显著的 Connect with VS Code 按钮。
  • 此时会显示一个侧窗格,其中列出了使用 VS Code 进行连接的要求。

Azure 门户的屏幕截图,其中显示了带有“使用 VS Code 连接”按钮的 Azure Database for PostgreSQL 实例。

确认要求

  • 在侧窗格中,通过选中相应的复选框确认满足所有先决条件(VS Code 和 PostgreSQL 扩展)。

  • 如果需要,请使用侧窗格中的链接下载 Visual Studio Code 和扩展。

  • (可选)填写连接参数,例如默认数据库名称、身份验证方法和连接池。

    Azure 门户的屏幕截图,其中显示了使用 VS Code 连接面板的 Azure Database for PostgreSQL 实例。“在 Visual Studio Code 中打开”按钮突出显示。

在 Visual Studio Code 中打开

  • 在侧窗格中选择“ 在 Visual Studio Code 中打开 ”按钮。
  • 当 Visual Studio Code 及其扩展程序的打开时间超过 40 秒时,侧窗格中会出现一个“重试在 Visual Studio Code 中打开”按钮。

启动 Visual Studio Code

  • 如果已安装并运行 VS Code,PostgreSQL 扩展的连接对话框将自动启动。
  • 如果安装了 VS Code 但未打开,则会在大约 40 秒内启动,然后启动连接对话框。

自动填写连接详细信息

PostgreSQL 扩展中的连接对话框随即打开,“服务器名称”字段会自动填充服务器终结点。

VS Code 连接对话框的 PostgreSQL 扩展的屏幕截图,其中预填充了服务器名称详细信息。

提供身份验证详细信息

选择首选的身份验证方法:

  • 密码身份验证:手动输入用户名和密码。
  • Entra Authentication:输入 Azure 帐户凭据。

指定其他连接详细信息,例如配置文件名称、数据库名称(可选)、服务器组和端口号。

保存并连接

选择“ 保存和连接 ”按钮以建立连接。 连接后,展开对象资源管理器树中的服务器以查看数据库、架构和表,或使用内置查询工具管理数据库对象。

故障排除

如果在连接过程中遇到问题:

  • 验证是否已安装并启用 VS Code 和 PostgreSQL 扩展。

  • 确保在 Azure Database for PostgreSQL 的防火墙设置中允许 IP 地址。

  • 如果未满足先决条件,侧窗格会提供反馈和解决问题的步骤,包括重试连接。

反馈和支持

对于 bug、功能请求和问题,请使用 Visual Studio Code 中的内置反馈工具。 可以通过 VS Code 帮助菜单或 PGSQL 命令面板完成此作。

  • “帮助”菜单

    • 转到“帮助”>“报告问题”
  • 命令面板

    • 请通过 Ctrl + Shift + P 打开命令面板,并运行:PGSQL: Report Issue