适用于 VS Code 的 Redis

从 Visual Studio Code 连接到 Redis。

Redis for VS Code 是一个扩展,允许您从 Microsoft Visual Studio Code 中连接到 Redis 数据库。 连接到数据库后,您可以查看、添加、修改和删除键,并使用类似 Redis Insight 的 UI 和内置的 CLI 界面与 Redis 数据库进行交互。 支持以下数据类型:

安装 Redis for VS Code 扩展

打开 VS Code 并单击 Extensions 菜单按钮。在 Search Extensions in Marketplace 字段中,键入“Redis for VS Code”,然后按enterreturn钥匙。可能会显示多个选项,因此请务必单击 Redis 发布的扩展。正确的扩展如下所示。点击 Install 安装 安装扩展。

安装后,选中 Auto Update 按钮以允许 VS Code 自动安装扩展的未来版本。

安装扩展后,您的 VS Code 菜单将类似于以下内容。

连接到 Redis 数据库

单击 VS Code 菜单中的 Redis 标记(草书 R),开始将 Redis 数据库连接到 VS Code。如果您目前无法访问 Redis 数据库,请考虑试用 Redis Cloud。注册完全免费

单击 + Connect database 按钮。主窗格中将显示一个对话框。在下图中,已选中所有选项以显示每个连接的可用详细信息。这些连接详细信息类似于可从redis-cli.

注意:
在 Redis for VS Code 的第一个版本中,选择逻辑数据库后无法更改逻辑数据库。如果需要连接到其他逻辑数据库,则需要添加单独的数据库连接。

填写必要字段后,单击 Add Redis database 按钮。左侧的窗格(您通常会看到 Explorer 视图)显示您的数据库连接。

注意:
具有默认用户名且无密码的本地数据库(不包括 OSS 集群数据库)将自动添加到您的数据库连接列表中。

连接工具

对于每个打开的连接,将显示多个工具。

从左到右,它们是:

  • 刷新连接,从连接的 Redis 数据库中检索新数据。
  • Edit connection(编辑连接),其中显示一个对话框,类似于上面的 Connect to Redis Databases 中描述的对话框。
  • 删除连接。
  • 打开 CLI。有关更多信息,请参阅下面的 CLI 工具
  • 对键进行排序,升序或降序。
  • 按 key name 或 pattern 以及 key type 筛选键。
  • 按类型添加新键:Hash、List、Set、Sorted Set、String 或 JSON。

键视图

以下是当数据库中没有键时(左图)和键存在时(右图)时您将看到的内容。

Redis for VS Code 将根据一个可用设置(Delimiter to separate namespaces)自动对键进行分组,您可以通过单击左侧窗格右上角的齿轮图标来查看该设置。单击当前值以更改它。默认设置为冒号 (:) 字符。

单击一个键可显示其内容。

按键编辑工具

您可以使用多种编辑工具来编辑关键数据。每种数据类型都有自己的编辑功能。以下示例显示了对 JSON 数据的编辑。请注意,对密钥的更改会立即写入服务器。

  • 重命名。单击 key name 字段以更改名称。
  • 设置生存时间 (TTL)。单击 TTL 字段以设置持续时间(以秒为单位)。
  • 删除。单击垃圾桶图标可删除整个密钥(以红色突出显示)或密钥的一部分(以黄色突出显示)。
  • Add to key.单击右括号旁边的按钮(在上面以绿色突出显示)以将新组件添加到键中。+
  • 刷新。单击刷新图标(圆形箭头)可从服务器检索新数据。在下面的示例中,单击了 refresh(左侧图像),并且该键现在具有一个名为“test”的新字段,该字段由另一个 Redis 客户端添加(右侧图像)。

对于字符串、哈希、列表、集和排序集,该扩展支持许多值格式化程序(在下图中以红色突出显示)。他们是:

  • 统一码
  • ASCII 码
  • 二进制 (blob)
  • 十六进制
  • JSON 格式
  • 消息包
  • 泡菜
  • Protobuf
  • PHP 序列化
  • Java 序列化
  • 32 位矢量
  • 64 位矢量

此外,对于哈希键,您可以设置每个字段的 TTL(在上图中以黄色突出显示),这是 Redis 社区版 7.4 中新增的一项新功能。

CLI 工具

带有框图标的连接工具将在主窗格底部的 REDIS CLI 选项卡中打开一个 Redis CLI 窗口。>_

CLI 界面的工作方式与redis-cli命令。