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

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

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

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

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

从 身份验证 下拉列表中,选择您想要用于验证连接的身份验证方法。 提供以下选项:
pgpass :通过使用 pgpass 文件。 您可以将此文件存储在用户的主目录中。 您可以在 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 only :仅使用 URL 连接。
对于 URL only 连接类型 ,您输入的 JDBC URL 会被原样使用,包括数据库凭据。
对于其他连接类型,JDBC URL 被分解为连接详情。 您可以分别指定它们并使用自动生成的 URL,也可以直接在相应字段中输入 URL。

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

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

如果您遇到任何连接问题,请参考 无法连接到数据库 页面。
(可选)默认情况下,仅检查并提供默认数据库和架构以供使用。 如果您还想使用其他数据库和架构,请在 架构 选项卡中选择它们以进行检查。

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

连接设置和 DBMS 特定属性
连接设置
有关 数据源和驱动程序 对话框(Shift+Enter )中 常规 及其他选项卡上的连接设置(例如, 主机、 端口 等)的参考信息,请参见 数据源。
数据库管理系统特定属性
架构标签
项目 | 描述 |
|---|---|
显示内部系统架构 | 显示内部系统模式,如 pg_temp 或 p_toast。 |
显示模板数据库 | 显示模板数据库。 |