CockroachDB
启用 数据库工具和 SQL 插件
此功能依赖于 数据库工具和 SQL 插件,该插件在 PyCharm 中默认捆绑并启用。 如果相关功能不可用,请确保未禁用该插件。
按 Ctrl+Alt+S 打开设置,然后选择 。
打开 已安装 选项卡,找到 数据库工具和 SQL 插件,并选中插件名称旁的复选框。
官方文档和软件
开始之前
本文介绍在 PyCharm 中为与 CockroachDB 数据库的 连接 创建数据源并运行测试连接的一般步骤。 假定您已具备必要的连接详细信息,且数据库已启动并正在运行。
例如,如果您希望在您的计算机上运行数据库并连接到该数据库,则必须先在该计算机上安装相应的 DBMS 软件。
要了解您的 DBMS 软件,请参阅其 官方文档。
连接到 CockroachDB 数据库
要连接到数据库,请创建一个用于存储您的连接详细信息的数据源。
选择要创建的数据源。 您可以通过以下任一方式完成此操作:
在主菜单中,转到 ,然后选择 CockroachDB。
在 数据库 工具窗口中,点击工具栏上的
新建。 导航到 数据源 ,然后选择 CockroachDB。

在 数据源和驱动程序 对话框右侧窗格的 常规 选项卡中,指定驱动程序和连接类型。
在 驱动程序 列表中,保留默认驱动程序选项,除非您的连接需要其他驱动程序。
从 连接类型 列表中,根据您拥有的连接详细信息选择连接类型:
默认 :使用 主机、 端口、 数据库 和 URL 进行连接。
仅限 URL :仅使用 URL 进行连接。
对于 仅限 URL 连接类型 ,您输入的 JDBC URL 将按原样使用,其中包含数据库凭据。
对于其他连接类型, JDBC URL 会被拆分为连接详细信息。 您可以分别指定这些信息并使用自动生成的 URL,也可以在相应字段中直接输入 URL。

检查连接设置区域底部是否有 下载缺失的驱动程序文件 链接。 点击此链接以下载与数据库交互所需的驱动程序。 有关直接下载链接,请参阅 JetBrains JDBC drivers 页面。

下载的 JDBC 驱动程序将位于 PyCharm 配置目录。
您也可以使用您自己的数据库驱动程序,而不是提供的驱动程序。 有关使用您的驱动程序连接到数据库的更多信息,请参阅 Add a user driver to an existing connection。
如果没有 下载缺失的驱动程序文件 链接,则表示您已具有所需的驱动程序。
指定数据库连接详细信息。 或者,在 URL 字段中粘贴 JDBC URL。
在 主机 字段中,输入您的服务器地址。
在 端口 字段中,输入 CockroachDB 的端口。 默认端口为 26257。
在 身份验证 下拉列表中,选择您要用于连接身份验证的身份验证方法。 可用以下选项:
pgpass :使用 pgpass 文件。 您可以将此文件存储在用户的主目录中。 有关密码文件及其位置的更多信息,请参阅 The Password File at postgresql.org。
用户与密码 :使用您的登录名和密码。
无身份验证 :不需要身份验证。
在 用户 和 密码 字段中,输入您的用户凭据。
如无需密码,请将 密码 字段留空。
要删除已输入的密码,请右键点击 密码 字段并选择 设为空。

在 数据库 字段中,输入您要连接的数据库名称。
在 URL 字段中,PyCharm 将使用其他连接设置的值自动生成 JDBC URL。
如果需要使用带有某些附加设置的 JDBC URL,请将其粘贴到 URL 字段中。

在 身份验证 下拉列表中,选择您要用于连接身份验证的身份验证方法。 可用以下选项:
pgpass :使用 pgpass 文件。 您可以将此文件存储在用户的主目录中。 有关密码文件及其位置的更多信息,请参阅 The Password File at postgresql.org。
用户与密码 :使用您的登录名和密码。
无身份验证 :不需要身份验证。
在 用户 和 密码 字段中,输入您的用户凭据。
如无需密码,请将 密码 字段留空。
要删除已输入的密码,请右键点击 密码 字段并选择 设为空。

在 URL 字段中,PyCharm 将使用其他连接设置的值自动生成 JDBC URL。
如果需要使用带有某些附加设置的 JDBC URL,请将其粘贴到 URL 字段中。

有关连接设置和属性在 常规 和 数据源和驱动程序 对话框(Shift+Enter )的其他选项卡上的参考信息,请参见 连接设置和特定于 DBMS 的属性。
确保可以使用提供的详细信息建立数据库连接。 为此,请点击连接详细信息部分底部的 测试连接 链接。

如果遇到任何连接问题,请参阅 无法连接到数据库 页面。
(可选)默认情况下,只有默认数据库和架构会被自省并可用。 如果您也想处理其他数据库和架构,请在 架构 选项卡中选择它们进行自省。

点击 确定 以创建数据源。
在 数据库 工具窗口中找到您的新数据源。
连接到 CockroachDB Serverless
步骤 1。 创建实例并获取凭据
在 cockroachlabs.cloud 创建 CockroachDB Serverless 实例后,您将看到包含 IDE 所需凭据的连接字符串。
您可以稍后再次打开此对话框,但其中不包含您的密码。 请务必在创建实例时将其复制。

步骤 2。 在 PyCharm 中创建连接
要连接到数据库,请创建一个用于存储您的连接详细信息的数据源。
选择要创建的数据源。 您可以通过以下任一方式完成此操作:
在主菜单中,转到 ,然后选择 CockroachDB。
在 数据库 工具窗口中,点击工具栏上的
新建。 导航到 数据源 ,然后选择 CockroachDB。

在 数据源和驱动程序 对话框右侧窗格的 常规 选项卡中,指定驱动程序和连接类型。
在 驱动程序 列表中,保留默认驱动程序选项,除非您的连接需要其他驱动程序。
从 连接类型 列表中,根据您拥有的连接详细信息选择连接类型:
默认 :使用 主机、 端口、 数据库 和 URL 进行连接。
仅限 URL :仅使用 URL 进行连接。
对于 仅限 URL 连接类型 ,您输入的 JDBC URL 将按原样使用,其中包含数据库凭据。
对于其他连接类型, JDBC URL 会被拆分为连接详细信息。 您可以分别指定这些信息并使用自动生成的 URL,也可以在相应字段中直接输入 URL。

检查连接设置区域底部是否有 下载缺失的驱动程序文件 链接。 点击此链接以下载与数据库交互所需的驱动程序。 有关直接下载链接,请参阅 JetBrains JDBC drivers 页面。

下载的 JDBC 驱动程序将位于 PyCharm 配置目录。
您也可以使用您自己的数据库驱动程序,而不是提供的驱动程序。 有关使用您的驱动程序连接到数据库的更多信息,请参阅 Add a user driver to an existing connection。
如果没有 下载缺失的驱动程序文件 链接,则表示您已具有所需的驱动程序。
指定数据库连接详细信息。 或者,在 URL 字段中粘贴 JDBC URL。
在 主机 字段中,输入您的主机名。 主机名位于 at 符号(
@)之后、端口号之前。 在我们的示例中,它是free-tier5.gcp-europe-west1.cockroachlabs.cloud。从 身份验证 列表中,选择 用户与密码。
在 用户 字段中,输入您的用户名(例如,
user)。在 密码 字段中,输入您的密码。 创建 CockroachDB Serverless 新实例时,您会收到该密码。
有关连接设置和属性在 常规 和 数据源和驱动程序 对话框(Shift+Enter )的其他选项卡上的参考信息,请参见 连接设置和特定于 DBMS 的属性。
在 高级 选项卡中,执行以下操作:
点击参数表,然后开始键入
options。双击 选项 参数的 值 单元格,并输入您的集群名称。 例如,
wan-tapir-2723。
确保可以使用提供的详细信息建立数据库连接。 为此,请点击连接详细信息部分底部的 测试连接 链接。

如果遇到任何连接问题,请参阅 无法连接到数据库 页面。
(可选)默认情况下,只有默认数据库和架构会被自省并可用。 如果您也想处理其他数据库和架构,请在 架构 选项卡中选择它们进行自省。

点击 确定 以创建数据源。
在 数据库 工具窗口中找到您的新数据源。

连接设置和特定于 DBMS 的属性
连接设置
有关连接设置(例如, 主机、 端口 等)在 常规 和其他 数据源和驱动程序 对话框(Shift+Enter )选项卡上的参考信息,请参见 数据源。
特定于 DBMS 的属性
架构选项卡
项 | 说明 |
|---|---|
显示内部系统架构 | 显示内部系统架构(例如 |
显示模板数据库 | 显示模板数据库。 |