跳到主要内容

SQL 窗口（Redis）

本文介绍如何使用 SQL 窗口管理 Redis 数据库。

背景信息​

Redis 是一个内存数据结构存储系统，它被广泛用于缓存、队列、实时分析等多种应用场景中。然而，管理 Redis 数据库需要一定的技术知识和经验，这对于很多开发人员来说是一个挑战。

NineData 的 SQL 窗口可以帮助用户更轻松地管理 Redis 数据库，通过 NineData，用户可以轻松地查看、编辑和管理 Redis 数据，还可以创建、删除和修改 Redis 数据库。

功能介绍​

NineData 的 SQL 窗口提供多个便捷功能，帮助您轻松管理您的数据源。

功能
说明
AI 智能辅助提供自然语言转换功能，通过简短的自然语言表达，即可快速转换成 Redis 命令。
可视化管理支持以可视化的方式进行如下操作：
  • 访问并查看数据。
  • 创建 Key、删除 Key、重命名 Key、修改 Key 的有效期。
  • 增删改 Key 的内容。
编辑器提供命令行模式，支持 Redis 功能强大的命令和选项，可以满足各种不同的需求。编辑器支持的 Redis 命令请参见附录。
工作现场恢复对于浏览器意外退出或突发宕机等场景，您只需要重新登录 NineData 控制台并打开 SQL 窗口，之前打开的数据源以及执行过的命令会被自动加载。由于页面状态保存在云端，不受浏览器或主机的限制，您可以随时随地恢复工作现场。
执行历史会记录当前账号在 NineData 控制台执行过的所有命令，还支持根据数据源、执行时间、命令关键字等方式快速检索。您也可以快速复制执行历史中的命令重新执行。
SQL 规范检查在组织模式组织模式支持对组织下的每个用户分配不同的角色和资源管理权限，适用于同一组织下多用户协同开发，在保证数据安全的同时，提升整体生产效率。下，系统会基于配置的 SQL 开发规范检查每一条在 SQL 窗口中执行的命令，如果该条命令不符合规范，则会被系统拦截，保证数据库安全。

使用场景​

NineData 的 Redis 编辑器功能适用于以下场景：

  • 开发人员：在开发过程中，开发人员可以通过 SQL 窗口管理和编辑 Redis 数据库中的数据，以便更快速、高效地开发应用程序。

  • 数据库管理员：帮助数据库管理员更轻松地管理 Redis 数据库，例如新增、编辑和删除数据等。

  • 运维人员：帮助运维人员快速监控和分析 Redis 数据库的性能和运行情况，以便及时发现和解决问题。

限制​

  • 仅 Redis 4.0.0 及以上版本支持显示 Key 的大小（Size）。
  • 仅 Redis 5.0.0 及以上版本支持管理 Stream 类型的 Key。

前提条件​

  • 已将目标需要管理的数据库添加到 NineData。如何添加，请参见管理数据源。

  • 数据源必须为 Redis 3.0.0 版本及以上。

  • 在组织模式（）下，您必须拥有目标数据源的只读、DML 或 DDL 权限。

    提示

    只读权限仅支持查询操作。

  • 在商业化版本下（、），请确保您的包年包月订阅未过期，否则将无法正常使用数据库 DevOps 服务。您可以在 NineData 控制台页面右上方快速查看剩余配额以及到期时间。check_quota

操作步骤​

  1. 登录 NineData 控制台。

  2. 在左侧导航栏单击 >。

    提示

    如果之前登录过数据源且没有关闭，则会自动进入该数据源页面。

  3. 单击 下方文本框，会弹出您已添加的数据源，单击目标数据源，并单击，跳转到 SQL 窗口。

    提示
    • 如果您之前没有创建过数据源，则会显示空白页。此时，请单击页面中的。

    • 如果有多个数据源，您可以在框中输入全部或部分关键词进行精确查找或模糊查找。支持搜索的字段如下：

      • 数据源名称
      • IP 地址

  4. 打开 SQL 窗口后，即可对数据源执行 SQL 开发操作。 SQL 窗口的详细使用方法，请参见 界面说明。

界面说明​

  • 可视化编辑器

    gui

    序号
    		功能
    		介绍
    1SQL 窗口页签表示当前已打开的数据源 SQL 窗口，多个 SQL 窗口可以通过单击页签切换，单击页签右侧的X可以关闭该 SQL 窗口。右键菜单支持如下操作：
    • ：打开当前数据源详情窗口。
    • ：打开一个新的数据源 SQL 窗口。
    • ：关闭当前页签。
    2打开数据源选择并打开新的数据源 SQL 窗口。
    3数据源信息展示当前 SQL 窗口的数据源信息，包含环境、IP 地址以及端口号。
    右键菜单：
    • ：显示当前数据源的详情信息，包含用户名、连接地址、运行时间、连接数等。
    • ：刷新数据源信息。
    4收藏|刷新
    • 收藏：单击收藏图标可以将当前数据源添加到中，添加后可以在新建 SQL 窗口中快速选择。
    • 刷新：可刷新当前数据源中的数据。
    5数据库名称（集群模式下为节点地址和端口）切换 Redis 数据库或集群模式下的节点地址。
    右键菜单：
    • ：显示目标数据库的详情信息，包含数据库名称、默认字符集、数据库大小、Key 总数等。
    • ：新建一个 Key，不同 的创建选项不同，请根据页面提示进行配置。
    • ：打开新的 SQL 窗口页签。
    6功能按钮
    • setting02：
      • ：可选或。
        • （默认）：新的结果集将覆盖上一次的执行结果。
        • ：生成新的页签展示新的结果集。
      • ：更改 SQL 窗口的主题，可选和。
      • ：拖动滑块调整 SQL 窗口中 SQL 语句的字体大小，默认值如下：
        • Windows：16
        • MacOS：13
    • thread： 显示当前数据库服务器上所有活动连接的信息，以及这些连接正在执行的查询。还支持自动刷新功能，可选择 5、10、20、30 秒自动刷新。
    • table： 切换可视化模式。
    • codefill： 切换编辑器模式。
    • expend： 将 SQL 窗口以全屏方式显示（浏览器大小)。全屏后，单击右上角的compress 可以恢复到原始 SQL 窗口大小。
    7搜索输入 Key 名快速查找目标 Key。支持输入完整的 Key 名进行精确搜索，也支持输入部分字符加星号通配符（*）进行模糊搜索。
    8Key 列表显示当前数据库中的 Key，默认加载 100 条。如需加载更多，可以拖动列表到队列最后，单击即可再加载 100 条。在 Key 列表中，您可以对 Key 做如下操作：
    • ：右键单击目标 Key，单击，在下方的文本框中输入新的 Key 名称，然后单击。
    • ：右键单击目标 Key，单击，然后单击。
    • ：右键单击目标 Key，单击，在下方的文本框中输入整数或单击文本框右侧的UpDown按钮上下调整数字，单位为秒，然后单击。如需取消过期时间，删除文本框内的数字，单击即可。
    • ：右键单击任意 Key，单击，打开 页签，您可以根据实际需求选择 ，不同 的创建选项不同，请根据页面提示进行配置，配置完成后单击 即可。
    • ：右键单击任意 Key，单击，可以打开新的 SQL 窗口页签。
    • ：右键单击任意 Key，单击，刷新 Key 列表。
    9创建 Key创建新的 Key。单击，打开 页签，您可以根据实际需求选择 ，不同 的创建选项不同，请根据页面提示进行配置，配置完成后单击 即可。
    说明：如需关闭 页签，直接单击页签右侧的Close图标。
    10Key 详情在 Key 列表中单击某个 Key，即可在此处显示该 Key 的详情。Key 中数据超出 100 条的，默认仅加载 100 条，单击页面底部的可再加载 100 条。
    在 Key 详情中您可以对 Key 进行如下操作：
    • 通用操作：
      • 更改 Key 名：单击 Key 名右侧的edit图标，在文本框中输入新的 Key 名，单击check即可。
      • 刷新 Key 内容：单击fresh图标可刷新 Key 的内容。
      • 删除 Key：单击delete图标，然后单击即可删除当前 Key。
      • 更改 Key 的有效期：单击 右侧的edit图标，在文本框中输入整数或单击文本框右侧的UpDown按钮上下调整数字，单位为秒，然后单击check。如需取消过期时间，删除文本框内的数字，单击check即可。
      • 查看 Key 的 （仅 4.0.0 版本及以上）和 。
      • 更改 Key 中数据的显示方式：单击搜索框左侧的显示方式下拉框，默认情况下显示为 Unicode，选择您需要的显示方式即可。
      • 搜索 Key 中的数据（Stream 类型除外)：支持精确搜索和模糊搜索，单击search图标查看搜索结果。
        • 精确搜索：输入完整的字段或值进行精确搜索。
        • 模糊搜索：输入字符串中的部分字符加星号通配符（*)进行模糊搜索。
    • Key 中数据的操作：根据 Key 类型的不同，支持的操作不同，通常支持新增、编辑、删除 Key 中的数据，具体请以控制台为准。

  • 命令行编辑器

    command_line

    序号
    		功能
    		介绍
    1SQL 窗口页签表示当前已打开的数据源 SQL 窗口，多个 SQL 窗口可以通过单击页签切换，单击页签右侧的X可以关闭该 SQL 窗口。右键菜单支持如下操作：
    • ：打开当前数据源详情窗口。
    • ：打开一个新的数据源 SQL 窗口。
    • ：关闭当前页签。
    2打开数据源选择并打开新的数据源 SQL 窗口。
    3数据源信息展示当前 SQL 窗口的数据源信息，包含环境、IP 地址以及端口号。
    右键菜单：
    • ：显示当前数据源的详情信息，包含用户名、连接地址、运行时间、连接数等。
    • ：刷新数据源信息。
    4收藏|刷新
    • 收藏：单击收藏图标可以将当前数据源添加到中，添加后可以在新建 SQL 窗口中快速选择。
    • 刷新：可刷新当前数据源中的数据。
    5数据库名称（集群模式下为节点地址和端口）切换 Redis 数据库或集群模式下的节点地址。
    集群模式下需要切换节点地址执行的命令包括 KEYS、SCAN、CLUSTER FLUSHSLOTS、CLUSTER MYID、CLUSTER MYSHARDID、CLUSTER ADDSLOTS、CLUSTER ADDSLOTSRANGE、CLUSTER DELSLOTS、CLUSTER DELSLOTSRANGE；除此之外的命令在任意节点均可执行。
    右键菜单：
    • ：显示目标数据库的详情信息，包含数据库名称、默认字符集、数据库大小、Key 总数等。
    • ：新建一个 Key，不同 的创建选项不同，请根据页面提示进行配置。
    • ：打开新的 SQL 窗口页签。
    6功能按钮
    • execute： 执行选中的 Redis 命令。
    • ：打开 页签，您可以根据实际需求选择 ，不同 提供的选项不同，请根据页面提示进行配置，配置完成后单击 即可。
    • thread： 显示当前数据库服务器上所有活动连接的信息，以及这些连接正在执行的查询。还支持自动刷新功能，可选择 5、10、20、30 秒自动刷新。
    • collect：：将当前 SQL 窗口中的所有 SQL 语句保存至 SQL 列表，方便下次使用。
    • sqlfile：：查看已保存的 SQL，您可以将目标 SQL 至当前的 SQL 窗口中。同时可以或目标 SQL。
    • sqlhistory：：查看目标数据源的 SQL 的执行历史。您可以选择日期过滤出某个时间段的执行历史，也可以通过关键词（SQL 语句、数据库名称、错误提示）搜索执行历史。
    • setting02： 设置结果集的展示方式以及 SQL 窗口的字体大小。
      • ：可选或。
        • （默认）：新的结果集将覆盖上一次的执行结果。
        • ：生成新的页签展示新的结果集。
      • ：更改 SQL 窗口的主题，可选和。
      • ：拖动滑块调整 SQL 窗口中命令的字体大小，默认值如下：
        • Windows：16
        • MacOS：13
    • admin：| 仅可操作，开启该模式后，SQL 窗口中执行的所有命令不受规范或审批流的限制，均可直接执行。
  • table： 切换可视化模式。
  • codefill： 切换编辑器模式。
  • expend： 将 SQL 窗口以全屏方式显示（浏览器大小)。全屏后，单击右上角的compress 可以恢复到原始 SQL 窗口大小。
7搜索输入 Key 名快速查找目标 Key。支持输入完整的 Key 名进行精确搜索，也支持输入部分字符加星号通配符（*）进行模糊搜索。8Key 列表显示当前数据库中的 Key，默认加载 100 条。如需加载更多，可以拖动列表到队列最后，单击即可再加载 100 条。在 Key 列表中，您可以对 Key 做如下操作：
  • ：右键单击目标 Key，单击，在下方的文本框中输入新的 Key 名称，然后单击。
  • ：右键单击目标 Key，单击，然后单击。
  • ：右键单击目标 Key，单击，在下方的文本框中输入整数或单击文本框右侧的UpDown按钮上下调整数字，单位为秒，然后单击。如需取消过期时间，删除文本框内的数字，单击即可。
  • ：右键单击任意 Key，单击，打开 页签，您可以根据实际需求选择 ，不同 的创建选项不同，请根据页面提示进行配置，配置完成后单击 即可。
  • ：右键单击任意 Key，单击，可以打开新的 SQL 窗口页签。
  • ：右键单击任意 Key，单击，刷新 Key 列表。
9命令行窗口执行 Redis 命令的窗口，具体支持的命令请参见附件。命令行窗口支持如下功能：
  • 执行 Redis 命令：支持执行单个或多个命令。
  • 语法高亮
  • 右键菜单：
    • ：执行光标所在位置的 SQL 语句。
    • ：将当前 SQL 窗口中的所有命令保存至收藏夹，方便下次使用。
    • ：查看已保存的命令，您可以将目标命令至当前的 SQL 窗口中。同时可以或目标命令。
    • ：查看目标数据源的 SQL 的执行历史。您可以选择日期过滤出某个时间段的执行历史，也可以通过关键词（SQL 语句、数据库名称、错误提示)搜索执行历史。
    • ：显示当前数据库服务器上所有活动连接的信息，以及这些连接正在执行的查询。
    • 常规操作：包括、、和。
    • ：选中光标所在位置的 SQL 语句。
10执行信息、结果集显示命令的执行信息以及结果集。
  • 执行信息：包含执行时间、执行的命令、执行状态、执行详情等信息。
  • 结果集：显示命令的返回结果。您还可以做如下操作：
    • 对结果集进行搜索。支持和。
    • 单击列名右侧的小箭头，可对结果集进行排序。
    • 将鼠标悬浮在目标结果集的页签上，将显示该结果集对应的命令。

附录：Redis 编辑器支持的命令列表​

关键字支持版本命令格式
BITCOUNT2.6.0BITCOUNT key [start end]
BITFIELD3.2.0BITFIELD key [GET type offset] [SET type offset value] [INCRBY type offset increment] [OVERFLOW WRAP|SAT|FAIL]
BITFIELD_RO6.0.0BITFIELD_RO key [GET encoding offset [GET encoding offset ...]]
BITOP2.6.0BITOP <AND | OR | XOR | NOT> destkey key [key ...]
BITPOS2.8.7BITPOS key bit [start [end [BYTE | BIT]]]
GETBIT2.2.0GETBIT key offset
SETBIT2.2.0SETBIT key offset value
最后于 更新