Redis
启用 数据库工具和 SQL 插件
此功能依赖 数据库工具和 SQL 插件,默认随 PyCharm 一起提供并启用。 如果相关功能不可用,请确保没有禁用该插件。
按下 Ctrl+Alt+S 以打开设置,然后选择 。
打开 已安装 选项卡,找到 数据库工具和 SQL 插件,并选中其名称旁边的复选框。
官方文档和软件
开始之前
本文介绍如何在 PyCharm 中为与您的 Redis 数据库的 连接创建数据源,并运行测试连接的一般流程。 假定您已拥有必要的连接详细信息,并且数据库已启动并正在运行。
例如,如果您想在本机上运行数据库并连接到该数据库,则必须先在该计算机上安装相应的 DBMS 软件。
如需了解您的 DBMS 软件,请参阅其 官方文档。
对于 Redis,目前不支持数据编辑。
PyCharm 使用 CONFIG GET databases 从配置中获取数据库数量。 如果该配置不可用, IDE 仅显示包含至少一个键的数据库。
连接 Redis 数据库
要连接到数据库,请创建一个数据源来存储您的连接详细信息。
选择要创建的数据源。 您可以通过以下方式之一执行此操作:
在主菜单中,转到 ,然后选择 Redis。
在 数据库 工具窗口 ,点击工具栏上的
新建。 导航到 数据源 并选择 Redis。

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

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

下载的 JDBC 驱动程序位于 PyCharm 配置目录。
您也可以使用数据库的自有驱动程序来替代提供的驱动程序。 有关使用您自己的驱动程序连接到数据库的更多信息,请参阅 向现有连接添加用户驱动程序。
如果没有 下载缺失的驱动文件 链接,则表明您已拥有所需的驱动程序。
指定数据库连接详细信息。 或者,将 JDBC URL 粘贴到 URL 字段。
在 主机 字段中输入您的服务器地址。
在 端口 字段中,输入 Redis 的端口。 默认端口为 6379。
在 身份验证 下拉列表中,选择要用于连接身份验证的身份验证方法。 可用的选项有:
用户与密码 :使用您的用户名和密码。
无身份验证 :不需要进行身份验证。
在 用户 和 密码 字段中输入您的用户凭据。
如无需使用密码,请将 密码 字段留空。
要删除先前输入的密码,右键点击 密码 字段并选择 设为空。

在 数据库 字段中输入要连接的数据库名称。
在 URL 字段中,PyCharm 生成的 JDBC URL 会自动使用其他连接设置的值。
如果需要使用带有某些其他设置的 JDBC URL,请将其粘贴到 URL 字段中。 通用 URL 如下所示:
格式:
jdbc:redis://<host_address>:<port_number>/<database_name>示例:
jdbc:redis://127.0.0.1:6379/myDatabase
有关 URL 格式的更多信息,请参阅 驱动程序文档。
在 Default key filter 中,设置用于自省器的正则表达式。

在 主机 字段中输入您的服务器地址。
在 端口 字段中,输入 Redis 的端口。 默认端口为 6379。
在 身份验证 下拉列表中,选择要用于连接身份验证的身份验证方法。 可用的选项有:
用户与密码 :使用您的用户名和密码。
无身份验证 :不需要进行身份验证。
在 用户 和 密码 字段中输入您的用户凭据。
如无需使用密码,请将 密码 字段留空。
要删除先前输入的密码,右键点击 密码 字段并选择 设为空。

在 数据库 字段中输入要连接的数据库名称。
在 URL 字段中,PyCharm 生成的 JDBC URL 会自动使用其他连接设置的值。
如果需要使用带有某些其他设置的 JDBC URL,请将其粘贴到 URL 字段中。 通用 URL 如下所示:
格式:
jdbc:redis://<host_address>:<port_number>/<database_name>示例:
jdbc:redis://127.0.0.1:6379/myDatabase
如果连接到集群需要 SSH 隧道,请指定该集群所有节点的主机和端口:
jdbc:redis:cluster://<host_address_01>:<port_number_01>,<host_address_02>:<port_number_02>,<host_address_03>:<port_number_03>/<database_name>。有关 URL 格式的更多信息,请参阅 驱动程序文档。
在 Default key filter 中,设置用于自省器的正则表达式。

在 身份验证 下拉列表中,选择要用于连接身份验证的身份验证方法。 可用的选项有:
用户与密码 :使用您的用户名和密码。
无身份验证 :不需要进行身份验证。
在 用户 和 密码 字段中输入您的用户凭据。
如无需使用密码,请将 密码 字段留空。
要删除先前输入的密码,右键点击 密码 字段并选择 设为空。

在 URL 字段中,PyCharm 生成的 JDBC URL 会自动使用其他连接设置的值。
如果需要使用带有某些其他设置的 JDBC URL,请将其粘贴到 URL 字段中。 通用 URL 如下所示:
格式:
jdbc:redis://<host_address>:<port_number>/<database_name>示例:
jdbc:redis://127.0.0.1:6379/myDatabase
有关 URL 格式的更多信息,请参阅 驱动程序文档。
在 Default key filter 中,设置用于自省器的正则表达式。

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

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

点击 确定 创建数据源。
在 数据库 工具窗口中找到您的新数据源。
连接设置和特定于 DBMS 的属性
连接设置
有关 数据源和驱动程序 对话框(Shift+Enter )中 常规 及其他选项卡上的连接设置(例如, 主机、 端口 等)的参考信息,请参阅 数据源。
特定于 DBMS 的属性
常规选项卡
项目 | 描述 | 连接类型 |
|---|---|---|
键过滤器 | 对于 Redis,键使用 Redis SCAN 命令进行自省。 在 Default key filter 中,设置用于自省器的正则表达式。 只有与该正则表达式匹配的键会被自省。 此设置有助于显著减少被自省的键数量,这对于较大的数据库很重要。 | 单机、 集群、 仅限 URL |
键分隔符 | 用于分隔键名各部分的符号。 例如, | 单机、 集群、 仅限 URL |
选项选项卡
项目 | 描述 |
|---|---|
COUNT option for SCAN command | SCAN 语句提示。 影响自省期间每次迭代获取的元素数量。 |