CockroachDB
官方文档与软件
准备开始
本文介绍如何在 WebStorm 中为与 CockroachDB 数据库的 连接 创建数据源,并运行测试连接的一般流程。 假设您已拥有必要的连接详细信息,并且数据库已启动并正在运行。
例如,如果要在本机上运行数据库并连接到该数据库,则必须先在该计算机上安装相应的 DBMS 软件。
要了解有关 DBMS 软件的更多信息,请参阅其 官方文档。
连接到 CockroachDB 数据库
要连接到数据库,请创建用于存储连接详细信息的数据源。
选择要创建的数据源。 您可以通过以下任一方式进行操作:
在主菜单中,转到 ,然后选择 CockroachDB。
在 数据库 工具窗口中,点击工具栏上的
新建。 导航到 数据源 并选择 CockroachDB。

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

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

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

在 数据库 字段中,输入要连接的数据库名称。
在 URL 字段中,WebStorm 会使用其他连接设置中的值自动生成 JDBC URL。
如果需要使用包含特定附加设置的 JDBC URL,请将其粘贴到 URL 字段中。

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

在 URL 字段中,WebStorm 会使用其他连接设置中的值自动生成 JDBC URL。
如果需要使用包含特定附加设置的 JDBC URL,请将其粘贴到 URL 字段中。

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

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

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

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

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

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

已下载 JDBC 驱动程序的位置是 WebStorm 配置目录。
您也可以使用自己的数据库驱动程序替代默认提供的驱动程序。 有关如何使用您自己的驱动程序连接数据库的详细信息,请参阅 将用户驱动程序添加到现有连接。
如果没有 下载缺失的驱动程序文件 链接,则表示您已拥有所需的驱动程序。
指定数据库连接详细信息。 或者,在 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 特定属性
“架构”选项卡
项目 | 描述 |
|---|---|
显示内部系统架构 | 显示 pg_temp 或 p_toast 等系统内部架构。 |
显示模板数据库 | 显示模板数据库。 |