PyCharm 2025.3 Help

Amazon Redshift

启用 数据库工具和 SQL 插件

此功能依赖 数据库工具和 SQL 插件,该插件在 PyCharm 中默认捆绑并启用。 如果相关功能不可用,请确保您未禁用该插件。

  1. 按下 Ctrl+Alt+S 打开设置,然后选择 插件

  2. 打开 已安装 选项卡,找到 数据库工具和 SQL 插件,然后选中插件名称旁的复选框。

开始之前

本主题介绍在 PyCharm 中为与您的 Amazon Redshift 数据库的 连接 创建数据源并运行测试连接的通用流程。 假定您已拥有必要的连接详细信息,且数据库正在运行。

要了解您的 DBMS 软件,请参阅其 官方文档

如果您希望从本地计算机访问私有 Amazon Redshift 集群,请考虑使用 Amazon Elastic Compute Cloud(Amazon EC2)实例,然后从 PyCharm 到该实例 创建 SSH 隧道。 有关配置 Amazon EC2 的更多信息,请参阅 aws.amazon.com 上的本教程

在 PyCharm 中,您可以使用共享数据库:

  • 共享数据库以及这些数据库所基于的 datashare 可以在 数据库 工具窗口中进行自省并显示。

  • 您可以修改 datashare 和共享数据库。 为此,在 数据库 工具窗口中右键点击相应对象,然后选择 修改 <object>。 或者,选中该对象并按 Ctrl+F6

  • 代码编辑器支持所有相关语句。

先决条件

您的 Amazon Redshift 控制台中必须包含一个 Amazon Redshift 集群。 有关 Amazon Redshift 集群的更多信息,请参阅 Amazon Redshift 入门

连接到 Amazon Redshift 数据库

要连接到数据库,请创建一个数据源来存储您的连接详细信息。

  1. 选择您要创建的数据源。 您可以通过以下方式之一完成此操作:

    • 在主菜单中,转到 文件(F) | 新建(N) | 数据源 并选择 Amazon Redshift

    • 数据库 工具窗口中,点击工具栏上的 新建图标新建。 转到 数据源 并选择 Amazon Redshift

    创建新数据源
  2. 数据源和驱动程序 对话框右侧窗格的 常规 选项卡中,指定驱动程序和连接类型。

    1. 驱动程序 列表中,除非您的连接需要其他驱动程序,否则请保留默认驱动程序选项。

    2. 连接类型 列表中,根据您拥有的连接详细信息选择连接类型:

      • 默认 :使用 主机端口数据库URL 进行连接。

      • IAM 集群/区域 :使用 数据库区域集群URL 进行连接。

      • 仅 URL :仅使用 URL 进行连接。

      对于 仅 URL 连接类型 ,将按原样使用您输入的 JDBC URL,其中包含数据库凭据。

      对于其他连接类型,JDBC URL 会被拆分为连接详细信息。 您可以分别指定这些信息并使用自动生成的 URL,也可以在相应字段中直接输入 URL。

    数据源和驱动程序对话框的常规选项卡
  3. 检查连接设置区域底部是否有 下载缺失的驱动程序文件 链接。 点击此链接以下载与数据库交互所需的驱动程序。 有关直接下载链接,请参阅 JetBrains JDBC 驱动程序 页面。

    下载缺失的驱动程序文件 链接

    下载的 JDBC 驱动程序的位置为 PyCharm 配置目录

    您也可以使用您自己的数据库驱动程序,而不是提供的驱动程序。 有关使用您自己的驱动程序连接到数据库的更多信息,请参阅 将用户驱动程序添加到现有连接

    如果没有 下载缺失的驱动程序文件 链接,则表示您已具备所需的驱动程序。

  4. 指定数据库连接详细信息。 或者,将 JDBC URL 粘贴到 URL 字段中。

    1. 主机 字段中,输入您的服务器地址。

    2. 端口 字段中,输入 Amazon Redshift 的端口。 默认端口为 5439。

    3. 身份验证 下拉列表中,选择用于对该连接进行身份验证的身份验证方法。 可用选项如下:

      • pgpass :使用 pgpass 文件。 您可以将此文件存储在用户的主目录中。 您可以在 postgresql.org 上的 The Password File 中了解有关密码文件及其位置的更多信息。

      • 用户与密码 :使用您的登录名和密码。

      • AWS 配置文件 :在 配置文件 字段中使用 AWS 命名配置文件。

        有关 AWS 命名配置文件的更多信息,请参阅 DBMS 特定属性 章节。

      • 无身份验证 :不需要身份验证。

    4. 数据库 字段中,输入您要连接的数据库名称。

    5. 在 Amazon Redshift 集群的设置中,复制 JDBC URL。

    6. URL 字段中,PyCharm 将使用其他连接设置的值自动生成 JDBC URL。

      将 Redshift 集群设置中的 JDBC URL 粘贴到 PyCharm 中的 URL 字段。

      如果您需要使用带有某些附加设置的 JDBC URL,请将其粘贴到 URL 字段中。 通用的 URL 如下所示:

      • 格式: jdbc:redshift://<connection_url><port_number>/<database_name>

      • 示例: jdbc:redshift://server.redshift.amazonaws.com:5439/myDatabase

      有关 URL 格式的更多信息,请参阅 Amazon Redshift 官方文档

    数据库连接详细信息
    1. 身份验证 下拉列表中,选择用于对该连接进行身份验证的身份验证方法。 可用选项如下:

      • pgpass :使用 pgpass 文件。 您可以将此文件存储在用户的主目录中。 您可以在 postgresql.org 上的 The Password File 中了解有关密码文件及其位置的更多信息。

      • 用户与密码 :使用您的登录名和密码。

      • AWS 配置文件 :在 配置文件 字段中使用 AWS 命名配置文件。

        有关 AWS 命名配置文件的更多信息,请参阅 DBMS 特定属性 章节。

      • 无身份验证 :不需要身份验证。

    2. 数据库 字段中,输入您要连接的数据库名称。

    3. 区域 字段中,输入您正在连接的数据库的 AWS 区域。

    4. 集群 字段中,输入包含您数据库的 Amazon Redshift 集群名称。

    5. 在 Amazon Redshift 集群的设置中,复制 JDBC URL。

    6. URL 字段中,PyCharm 将使用其他连接设置的值自动生成 JDBC URL。

      将 Redshift 集群设置中的 JDBC URL 粘贴到 PyCharm 中的 URL 字段。

      如果您需要使用带有某些附加设置的 JDBC URL,请将其粘贴到 URL 字段中。 通用的 URL 如下所示:

      • 格式: jdbc:redshift:iam://<cluster_name>:<region>/<database_name>

      • 示例: jdbc:redshift:iam://democluster:eu-south-2/demodb

      有关 URL 格式的更多信息,请参阅 Amazon Redshift 官方文档

    数据库连接详细信息
    1. 身份验证 下拉列表中,选择用于对该连接进行身份验证的身份验证方法。 可用选项如下:

      • pgpass :使用 pgpass 文件。 您可以将此文件存储在用户的主目录中。 您可以在 postgresql.org 上的 The Password File 中了解有关密码文件及其位置的更多信息。

      • 用户与密码 :使用您的登录名和密码。

      • AWS 配置文件 :在 配置文件 字段中使用 AWS 命名配置文件。

        有关 AWS 命名配置文件的更多信息,请参阅 DBMS 特定属性 章节。

      • 无身份验证 :不需要身份验证。

    2. 在 Amazon Redshift 集群的设置中,复制 JDBC URL。

    3. URL 字段中,PyCharm 将使用其他连接设置的值自动生成 JDBC URL。

      将 Redshift 集群设置中的 JDBC URL 粘贴到 PyCharm 中的 URL 字段。

      如果您需要使用带有某些附加设置的 JDBC URL,请将其粘贴到 URL 字段中。 通用的 URL 如下所示:

      • 格式: jdbc:redshift://<connection_url><port_number>/<database_name>

      • 示例: jdbc:redshift://server.redshift.amazonaws.com:5439

      有关 URL 格式的更多信息,请参阅 Amazon Redshift 官方文档

    数据库连接详细信息

    有关连接设置和属性在 常规 以及 数据源和驱动程序 对话框的其他选项卡(Shift+Enter )上的参考信息,请参见 连接设置与 DBMS 特定属性

  5. 用户密码 字段中,指定您的 Redshift 凭据。

  6. 确保可以使用提供的详细信息建立数据库连接。 为此,点击连接详细信息部分底部的 测试连接 链接。

    测试连接 链接

    如果遇到任何连接问题,请参阅 无法连接到数据库 页面。

  7. (可选)默认情况下,仅默认数据库会被自省并可供使用。 如果您还希望使用其他数据库、架构和共享数据库,请在 架构 选项卡中选择它们进行自省。

    数据源和驱动程序对话框的架构选项卡
  8. 点击 确定 以创建数据源。

  9. 数据库 工具窗口中找到您的新数据源。

    • 有关 数据库 工具窗口的更多信息,请参阅相应的 参考主题

    • 有关在 PyCharm 中使用数据库对象的更多信息,请参阅 数据库对象

    • 要编写并运行查询,点击该数据源并按 F4 打开默认的 查询文件

    • 要查看并编辑数据库对象的数据,请双击该对象以打开 数据编辑器和查看器

连接设置与 DBMS 特定属性

连接设置

有关连接设置(例如, 主机端口 等)在 常规 以及 数据源和驱动程序 对话框的其他选项卡(Shift+Enter )上的参考信息,请参见 数据源

DBMS 特定属性

常规选项卡

说明

连接类型

区域

可用于 Amazon Redshift 的 AWS 区域。

IAM 集群/区域

集群

Amazon Redshift 集群是一组计算资源。 有关更多信息,请参阅 Amazon Redshift 官方文档

配置文件

您的 AWS 命名配置文件。 命名配置文件是一组可用于身份验证的设置和凭据。 命名配置文件存储在 credentials 文件中。 这些文件的默认目录为 ~/.aws/credentials (Linux 和 macOS)和 %USERPROFILE%\.aws\credentials (Windows)。

请参阅以下 credentials 文件的示例:

[default] aws_access_key_id=ASIAIOSFODNN7EXAMPLE aws_secret_access_key=wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY aws_session_token = IQoJb3JpZ2luX2IQoJb3JpZ2luX2IQoJb3JpZ2luX2IQoJb3JpZ2luX2IQoJb3JpZVERYLONGSTRINGEXAMPLE [user1] aws_access_key_id=ASIAI44QH8DHBEXAMPLE aws_secret_access_key=je7MtGbClwBF/2Zp9Utk/h3yCo8nvbEXAMPLEKEY aws_session_token = fcZib3JpZ2luX2IQoJb3JpZ2luX2IQoJb3JpZ2luX2IQoJb3JpZ2luX2IQoJb3JpZVERYLONGSTRINGEXAMPLE

要使用存储在 user1 配置文件中的凭据,请在 配置文件 字段中输入 user1

有关命名配置文件的更多信息,请参阅 Amazon AWS 官方文档

所有类型(AWS 配置文件 身份验证方法)

架构选项卡

说明

显示内部系统架构

显示内部系统架构,如 pg_temppg_toast

显示模板数据库

显示模板数据库。

最后修改日期: 2025年 12月 2日