搜索本产品文档关键词
SQL窗口
所有文档
menu
没有找到结果,请重新输入

数据库智能驾驶舱 DBSC

SQL窗口

本文介绍如何使用 SQL 窗口。

前提条件

  • 实例已接入 DBSC,且接入状态为接入成功。
  • 数据源类型必须为下列其中之一:MySQL、PostgreSQL、GaiaDB、GaiaDB-X、Redis、PegaDB、MongoDB、VectorDB。
  • 开启企业版后,您必须拥有目标数据源的只读、DML 或 DDL 权限。

    注意

    只读权限仅支持查看数据库以及 SELECT 操作。

  • MongoDB 仅支持 3.2 版本及以上。

限制说明

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

功能介绍

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

功能 说明
执行 SQL 语句
  • 访问数据源中的数据。
  • 对数据源中的库、表、数据(记录)进行增删改操作。
  • 在数据源中创建视图、存储过程、函数、触发器、事件。
  • 对用户授权或回收权限。
  • 说明:您需要对数据源拥有相应的权限才可以执行上述操作
    生成创建脚本 支持针对数据源中已有的库、表、触发器、存储过程、事件、函数等对象生成创建脚本,用于在其他数据源中复制一个相同结构的对象等场景。
    可视化表结构设计 以可视化的方式创建表或编辑表。
    保存 SQL | 查看 SQL 对于常用 SQL,您可以将 SQL 保存,保存后的 SQL 也支持查看。
    VectorDB 可视化管理 支持以可视化树的方式访问、查看、管理 VectorDB 的库、表、列、索引等对象。
    VectorDB 一键生成请求体 同步 VectorDB 操作接口,支持表管理、索引管理、数据更新、数据查询、角色管理、用户管理等 35 个操作。选中即自动在编辑器中生成对应操作的 JSON 请求体样例。
    VectorDB 编辑器 提供编辑器,在选择了预置的各种 VectorDB 操作接口后,根据需求调整请求体并执行操作。
    Redis 可视化管理 支持以可视化的方式进行如下操作:
  • 访问并查看数据。
  • 创建 Key、删除 Key、重命名 Key、修改 Key 的有效期。
  • 增删改 Key 的内容
  • Redis 编辑器 提供命令行模式,支持 Redis 功能强大的命令和选项,可以满足各种不同的需求。编辑器支持的 Redis 命令请参见 附录
    MongoDB 编辑器 提供命令行模式,支持 MongoDB 功能强大的命令和选项,可以满足各种不同的需求。编辑器支持的 MongoDB 命令请参见 附录
    工作现场恢复 对于浏览器意外退出或突发宕机等场景,您只需要重新登录 DBSC 控制台并打开 SQL 窗口,之前打开的数据源以及执行过的 SQL 命令会被自动加载。
    SQL 执行历史 执行历史会记录当前账号在 DBSC 控制台执行过的所有 SQL 语句,还支持根据数据源、执行时间、SQL 关键字等方式快速检索。您也可以快速复制执行历史中的 SQL 语句重新在 SQL 窗口中执行。
    SQL 规范检查 在企业版模式下,系统会基于系统管理员配置的 SQL 开发规范检查每一条在 SQL 窗口中执行的 SQL,如果该条 SQL 不符合规范,则会被系统拦截,保证数据库安全。拦截后,根据系统管理员配置的审批流程,用户可以按照规范修改 SQL 重新提交,或直接提交 SQL 任务。

    操作步骤

    1. 登录 DBSC 控制台
    2. 在左侧导航栏,点击 数据开发—>SQL 窗口
    3. 单击 SQL 窗口下方文本框,会弹出可用的数据源,单击目标数据源,并单击开始查询,跳转到 SQL 窗口。
    4. 打开 SQL 窗口后,即可对数据源执行数据开发操作。SQL 窗口的详细使用方法,请参见 SQL 窗口界面介绍

    SQL窗口界面介绍

    MySQL/GaiaDB/GaiaDB-X/PostgreSQL

    序号 功能 介绍
    1 SQL 窗口页签 表示当前已打开的数据源 SQL 窗口,多个 SQL 窗口可以通过单击页签切换,单击页签右侧的X可以关闭该 SQL 窗口;双击页签可以更改页签的名称;拖动页签可以调整页签的位置。右键菜单支持如下操作:
  • 实例详情:打开当前数据源详情窗口。
  • 标签重命名:更改当前标签的名称。
  • 复制查询:打开一个当前数据源的 SQL 窗口。
  • 创建新查询:打开一个新的数据源 SQL 窗口。
  • 关闭窗口:关闭当前 SQL 窗口。
  • 关闭其他窗口:关闭除了当前 SQL 窗口以外的所有其他 SQL 窗口。
  • 关闭左侧所有窗口:关闭位于当前 SQL 窗口左侧的所有 SQL 窗口。
  • 关闭右侧所有窗口:关闭位于当前 SQL 窗口右侧的所有 SQL 窗口。
  • 关闭所有:关闭所有 SQL 窗口。
  • 2 打开数据源 选择并打开新的数据源 SQL 窗口。
    3 数据源信息 展示当前 SQL 窗口的数据源信息,包含环境、IP 地址以及端口号。
    右键菜单:
  • 实例详情:显示当前数据源的详情信息,包含用户名、连接地址、运行时间、连接数等。
  • 刷新:刷新数据源信息。
  • 4 收藏 | 刷新
  • 收藏:单击收藏图标可以将当前数据源添加到我的收藏中,添加后可以在新建 SQL 窗口中快速选择。
  • 刷新:可刷新当前数据源中的数据。
  • 5 数据库名称 选中目标数据库以执行 SQL 操作。
    6 功能按钮
  • image.png执行 执行选中的 SQL 语句。
  • image.png格式化:调整选中 SQL 语句的结构,增强可读性。
  • image.png执行计划:查看选中 SQL 语句的执行计划。
  • image.png收藏 SQL:将当前 SQL 窗口中的所有 SQL 语句保存至 SQL 列表,方便下次使用。
  • image.png收藏夹:查看已保存的 SQL,您可以将目标 SQL 插入至当前的 SQL 窗口中。同时可以编辑删除目标 SQL。
  • image.png 执行历史:查看目标数据源的 SQL 的执行历史。您可以选择日期过滤出某个时间段的执行历史,也可以通过关键词(SQL 语句、数据库名称、错误提示)搜索执行历史。
  • image.png设置
    • 保持会话(仅 MySQL):开启该功能,可以保证当前 SQL 窗口与数据源之间一直保持连接状态,不会建立新的连接。适用于需要保持会话的场景,例如需要在一系列查询中传递参数或存储中间结果的情况。
    • 结果集:可选覆盖追加
    • 覆盖(默认):新的结果集将覆盖上一次的执行结果。
    • 追加:生成新的页签展示新的结果集。
    • 主题:更改 SQL 窗口的主题,可选浅色深色
    • 字体大小:拖动滑块调整 SQL 窗口中 SQL 语句的字体大小。
  • image.png查看会话(MySQL、PostgreSQL、GaiaDB、GaiaDB-X):显示当前数据库服务器上所有活动连接的信息,以及这些连接正在执行的查询。查看会话还支持自动刷新功能,可选择 5、10、20、30 秒自动刷新。
  • image.png开启管理员模式 | 退出管理员模式系统管理员可操作,开启该模式后,SQL 窗口中执行的所有 SQL 不受规范或审批流的限制,均可直接执行。
  • image.png全屏 将 SQL 窗口以全屏方式显示(浏览器大小)。全屏后,单击右上角的image.png退出全屏可以恢复到原始 SQL 窗口大小。
  • 7 搜索 搜索对象名称,在左侧选择对象,然后在右侧搜索对应的对象名称即可,支持库、表、列、视图、函数、存储过程、触发器、事件。目前对象搜索支持 MySQL、GaiaDB、GaiaDB-X、PostgreSQL,其他数据源可输入表名快速查找目标数据表。
    8 数据库列表 显示当前数据源中所有的数据库和数据表。根据数据源类型的不同,支持的功能不同:
    MySQL、GaiaDB、GaiaDB-X:
  • 创建数据库:右键单击任意数据库,单击创建数据库,在弹出的对话框中,输入库名称字符集以及对应比较规则,单击确定,可视化创建数据库。
  • 创建表:右键单击目标库或库中任意表,单击创建表,可视化创建数据表。
  • 编辑表:右键单击目标表,单击编辑表,可对目标表结构进行编辑。
  • 创建非表对象:右键单击目标库,选择创建对象 > 非表对象名称,即可可视化创建非表对象。支持的非表对象包括视图、存储过程、触发器、事件、函数
  • 管理非表对象:右键单击目标库下的非表对象名称,可执行创建、编辑、重命名、复制、删除非表对象的操作,支持的非表对象包括视图、存储过程、触发器、事件、函数
  • 导出:右键单击目标库或表,单击导出,支持以多种格式导出数据表。
  • 导入:右键单击目标库或表,单击导入,支持以多种方式将数据导入到目标库表。
  • 查看用户列表:右键单击数据库列表最下方的用户,单击查看用户列表,可查看当前数据源中所有的用户信息。
  • PostgreSQL:
  • 创建数据库:右键单击任意数据库,单击创建数据库,在弹出的对话框中,根据提示配置各项库参数,单击确定,可视化创建数据库。
  • 创建 Schema:右键单击目标库或任意 Schema,单击创建 Schema,可视化创建 Schema。
  • 编辑 Schema:右键单击任意 Schema,单击编辑 Schema,可视化编辑 Schema。
  • 创建表:右键单击目标库、Schema 或库中任意表,单击创建表,可视化创建数据表。
  • 编辑表:右键单击目标表,单击编辑表,可对目标表结构进行编辑。
  • 创建角色:右键单击 Login/Group Roles 或目标角色,单击创建角色,根据提示配置各项角色参数,单击确定,可视化创建角色。
  • 编辑角色:右键单击目标角色,单击编辑角色,可视化编辑角色。
  • 9 SQL 编辑器 支持如下功能:
  • SQL 执行:支持单个语句或批量执行。
  • 中断执行:SQL 执行过程中可以单击停止查询中断 SQL 的执行。
  • 语法高亮:以不同颜色显示不同语法元素,提高代码的可读性。
  • SQL 智能提示:输入命令过程中根据您输入的语义自动弹出提示。
  • 查看 SQL 语法帮助:输入 SQL 关键字后,选中该关键字并单击鼠标右键 >帮助,即可查看该关键字对应的帮助信息。
  • SQL 模板:提供 CREATE、SELECT、INSERT、UPDATE、DELETE 等语句的常用模板,您只需要输入前置命令即可选择对应模板。例如:输入 CREATE 即可选择 CREATE TABLE、CREATE VIEW 等模板。
  • 右键菜单:
    • 执行:执行光标所在位置的 SQL 语句。
    • 格式化:调整选中 SQL 语句的结构,增强可读性。
    • 执行计划:查看选中 SQL 语句的执行计划。
    • 收藏 SQL:将当前 SQL 窗口中的所有 SQL 语句保存至 SQL 列表,方便下次使用。
    • 收藏夹:查看已保存的 SQL,您可以将目标 SQL插入至当前的 SQL 窗口中。同时可以编辑删除目标 SQL。
    • 执行历史:查看目标数据源的 SQL 的执行历史。您可以选择日期过滤出某个时间段的执行历史,也可以通过关键词(SQL 语句、数据库名称、错误提示)搜索执行历史。
    • 查看会话(MySQL、GaiaDB、GaiaDB-X):显示当前数据库服务器上所有活动连接的信息,以及这些连接正在执行的查询。查看会话还支持自动刷新功能,可选择 5、10、20、30 秒自动刷新。
    • 常规操作:包括剪切复制粘贴全选
    • 选中当前 SQL:选中光标所在位置的 SQL 语句。
    10 执行信息、结果集 显示 SQL 的执行信息以及结果集。
  • 执行信息:包含执行时间、执行的 SQL 语句、执行状态、执行耗时等信息。
  • 结果集:显示 SQL 的返回结果。您可以进行如下操作:
  • 编辑结果集(需满足条件:单表查询、包含主键列或唯一键列
    • 单击新增删除,或直接修改数据:可以可视化地对数据库进行增删改操作。
    • 单击新增删除,或直接修改数据:可以可视化地对数据库进行增删改操作。
    • 编辑行:右键单击目标单元格,选择编辑行,可以编辑单元格所在行的所有字段。
    • 上传文件:右键单击目标单元格,选择上传文件,可以上传文件填充当前单元格。
    • 粘贴行:右键单击目标单元格,选择粘贴行,可以将复制的行信息覆盖到当前行。
    • 粘贴单元格:右键单击目标单元格,选择粘贴单元格,可以将当前剪贴板(ClipBoard)中的信息覆盖到当前单元格。
    • 设为 Null:右键单击目标单元格,选择设为 Null,可以将当前单元格设置为 NULL(仅在字段未设置为 NOT NULL 时可用)。
    • 设为空值:右键单击目标单元格,选择设为空值,可以将单元格设置为空值。
    • 删除行:右键单击目标单元格,选择删除行,可以删除当前单元格所在行。
    通用操作
  • 单击image.png:将结果集以列模式展示。
  • 单击image.png:将结果集以行模式展示。
  • 单击image.png:支持以多种格式导出数据表,可导出范围为当前页或者全部数据(最多 10000 条)。
  • 单击image.png:将结果集缩放到页面最底部。单击image.png可以恢复。
  • 单击image.png:支持对结果集中的列进行锁定、隐藏、显示等操作。
  • 结果集搜索:支持模糊搜索精确搜索
  • 单击列名右侧的小箭头,可对结果集进行排序。
  • 复制行:右键单击目标单元格,选择复制行,可以复制单元格所在行的整行数据。
  • 复制列:右键单击目标单元格,选择复制列,可以复制单元格所在列的整列数据。
  • 复制单元格:右键单击目标单元格,选择复制单元格,可以复制当前单元格。
  • 复制为:右键单击目标单元格,选择复制为,可以选择将单元格所在行的数据复制为多种格式。
  • 导出:右键单击任意单元格,选择导出,可以将当前结果集以多种格式导出,可导出范围为当前页或者全部数据(最多 10000 条)。
  • 查看结果集对应的 SQL 语句:将鼠标悬浮在目标结果集的页签上,将显示该结果集对应的 SQL 语句。
  • 查看字端详情:将鼠标悬浮在目标字段上,将显示该字段的名称、数据类型、类型长度、注释信息。
  • 单列搜索:单击目标列名称右侧的筛选.svg图标,然后在弹出的文本框中输入关键字,可在该列内进行搜索过滤。
  • Redis/PegaDB

    序号 功能 介绍
    1 SQL 窗口页签 表示当前已打开的数据源 SQL 窗口,多个 SQL 窗口可以通过单击页签切换,单击页签右侧的X可以关闭该 SQL 窗口。右键菜单支持如下操作:
  • 实例详情:打开当前数据源详情窗口。
  • 复制查询:打开一个当前数据源的 SQL 窗口。
  • 创建新查询:打开一个新的数据源 SQL 窗口。
  • 关闭窗口:关闭当前 SQL 窗口。
  • 关闭其他窗口:关闭除了当前 SQL 窗口以外的所有其他 SQL 窗口。
  • 关闭左侧所有窗口:关闭位于当前 SQL 窗口左侧的所有 SQL 窗口。
  • 关闭右侧所有窗口:关闭位于当前 SQL 窗口右侧的所有 SQL 窗口。
  • 关闭所有:关闭所有 SQL 窗口。
  • 2 打开数据源 选择并打开新的数据源 SQL 窗口。
    3 数据源信息 展示当前 SQL 窗口的数据源信息,包含环境、IP 地址以及端口号。
    右键菜单:
  • 实例详情:显示当前数据源的详情信息,包含用户名、连接地址、运行时间、连接数等。
  • 刷新:刷新数据源信息。
  • 4 收藏 | 刷新
  • 收藏:单击收藏图标可以将当前数据源添加到我的收藏中,添加后可以在新建 SQL 窗口中快速选择。
  • 刷新:可刷新当前数据源中的数据。
  • 5 数据库名称(集群模式下为节点地址和端口) 切换 Redis 数据库或集群模式下的节点地址。
    右键菜单:
  • 数据库详情:显示目标数据库的详情信息,包含数据库名称、默认字符集、数据库大小、Key 总数等。
  • 创建 Key:新建一个 Key,不同 Key 类型的创建选项不同,请根据页面提示进行配置。
  • 创建新查询:打开新的 SQL 窗口页签。
  • 6 功能按钮
  • image.png执行 执行选中的 SQL 语句。
  • image.png收藏 SQL:将当前 SQL 窗口中的所有 SQL 语句保存至 SQL 列表,方便下次使用。
  • image.png收藏夹:查看已保存的 SQL,您可以将目标 SQL 插入至当前的 SQL 窗口中。同时可以编辑删除目标 SQL。
  • image.png 执行历史:查看目标数据源的 SQL 的执行历史。您可以选择日期过滤出某个时间段的执行历史,也可以通过关键词(SQL 语句、数据库名称、错误提示)搜索执行历史。
  • image.png设置
    • 结果集:可选覆盖追加
    • 覆盖(默认):新的结果集将覆盖上一次的执行结果。
    • 追加:生成新的页签展示新的结果集。
    • 主题:更改 SQL 窗口的主题,可选浅色深色
    • 字体大小:拖动滑块调整 SQL 窗口中 SQL 语句的字体大小。
  • image.png查看会话:显示当前数据库服务器上所有活动连接的信息,以及这些连接正在执行的查询。查看会话还支持自动刷新功能,可选择 5、10、20、30 秒自动刷新。
  • 可视化.svg可视化 切换可视化模式。
  • 编辑器.svg编辑器 切换编辑器模式。
  • image.png开启管理员模式|退出管理员模式系统管理员可操作,开启该模式后,SQL 窗口中执行的所有 SQL 不受规范或审批流的限制,均可直接执行。
  • image.png全屏 将 SQL 窗口以全屏方式显示(浏览器大小)。全屏后,单击右上角的image.png退出全屏可以恢复到原始 SQL 窗口大小。
  • 7 搜索 支持输入 Key 名快速查找目标 Key。支持输入完整的 Key 名进行精确搜索,也支持输入部分字符加星号通配符(*)进行模糊搜索。
    8 Key 列表 显示当前数据库中的 Key,默认加载 100 条。如需加载更多,可以拖动列表到队列最后,单击加载更多即可再加载 100 条。在 Key 列表中,您可以对 Key 做如下操作:
  • 重命名 Key:右键单击目标 Key,单击重命名 Key,在新名称下方的文本框中输入新的 Key 名称,然后单击确定
  • 删除 Key:右键单击目标 Key,单击删除 Key,然后单击确定
  • 修改 TTL:右键单击目标 Key,单击修改 TTL,在TTL下方的文本框中输入整数,单位为秒,然后单击确定。如需取消过期时间,删除文本框内的数字,单击确定即可。
  • 创建 Key:右键单击任意 Key,单击创建 Key,打开创建 Key 页签,您可以根据实际需求选择 Key 类型,不同 Key 类型的创建选项不同,请根据页面提示进行配置,配置完成后单击创建 Key 即可。
  • 创建新查询:右键单击任意 Key,单击创建新查询,可以打开新的 SQL 窗口页签。
  • 刷新:右键单击任意 Key,单击刷新,刷新 Key 列表。
  • 9 创建 Key 创建新的 Key。单击创建 Key,打开创建 Key 页签,您可以根据实际需求选择 Key 类型,不同 Key 类型的创建选项不同,请根据页面提示进行配置,配置完成后单击创建 Key 即可。
    说明*:如需关闭创建 Key** 页签,直接单击页签右侧的关闭图标。
    10 Key 详情 在 Key 列表中单击某个 Key,即可在此处显示该 Key 的详情。Key 中数据超出 100 条的,默认仅加载 100 条,单击页面底部的加载更多可再加载 100 条。
    在 Key 详情中您可以对 Key 进行如下操作:
  • 通用操作:
    • 更改 Key 名:单击 Key 名右侧的编辑图标,在文本框中输入新的 Key 名,单击确定按钮即可。
    • 刷新 Key 内容:单击刷新图标可刷新 Key 的内容。
    • 删除 Key:单击删除图标,然后单击确定即可删除当前 Key。
    • 更改 Key 的有效期:单击 TTL 右侧的编辑图标,在文本框中输入整数,单位为秒,然后单击确认按钮。如需取消过期时间,删除文本框内的数字,单击确认按钮即可。
    • 查看 Key 的 Size(仅 4.0.0 版本及以上)和 Length
    • 更改 Key 中数据的显示方式:单击搜索框左侧的显示方式下拉框,默认情况下显示为 Unicode,选择您需要的显示方式即可。
    • 搜索 Key 中的数据(Stream 类型除外):支持精确搜索和模糊搜索,单击查询图标查看搜索结果。
      • 精确搜索:输入完整的字段或值进行精确搜索。
      • 模糊搜索:输入字符串中的部分字符加星号通配符(*)进行模糊搜索。
  • Key 中数据的操作:根据 Key 类型的不同,支持的操作不同,通常支持新增、编辑、删除 Key 中的数据,具体请以控制台为准。
  • 11 执行信息、结果集 显示命令的执行信息以及结果集。
  • 执行信息:包含执行时间、执行的 SQL 语句、执行状态、执行耗时等信息。
  • 结果集:显示命令的返回结果。您可以进行如下操作:
    • 对结果集进行搜索。支持模糊搜索精确搜索
    • 单击列名右侧的小箭头,可对结果集进行排序。
    • 将鼠标悬浮在目标结果集的页签上,将显示该结果集对应的命令。

    MongoDB

    序号 功能 介绍
    1 SQL 窗口页签 表示当前已打开的数据源 SQL 窗口,多个 SQL 窗口可以通过单击页签切换,单击页签右侧的X可以关闭该 SQL 窗口。右键菜单支持如下操作:
  • 实例详情:打开当前数据源详情窗口。
  • 复制查询:打开一个当前数据源的 SQL 窗口。
  • 创建新查询:打开一个新的数据源 SQL 窗口。
  • 关闭窗口:关闭当前 SQL 窗口。
  • 关闭其他窗口:关闭除了当前 SQL 窗口以外的所有其他 SQL 窗口。
  • 关闭左侧所有窗口:关闭位于当前 SQL 窗口左侧的所有 SQL 窗口。
  • 关闭右侧所有窗口:关闭位于当前 SQL 窗口右侧的所有 SQL 窗口。
  • 关闭所有:关闭所有 SQL 窗口。
  • 2 打开数据源 选择并打开新的数据源 SQL 窗口。
    3 数据源信息 展示当前 SQL 窗口的数据源信息,包含环境、IP 地址以及端口号。
    右键菜单:
  • 实例详情:显示当前数据源的详情信息,包含用户名、连接地址、运行时间、连接数等。
  • 刷新:刷新数据源信息。
  • 4 收藏 | 刷新
  • 收藏:单击收藏图标可以将当前数据源添加到我的收藏中,添加后可以在新建 SQL 窗口中快速选择。
  • 刷新:可刷新当前数据源中的数据。
  • 5 功能按钮
  • image.png执行 执行选中的 SQL 语句。
  • image.png执行计划:查看选中 SQL 语句的执行计划。
  • image.png收藏 SQL:将当前 SQL 窗口中的所有 SQL 语句保存至 SQL 列表,方便下次使用。
  • image.png收藏夹:查看已保存的 SQL,您可以将目标 SQL 插入至当前的 SQL 窗口中。同时可以编辑删除目标 SQL。
  • image.png 执行历史:查看目标数据源的 SQL 的执行历史。您可以选择日期过滤出某个时间段的执行历史,也可以通过关键词(SQL 语句、数据库名称、错误提示)搜索执行历史。
  • image.png设置
    • 结果集:可选覆盖追加
    • 覆盖(默认):新的结果集将覆盖上一次的执行结果。
    • 追加:生成新的页签展示新的结果集。
    • 主题:更改 SQL 窗口的主题,可选浅色深色
    • 字体大小:拖动滑块调整 SQL 窗口中 SQL 语句的字体大小。
  • image.png查看会话(MySQL、PostgreSQL、GaiaDB、GaiaDB-X):显示当前数据库服务器上所有活动连接的信息,以及这些连接正在执行的查询。查看会话还支持自动刷新功能,可选择 5、10、20、30 秒自动刷新。
  • 可视化.svg可视化 切换可视化模式。
  • 编辑器.svg编辑器 切换编辑器模式。
  • image.png开启管理员模式 | 退出管理员模式系统管理员可操作,开启该模式后,SQL 窗口中执行的所有 SQL 不受规范或审批流的限制,均可直接执行。
  • image.png全屏 将 SQL 窗口以全屏方式显示(浏览器大小)。全屏后,单击右上角的image.png退出全屏可以恢复到原始 SQL 窗口大小。
  • 6 搜索 输入集合名称名快速查找目标集合。支持输入完整的集合名进行精确搜索,也支持输入集合名中的部分字符加星号通配符(*)进行模糊搜索。
    7 数据库列表 以树的形式展示当前数据源中所有的数据库,以及数据库中所有的集合、视图、索引等信息。将鼠标悬停在目标库、集合、索引、视图右侧的info.svg图标上,可以展示详细信息。
  • 通用右键菜单
    • 创建新查询:打开一个新的 SQL 窗口页签。
    • 刷新:刷新数据库列表。
  • 数据库右键菜单
    • 库详情:查看目标库的详细信息,包括库中集合、视图、索引、文档的数量,以及各对象的大小等信息。
    • 创建库:创建数据库,创建时需要同时输入数据库名称和集合名称。
    • 删除库:删除目标数据库。
    • 创建集合:在目标库中创建集合。
  • 集合右键菜单
    • 创建集合:在目标库中创建集合。
    • 重命名集合:更改目标集合的名称。
    • 清空集合:清空目标集合中所有的文档。
    • 删除集合:删除目标集合。
    • 创建索引:在目标集合中创建索引。更多信息,请参见创建索引
  • 索引右键菜单
    • 创建索引:在目标集合中创建索引。更多信息,请参见创建索引
    • 删除索引:删除目标索引。
  • 视图右键菜单
    • 重命名视图:更改目标视图的名称。
    • 删除视图:删除目标视图。
  • 8 选择数据库 可视化选择目标数据库进行操作。
    9 查看 | 编辑数据 在左侧数据库列表中单击某个集合,即可在此处显示该集合中的所有文档。
    在此您可以进行如下操作:
    • 搜索文档:支持在页面上方的搜索框中对集合中的文档进行精确搜索和模糊搜索。
      • 精确搜索:{<字段名称>:<值>}
      • 模糊搜索:{<字段名称>:{$regex:<值>}}
    • String 类型的值需要加上双引号("")。
    • 高级搜索:单击搜索框右侧的高级搜索,提供更多条件进行自定义搜索。更多信息,请参见 高级搜索
    • 执行计划:MongoDB 查询优化器基于搜索框中的内容生成的查询执行计划,用于确定最佳的查询方式和执行策略。执行计划描述了 MongoDB 如何执行查询并访问数据库中的数据。
    • 新增 Document:在当前集合中插入单个或多个文档,插入时仅需在大括号({})中使用 <字段名>:<值> 格式即可,多个字段之间用逗号(,)分隔。插入 String 类型的值时,需要用双引号("")将值包裹,例如:{name:"zhangsan"}。
    • 切换数据显示方式:通过单击显示方式的图标,可以实时切换数据显示方式。
      • icon.svg:以表格形式展现数据。
      • icon.svg:以列表形式展现数据。
      • icon.svg:以 JSON 形式展现数据。
    • 编辑文档:以可视化的形式编辑文档。更多信息,请参见编辑文档
    • 复制文档:单击目标文档右侧操作列的icon.svg>复制(JSON 下直接单击复制),可将该文档复制为 JSON 数组。
    • 克隆文档:单击目标文档右侧操作列的icon.svg>克隆(JSON 下直接单击克隆),可以克隆一个和目标文档一模一样的文档。
    • 删除文档:单击目标文档右侧操作列的icon.svg>删除(JSON 下直接单击删除),可以删除目标文档。
    • 刷新页面:单击页面右上角的刷新,可以刷新页面。
    • 删除集合:单击页面右上角的删除集合,可以删除当前集合。
    10 执行信息、结果集 显示命令的执行信息以及结果集。
  • 执行信息:包含执行时间、执行的命令、执行状态、执行详情等信息。
  • 结果集:显示命令的返回结果。您还可以做如下操作:
    • 对结果集进行搜索。支持模糊搜索精确搜索
    • 单击下列图标切换结果集展现方式:
      • icon.svg(默认):以 JSON 形式展现数据。
      • icon.svg:以表格形式展现数据。
      • icon.svg:以列表形式展现数据。
    • 在 JSON 结果集中,单击复制可以复制所有结果集。
    • 将鼠标悬浮在目标结果集的页签上,将显示该结果集对应的命令。

    VectorDB

    序号 功能 介绍
    1 SQL 窗口页签 表示当前已打开的数据源 SQL 窗口,多个 SQL 窗口可以通过单击页签切换,单击页签右侧的X可以关闭该 SQL 窗口。右键菜单支持如下操作:
  • 实例详情:打开当前数据源详情窗口。
  • 复制查询:打开一个当前数据源的 SQL 窗口。
  • 创建新查询:打开一个新的数据源 SQL 窗口。
  • 关闭窗口:关闭当前 SQL 窗口。
  • 关闭其他窗口:关闭除了当前 SQL 窗口以外的所有其他 SQL 窗口。
  • 关闭左侧所有窗口:关闭位于当前 SQL 窗口左侧的所有 SQL 窗口。
  • 关闭右侧所有窗口:关闭位于当前 SQL 窗口右侧的所有 SQL 窗口。
  • 关闭所有:关闭所有 SQL 窗口。
  • 2 打开数据源 选择并打开新的数据源 SQL 窗口。
    3 数据源信息 展示当前 SQL 窗口的数据源信息,包含环境、IP 地址以及端口号。
    右键菜单:
  • 实例详情:显示当前数据源的详情信息,包含用户名、连接地址、运行时间、连接数等。
  • 刷新:刷新数据源信息。
  • 4 收藏 | 刷新
  • 收藏:单击收藏图标可以将当前数据源添加到我的收藏中,添加后可以在新建 SQL 窗口中快速选择。
  • 刷新:可刷新当前数据源中的数据。
  • 5 数据库名称 选中目标数据库以执行 SQL 操作。
    6 API 操作请求 针对 VectorDB 的管理操作,此处选择的所有操作最终将转换为对 VectorDB 原生 API 的标准调用。选择后系统将自动在编辑器中生成 JSON 格式的请求体样例,您可直接在样例上进行调整。支持的操作如下:
    • 表管理:创建表、删除表、新增字段、新增表别名、取消表别名
    • 索引管理:创建索引、修改索引、重建索引、删除索引、查看索引详情
    • 数据更新:插入记录、更新插入记录、更新记录、删除记录
    • 数据查询:查询单条记录、标量批量查询、向量检索、批量向量检索、标量过滤查询、多向量检索
    • 角色管理:创建角色、删除角色、授权角色以权限、回收角色权限、展示角色的权限、根据权限筛选角色
    • 用户管理:创建用户、删除用户、修改用户密码、授权用户以角色、回收用户的角色、授权用户以权限、回收用户的权限、展示用户的权限、根据权限筛选用户
    7 功能按钮
  • image.png执行 执行选中的 VectorDB 操作。
  • image.png全屏 将 SQL 窗口以全屏方式显示(浏览器大小)。全屏后,单击右上角的image.png退出全屏可以恢复到原始 SQL 窗口大小。
  • 8 对象树 以树的形式展示当前 VectorDB 中的所有库、表、列、非表对象。您可以做如下操作:
    • 创建数据库:VectorDB 中没有任何库的情况下,单击页面中的创建数据库的按钮;VectorDB 中已有数据库的情况下,右键单击任意数据库名称,单击创建数据库。在弹出窗口中输入库名称,然后单击确定
    • 删除数据库:右键单击目标数据库名称,单击删除数据库,然后在确认窗口中单击确定
    • 表详情:右键单击目标表名,单击 表详情,查看表的详细信息,包含Desc(表结构描述)、Alias(表别名信息)、Stats(表统计信息)。
      • Desc:描述表的完整元数据信息,包含字段定义、索引配置、分区策略等核心属性。
      • Alias:表的别名映射关系,用于实现逻辑表名与物理表名的解耦。
      • Stats:表的实时统计指标,用于监控与性能分析。
    • 复制查询:右键单击任意对象,单击复制查询,可以为当前数据源新开一个 SQL 窗口页签。
    • 刷新:右键单击任意对象,单击刷新,刷新索引列表。
    9 编辑器窗口 执行 VectorDB 操作的窗口,该窗口支持如下功能:
    • 执行 VectorDB 操作:便捷选择操作类型,即可生成 JSON 格式的请求体样例,支持直接在样例上进行调整。
    • 语法高亮
    • 右键菜单:
      • 执行:执行光标所在位置的 VectorDB 操作。
      • 常规操作:包括剪切复制粘贴全选
      • 选中当前 SQL:选中光标所在位置的命令。
    10 执行信息、结果集 显示命令的执行信息以及结果集。
  • 执行信息:包含执行时间、执行的命令、执行状态、执行详情等信息。
  • 结果集:显示命令的返回结果,以 JSON 格式显示。将鼠标悬浮在目标结果集的页签上,将显示该结果集对应的命令。
  • MongoDB高级搜索说明

    SQL 窗口(MongoDB)支持对目标集合执行更高阶的搜索,提供如下各项参数:

    • Project:对搜索结果进行投影(Projection),它可以根据需要,只输出所需的字段或计算的结果。通过 Project,可以对文档进行重命名、添加新字段、删除字段等操作,从而定制输出结果的结构。例如:{name:1} 表示搜索结果中仅展示 name 字段。更多信息,请参见Aggregation Pipeline Optimization
    • Sort: 对搜索结果进行排序。它可以按照指定的字段进行升序或降序排序。可以同时指定多个排序字段,并可以使用索引提高排序的性能。 例如:{age:1} 表示年龄从小到大排序搜索结果,{age:-1} 则表示年龄从大到小。更多信息,请参见Aggregation Pipeline Optimization
    • Collation:指定搜索结果的排序规则,用于区分大小写、多语言排序、特定排序规则等需求,可以更精细地控制字符串的排序结果。例如:{locale:"en"} 表示搜索结果将根据英语的排序规则进行。更多信息,请参见 Collation
    • Skip:用于跳过指定数量的文档,并返回剩余文档,实现分页或跳过不需要的文档。例如:输入整数 10,将跳过前 10 条搜索结果,直接从第 11 条搜索结果开始展示。
    • Limit:用于限制返回的文档数量。例如:输入整数 10,将仅返回 10 条搜索结果。

    MongoDB编辑文档说明

    通过 SQL 窗口(MongoDB),您可以在多种模式下对文档进行可视化编辑:

    • icon.svg表格模式:单击目标文档右侧操作列的编辑,可直接编辑对应字段的值,也可单击目标字段右侧的icon.svg图标,编辑 Value 文本框里的值,并单击确定。完成编辑后,单击页面下方的提交变更完成变更。
    • icon.svg列表模式:单击目标文档右侧操作列的编辑,再单击改文档 Value 列右侧的icon.svg图标,在 Value 文本框进行编辑,支持变更字段名和值,也支持新增字段,然后单击确定。完成编辑后,单击页面下方的提交变更完成变更。
    • icon.svgJSON 模式:直接在 JSON 字符串中进行编辑,支持变更字段名和值,也支持新增字段,完成编辑后,单击页面下方的提交变更完成变更。

    MongoDB创建索引

    1. 在 SQL 窗口左侧的数据库列表中找到目标集合,右键单击该集合并单击创建索引
    2. 根据下表进行配置:

      参数 说明
      索引名称 输入索引的名称,索引的命名请尽量遵循命名规范。
      Field 选择需要添加索引的字段名,单击 Add 可以新增一行,为多个字段添加索引。
      Type 选择索引类型,支持如下类型:
      • 升序索引(Ascending Index):对索引字段进行升序排序。
      • 降序索引(Descending Index):对索引字段进行降序排序。
      • 散列索引(Hashed Index):将索引字段的值哈希化,并以哈希值进行索引。该索引可用于均匀分布数据的快速查找,但不支持范围查询。
      • 文本索引(Text Index):用于在文本数据上进行全文搜索,支持对文本字段进行关键字搜索和排序。
      • 2dsphere 索引:用于存储地理空间数据(经纬度坐标),支持地理空间的查询和索引,如距离计算和范围查询。
      • 2d 索引:用于存储平面上的地理空间数据(x、y 坐标),支持平面地理空间的查询和索引。
      • GeoHaystack 索引:用于优化附近的地理位置查询,适用于具有大量地理位置数据的场景。
      其他配置 选择索引的配置选项:
      • Background(默认选中):指定是否在后台创建索引,对于大型集合,如果不选中该选项可能导致实例被阻塞。
      • Unique:指定索引是否要求唯一值,选中该选项可以确保索引字段的值在集合中是唯一的。
      • Sparse:指定是否创建稀疏索引。选中该选项,将只针对包含目标字段的文档创建索引,没有该字段的文档将被忽略。使用稀疏索引可以节省索引的存储空间。
      • Expire after:用于创建一个具有过期时间的索引,也称为 Time to Live(TTL)索引,该选项支持您为集合中的文档指定一个自动删除的时间点,单位为秒。
      预览 将可视化创建索引的动作转换成实际的 MongoDB 命令,让整个索引的创建过程更加直观。
    3. 单击确定

    附录:Redis支持的命令列表

    Bitmap

    关键字 支持版本 命令格式
    BITCOUNT 2.6.0 BITCOUNT key [start end]
    BITFIELD 3.2.0 BITFIELD key [GET type offset] [SET type offset value] [INCRBY type offset increment] [OVERFLOW WRAP|SAT|FAIL]
    BITFIELD_RO 6.0.0 BITFIELD_RO key [GET encoding offset [GET encoding offset ...]]
    BITOP 2.6.0 BITOP <AND | OR | XOR | NOT> destkey key [key ...]
    BITPOS 2.8.7 BITPOS key bit [start [end [BYTE | BIT]]]
    GETBIT 2.2.0 GETBIT key offset
    SETBIT 2.2.0 SETBIT key offset value

    Connection Management

    关键字 支持版本 命令格式
    SELECT 1.0.0 SELECT index

    Generic

    关键字 支持版本 命令格式
    COPY 6.2.0 COPY source destination [DB destination-db] [REPLACE]
    DEL 1.0.0 DEL key [key ...]
    DUMP 2.6.0 DUMP key
    EXISTS 1.0.0 EXISTS key [key ...]
    EXPIRE 1.0.0 EXPIRE key seconds [NX | XX | GT | LT]
    EXPIREAT 1.2.0 EXPIREAT key unix-time-seconds [NX | XX | GT | LT]
    EXPIRETIME 7.0.0 EXPIRETIME key
    MIGRATE 2.6.0 MIGRATE host port <key | ""> destination-db timeout [COPY] [REPLACE] [AUTH password | AUTH2 username password] [KEYS key [key ...]]
    MOVE 1.0.0 MOVE key db
    OBJECT ENCODING 2.3.3 OBJECT ENCODING key
    OBJECT FREQ 4.0.0 OBJECT FREQ key
    OBJECT IDLETIME 2.2.3 OBJECT IDLETIME key
    OBJECT REFCOUNT 2.2.3 OBJECT REFCOUNT key
    PERSIST 2.2.0 PERSIST key
    PEXPIRE 2.6.0 PEXPIRE key milliseconds [NX | XX | GT | LT]
    PEXPIREAT 2.6.0 PEXPIREAT key unix-time-milliseconds [NX | XX | GT | LT]
    PEXPIRETIME 7.0.0 PEXPIRETIME key
    PTTL 2.6.0 PTTL key
    RANDOMKEY 1.0.0 RANDOMKEY
    RENAME 1.0.0 RENAME key newkey
    RENAMENX 1.0.0 RENAMENX key newkey
    RESTORE 2.6.0 RESTORE key ttl serialized-value [REPLACE] [ABSTTL] [IDLETIME seconds] [FREQ frequency]
    SCAN 2.8.0 SCAN cursor [MATCH pattern] [COUNT count] [TYPE type]
    SORT 1.0.0 SORT key [BY pattern] [LIMIT offset count] [GET pattern [GET pattern ...]] [ASC | DESC] [ALPHA] [STORE destination]
    SORT_RO 7.0.0 SORT_RO key [BY pattern] [LIMIT offset count] [GET pattern [GET pattern ...]] [ASC | DESC] [ALPHA]
    TOUCH 3.2.1 TOUCH key [key ...]
    TTL 1.0.0 TTL key
    TYPE 1.0.0 TYPE key
    UNLINK 4.0.0 UNLINK key [key ...]

    Cluster management

    关键字 支持版本 命令格式
    ASKING 3.0.0 ASKING
    CLUSTER ADDSLOTS 3.0.0 CLUSTER ADDSLOTS slot [slot ...]
    CLUSTER ADDSLOTSRANGE 7.0.0 CLUSTER ADDSLOTSRANGE start-slot end-slot [start-slot end-slot ...]
    CLUSTER BUMPEPOCH 3.0.0 CLUSTER BUMPEPOCH
    CLUSTER COUNT-FAILURE-REPORTS 3.0.0 CLUSTER COUNT-FAILURE-REPORTS node-id
    CLUSTER COUNTKEYSINSLOT 3.0.0 CLUSTER COUNTKEYSINSLOT slot
    CLUSTER DELSLOTS 3.0.0 CLUSTER DELSLOTS slot [slot ...]
    CLUSTER DELSLOTSRANGE 7.0.0 CLUSTER DELSLOTSRANGE start-slot end-slot [start-slot end-slot ...]
    CLUSTER FLUSHSLOTS 3.0.0 CLUSTER FLUSHSLOTS
    CLUSTER FORGET 3.0.0 CLUSTER FORGET node-id
    CLUSTER GETKEYSINSLOT 3.0.0 CLUSTER GETKEYSINSLOT slot count
    CLUSTER INFO 3.0.0 CLUSTER INFO
    CLUSTER KEYSLOT 3.0.0 CLUSTER KEYSLOT key
    CLUSTER LINKS 7.0.0 CLUSTER LINKS
    CLUSTER MEET 3.0.0 CLUSTER MEET ip port [cluster-bus-port]
    CLUSTER MYID 3.0.0 CLUSTER MYID
    CLUSTER MYSHARDID 7.2.0 CLUSTER MYSHARDID
    CLUSTER NODES 3.0.0 CLUSTER NODES
    CLUSTER REPLICAS 5.0.0 CLUSTER REPLICAS node-id
    CLUSTER REPLICATE 3.0.0 CLUSTER REPLICATE node-id
    CLUSTER RESET 3.0.0 CLUSTER RESET [HARD | SOFT]
    CLUSTER SAVECONFIG 3.0.0 CLUSTER SAVECONFIG
    CLUSTER SET-CONFIG-EPOCH 3.0.0 CLUSTER SET-CONFIG-EPOCH config-epoch
    CLUSTER SETSLOT 3.0.0 CLUSTER SETSLOT slot <IMPORTING node-id | MIGRATING node-id | NODE node-id | STABLE>
    CLUSTER SHARDS 7.0.0 CLUSTER SHARDS
    CLUSTER SLAVES 3.0.0 CLUSTER SLAVES node-id
    CLUSTER SLOTS 3.0.0 CLUSTER SLOTS
    READONLY 3.0.0 READONLY
    READWRITE 3.0.0 READWRITE

    Geospatial Indices

    关键字 支持版本 命令格式
    GEOADD 3.2.0 GEOADD key [NX | XX] [CH] longitude latitude member [longitude latitude member ...]
    GEODIST 3.2.0 GEODIST key member1 member2 [M | KM | FT | MI]
    GEOHASH 3.2.0 GEOHASH key [member [member ...]]
    GEOPOS 3.2.0 GEOPOS key [member [member ...]]
    GEORADIUS 3.2.0 GEORADIUS key longitude latitude radius <M | KM | FT | MI> [WITHCOORD] [WITHDIST] [WITHHASH] [COUNT count [ANY]] [ASC | DESC] [STORE key] [STOREDIST key]
    GEO RADIUS_RO 3.2.10 GEORADIUS_RO key longitude latitude radius <M | KM | FT | MI> [WITHCOORD] [WITHDIST] [WITHHASH] [COUNT count [ANY]] [ASC | DESC]
    GEORADIUS BYMEMBER 3.2.0 GEORADIUSBYMEMBER key member radius <M | KM | FT | MI> [WITHCOORD] [WITHDIST] [WITHHASH] [COUNT count [ANY]] [ASC | DESC] [STORE key] [STOREDIST key]
    GEORADIUS BYMEMBER_RO 3.2.10 GEORADIUSBYMEMBER_RO key member radius <M | KM | FT | MI> [WITHCOORD] [WITHDIST] [WITHHASH] [COUNT count [ANY]] [ASC | DESC]
    GEOSEARCH 6.2.0 GEOSEARCH key <FROMMEMBER member | FROMLONLAT longitude latitude> <BYRADIUS radius <M | KM | FT | MI> | BYBOX width height <M | KM | FT | MI>> [ASC | DESC] [COUNT count [ANY]] [WITHCOORD] [WITHDIST] [WITHHASH]
    GEOSEARCH STORE 6.2.0 GEOSEARCHSTORE destination source <FROMMEMBER member | FROMLONLAT longitude latitude> <BYRADIUS radius <M | KM | FT | MI> | BYBOX width height <M | KM | FT | MI>> [ASC | DESC] [COUNT count [ANY]] [STOREDIST]

    Hash

    关键字 支持版本 命令格式
    HDEL 2.0.0 HDEL key field [field ...]
    HEXISTS 2.0.0 HEXISTS key field
    HGET 2.0.0 HGET key field
    HGETALL 2.0.0 HGETALL key
    HINCRBY 2.0.0 HINCRBY key field increment
    HINCRBYFLOAT 2.6.0 HINCRBYFLOAT key field increment
    HKEYS 2.0.0 HKEYS key
    HLEN 2.0.0 HLEN key
    HMGET 2.0.0 HMGET key field [field ...]
    HMSET 2.0.0 HMSET key field value [field value ...]
    HRANDFIELD 6.2.0 HRANDFIELD key [count [WITHVALUES]]
    HSET 2.0.0 HSET key field value
    HSETNX 2.0.0 HSETNX key field value
    HVALS 2.0.0 HVALS key
    HSCAN 2.8.0 HSCAN key cursor [MATCH pattern] [COUNT count]
    HSTRLEN 3.2.0 HSTRLEN key field

    HyperLogLog

    关键字 支持版本 命令格式
    PFADD 2.8.9 PFADD key [element [element ...]]
    PFCOUNT 2.8.9 PFCOUNT key [key ...]
    PFMERGE 2.8.9 PFMERGE destkey [sourcekey [sourcekey ...]]

    List

    关键字 支持版本 命令格式
    LINDEX 1.0.0 LINDEX key index
    LINSERT 2.2.0 LINSERT key <BEFORE | AFTER> pivot element
    LLEN 1.0.0 LLEN key
    LMOVE 6.2.0 LMOVE source destination <LEFT | RIGHT> <LEFT | RIGHT>
    LMPOP 7.0.0 LMPOP numkeys key [key ...] <LEFT | RIGHT> [COUNT count]
    LPOP 1.0.0 LPOP key [count]
    LPOS 6.0.6 LPOS key element [RANK rank] [COUNT num-matches] [MAXLEN len]
    LPUSH 1.0.0 LPUSH key element [element ...]
    LPUSHX 2.2.0 LPUSHX key element [element ...]
    LRANGE 1.0.0 LRANGE key start stop
    LREM 1.0.0 LREM key count element
    LSET 1.0.0 LSET key index element
    LTRIM 1.0.0 LTRIM key start stop
    RPOP 1.0.0 RPOP key [count]
    RPOPLPUSH 1.2.0 RPOPLPUSH source destination
    RPUSH 1.0.0 RPUSH key element [element ...]
    RPUSHX 2.2.0 RPUSHX key element [element ...]

    Set

    关键字 支持版本 命令格式
    SADD 1.0.0 SADD key member [member ...]
    SCARD 1.0.0 SCARD key
    SDIFF 1.0.0 SDIFF key [key ...]
    SDIFFSTORE 1.0.0 SDIFFSTORE destination key [key ...]
    SINTER 1.0.0 SINTER key [key ...]
    SINTERCARD 7.0.0 SINTERCARD numkeys key [key ...] [LIMIT limit]
    SINTERSTORE 1.0.0 SINTERSTORE destination key [key ...]
    SISMEMBER 1.0.0 SISMEMBER key member
    SMEMBERS 1.0.0 SMEMBERS key
    SMISMEMBER 6.2.0 SMISMEMBER key member [member ...]
    SMOVE 1.0.0 SMOVE source destination member
    SPOP 1.0.0 SPOP key [count]
    SRANDMEMBER 1.0.0 SRANDMEMBER key [count]
    SREM 1.0.0 SREM key member [member ...]
    SSCAN 2.8.0 SSCAN key cursor [MATCH pattern] [COUNT count]
    SUNION 1.0.0 SUNION key [key ...]
    SUNIONSTORE 1.0.0 SUNIONSTORE destination key [key ...]

    SortedSet

    关键字 支持版本 命令格式
    ZADD 1.2.0 ZADD key [NX | XX] [GT | LT] [CH] [INCR] score member [score member ...]
    ZCARD 1.2.0 ZCARD key
    ZCOUNT 2.0.0 ZCOUNT key min max
    ZDIFF 6.2.0 ZDIFF numkeys key [key ...] [WITHSCORES]
    ZDIFFSTORE 6.2.0 ZDIFFSTORE destination numkeys key [key ...]
    ZINCRBY 1.2.0 ZINCRBY key increment member
    ZINTER 6.2.0 ZINTER numkeys key [key ...] [WEIGHTS weight [weight ...]] [AGGREGATE <SUM | MIN | MAX>] [WITHSCORES]
    ZINTERCARD 7.0.0 ZINTERCARD numkeys key [key ...] [LIMIT limit]
    ZINTERSTORE 2.0.0 ZINTERSTORE destination numkeys key [key ...] [WEIGHTS weight [weight ...]] [AGGREGATE <SUM | MIN | MAX>]
    ZLEXCOUNT 2.8.9 ZLEXCOUNT key min max
    ZMPOP 7.0.0 ZMPOP numkeys key [key ...] <MIN | MAX> [COUNT count]
    ZMSCORE 6.2.0 ZMSCORE key member [member ...]
    ZPOPMAX 5.0.0 ZPOPMAX key [count]
    ZPOPMIN 5.0.0 ZPOPMIN key [count]
    ZRAND MEMBER 6.2.0 ZRANDMEMBER key [count [WITHSCORES]]
    ZRANGE 1.2.0 ZRANGE key start stop [BYSCORE | BYLEX] [REV] [LIMIT offset count] [WITHSCORES]
    ZRANGEBYLEX 2.8.9 ZRANGEBYLEX key min max [LIMIT offset count]
    ZRANGE BYSCORE 1.0.5 ZRANGEBYSCORE key min max [WITHSCORES] [LIMIT offset count]
    ZRANGESTORE 6.2.0 ZRANGESTORE dst src min max [BYSCORE | BYLEX] [REV] [LIMIT offset count]
    ZRANK 2.0.0 ZRANK key member [WITHSCORE]
    ZREM 1.2.0 ZREM key member [member ...]
    ZREMRANGE BYLEX 2.8.9 ZREMRANGEBYLEX key min max
    ZREMRANGE BYRANK 2.0.0 ZREMRANGEBYRANK key start stop
    ZREMRANGE BYSCORE 1.2.0 ZREMRANGEBYSCORE key min max
    ZREVRANGE 1.2.0 ZREVRANGE key start stop [WITHSCORES]
    ZREVRANGE BYLEX 2.8.9 ZREVRANGEBYLEX key max min [LIMIT offset count]
    ZREVRANGE BYSCORE 2.2.0 ZREVRANGEBYSCORE key max min [WITHSCORES] [LIMIT offset count]
    ZREVRANK 2.0.0 ZREVRANK key member [WITHSCORE]
    ZSCAN 2.8.0 ZSCAN key cursor [MATCH pattern] [COUNT count]
    ZSCORE 1.2.0 ZSCORE key member
    ZUNION 6.2.0 ZUNION numkeys key [key ...] [WEIGHTS weight [weight ...]] [AGGREGATE <SUM | MIN | MAX>] [WITHSCORES]
    ZUNIONSTORE 2.0.0 ZUNIONSTORE destination numkeys key [key ...] [WEIGHTS weight [weight ...]] [AGGREGATE <SUM | MIN | MAX>]

    Stream

    关键字 支持版本 命令格式
    XACK 5.0.0 XACK key group id [id ...]
    XAUTOCLAIM 6.2.0 XAUTOCLAIM key group consumer min-idle-time start [COUNT count] [JUSTID]
    XCLAIM 5.0.0 XCLAIM key group consumer min-idle-time id [id ...] [IDLE ms] [TIME unix-time-milliseconds] [RETRYCOUNT count] [FORCE] [JUSTID] [LASTID lastid]
    XDEL 5.0.0 XDEL key id [id ...]
    XGROUP CREATE 5.0.0 XGROUP CREATE key group <id | $> [MKSTREAM] [ENTRIESREAD entries-read]
    XGROUP CREATECONSUMER 6.2.0 XGROUP CREATECONSUMER key group consumer
    XGROUP DELCONSUMER 5.0.0 XGROUP DELCONSUMER key group consumer
    XGROUP DESTROY 5.0.0 XGROUP DESTROY key group
    XGROUP SETID 5.0.0 XGROUP SETID key group <id | $> [ENTRIESREAD entries-read]
    XINFO CONSUMERS 5.0.0 XINFO CONSUMERS key group
    XINFO GROUPS 5.0.0 XINFO GROUPS key
    XINFO STREAM 5.0.0 XINFO STREAM key [FULL [COUNT count]]
    XLEN 5.0.0 XLEN key
    XPENDING 5.0.0 XPENDING key group [[IDLE min-idle-time] start end count [consumer]]
    XRANGE 5.0.0 XRANGE key start end [COUNT count]
    XREVRANGE 5.0.0 XREVRANGE key end start [COUNT count]
    XTRIM 5.0.0 XTRIM key <MAXLEN | MINID> [= | ~] threshold [LIMIT count]

    String

    关键字 支持版本 命令格式
    APPEND 2.0.0 APPEND key value
    DECR 1.0.0 DECR key
    DECRBY 1.0.0 DECRBY key decrement
    GET 1.0.0 GET key
    GETDEL 6.2.0 GETDEL key
    GETEX 6.2.0 GETEX key [EX seconds | PX milliseconds | EXAT unix-time-seconds | PXAT unix-time-milliseconds | PERSIST]
    GETRANGE 2.4.0 GETRANGE key start end
    GETSET 1.0.0 GETSET key value
    INCR 1.0.0 INCR key
    INCRBY 1.0.0 INCRBY key increment
    INCRBYFLOAT 2.6.0 INCRBYFLOAT key increment
    LCS 7.0.0 LCS key1 key2 [LEN] [IDX] [MINMATCHLEN min-match-len] [WITHMATCHLEN]
    MGET 1.0.0 MGET key [key ...]
    MSET 1.0.1 MSET key value [key value ...]
    MSETNX 1.0.1 MSETNX key value [key value ...]
    PSETEX 2.6.0 PSETEX key milliseconds value
    SET 1.0.0 SET key value [NX | XX] [GET] [EX seconds | PX milliseconds | EXAT unix-time-seconds | PXAT unix-time-milliseconds | KEEPTTL]
    SETEX 2.0.0 SETEX key seconds value
    SETNX 1.0.0 SETNX key value
    SETRANGE 2.2.0 SETRANGE key offset value
    STRLEN 2.2.0 STRLEN key
    SUBSTR 1.0.0 SUBSTR key start end

    附录:MongoDB支持的命令列表

    Collection

    Method 语法
    aggregate() db..aggregate()
    bulkWrite() db..bulkWrite()
    compactStructuredEncryptionData() db..compactStructuredEncryptionData()
    countDocuments() db..countDocuments()
    createIndex() db..createIndex()
    createIndexes() db..createIndexes()
    dataSize() db..dataSize()
    deleteOne() db..deleteOne()
    deleteMany() db..deleteMany()
    distinct() db..distinct()
    drop() db..drop()
    dropIndex() db..dropIndex()
    dropIndexes() db..dropIndexes()
    estimatedDocumentCount() db..estimatedDocumentCount()
    explain() db..explain()
    find() db..find()
    findAndModify() db..findAndModify()
    findOne() db..findOne()
    findOneAndDelete() db..findOneAndDelete()
    findOneAndReplace() db..findOneAndReplace()
    findOneAndUpdate() db..findOneAndUpdate()
    getIndexes() db..getIndexes()
    getShardDistribution() db..getShardDistribution()
    getShardVersion() db..getShardVersion()
    hideIndex() db..hideIndex()
    insertOne() db..insertOne()
    insertMany() db..insertMany()
    isCapped() db..isCapped()
    latencyStats() db..latencyStats()
    mapReduce() db..mapReduce()
    reIndex() db..reIndex()
    remove() db..remove()
    renameCollection() db..renameCollection()
    replaceOne() db..replaceOne()
    stats() db..stats()
    storageSize() db..storageSize()
    totalIndexSize() db..totalIndexSize()
    totalSize() db..totalSize()
    unhideIndex() db..unhideIndex()
    updateOne() db..updateOne()
    updateMany() db..updateMany()
    validate() db..validate()

    Database

    Method 语法
    adminCommand() db.adminCommand()
    aggregate() db.aggregate()
    commandHelp() db.commandHelp()
    createCollection() db.createCollection()
    createView() db.createView()
    currentOp() db.currentOp()
    dropDatabase() db.dropDatabase()
    fsyncLock() db.fsyncLock()
    fsyncUnlock() db.fsyncUnlock()
    getCollection() db.getCollection()
    getCollectionInfos() db.getCollectionInfos()
    getCollectionNames() db.getCollectionNames()
    getLogComponents() db.getLogComponents()
    getMongo() db.getMongo()
    getName() db.getName()
    getProfilingStatus() db.getProfilingStatus()
    getReplicationInfo() db.getReplicationInfo()
    getSiblingDB() db.getSiblingDB()
    hello() db.hello()
    help() db.help()
    hostInfo() db.hostInfo()
    killOp() db.killOp()
    listCommands() db.listCommands()
    logout() db.logout()
    printCollectionStats() db.printCollectionStats()
    printReplicationInfo() db.printReplicationInfo()
    printSecondaryReplicationInfo() db.printSecondaryReplicationInfo()
    printShardingStatus() db.printShardingStatus()
    printSlaveReplicationInfo() db.printSlaveReplicationInfo()
    resetError() db.resetError()
    rotateCertificates() db.rotateCertificates()
    runCommand() db.runCommand()
    serverBuildInfo() db.serverBuildInfo()
    serverCmdLineOpts() db.serverCmdLineOpts()
    serverStatus() db.serverStatus()
    setLogLevel() db.setLogLevel()
    setProfilingLevel() db.setProfilingLevel()
    shutdownServer() db.shutdownServer()
    stats() db.stats()
    version() db.version()

    Query Plan Cache

    Method 语法
    getPlanCache() db..getPlanCache()
    PlanCache.clear() PlanCache.clear()
    PlanCache.clearPlansByQuery() PlanCache.clearPlansByQuery()
    PlanCache.help() PlanCache.help()
    PlanCache.list() PlanCache.list()

    Bulk Write Operation

    Method 语法
    initializeOrderedBulkOp() db..initializeOrderedBulkOp()
    initializeUnorderedBulkOp() db..initializeUnorderedBulkOp()
    Bulk() Bulk()
    Bulk.execute() Bulk.execute()
    Bulk.find() Bulk.find()
    Bulk.find.arrayFilters() Bulk.find.arrayFilters()
    Bulk.find.collation() Bulk.find.collation()
    Bulk.find.delete() Bulk.find.delete()
    Bulk.find.deleteOne() Bulk.find.deleteOne()
    Bulk.find.hint() Bulk.find.hint()
    Bulk.find.remove() Bulk.find.remove()
    Bulk.find.removeOne() Bulk.find.removeOne()
    Bulk.find.replaceOne() Bulk.find.replaceOne()
    Bulk.find.updateOne() Bulk.find.updateOne()
    Bulk.find.update() Bulk.find.update()
    Bulk.find.upsert() Bulk.find.upsert()
    Bulk.getOperations() Bulk.getOperations()
    Bulk.insert() Bulk.insert()
    Bulk.toJSON() Bulk.toJSON()
    Bulk.toString() Bulk.toString()

    User Management

    Method 语法
    auth() db.auth()
    changeUserPassword() db.changeUserPassword()
    createUser() db.createUser()
    dropUser() db.dropUser()
    dropAllUsers() db.dropAllUsers()
    getUser() db.getUser()
    getUsers() db.getUsers()
    grantRolesToUser() db.grantRolesToUser()
    removeUser() db.removeUser()
    revokeRolesFromUser() db.revokeRolesFromUser()
    updateUser() db.updateUser()
    passwordPrompt() passwordPrompt()

    Role Management

    Method 语法
    createRole() db.createRole()
    dropRole() db.dropRole()
    dropAllRoles() db.dropAllRoles()
    getRole() db.getRole()
    getRoles() db.getRoles()
    grantPrivilegesToRole() db.grantPrivilegesToRole()
    revokePrivilegesFromRole() db.revokePrivilegesFromRole()
    grantRolesToRole() db.grantRolesToRole()
    revokeRolesFromRole() db.revokeRolesFromRole()
    updateRole() db.updateRole()

    Replication

    Method 语法
    rs.add() rs.add()
    rs.addArb() rs.addArb()
    rs.conf() rs.conf()
    rs.freeze() rs.freeze()
    rs.help() rs.help()
    rs.initiate() rs.initiate()
    rs.printReplicationInfo() rs.printReplicationInfo()
    rs.printSecondaryReplicationInfo() rs.printSecondaryReplicationInfo()
    rs.printSlaveReplicationInfo() rs.printSlaveReplicationInfo()
    rs.reconfig() rs.reconfig()
    rs.remove() rs.remove()
    rs.status() rs.status()
    rs.stepDown() rs.stepDown()
    rs.syncFrom() rs.syncFrom()

    Sharding

    Method 语法
    sh.abortReshardCollection() sh.abortReshardCollection()
    sh.addShard() sh.addShard()
    sh.addShardTag() sh.addShardTag()
    sh.addShardToZone() sh.addShardToZone()
    sh.addTagRange() sh.addTagRange()
    sh.balancerCollectionStatus() sh.balancerCollectionStatus()
    sh.commitReshardCollection() sh.commitReshardCollection()
    sh.disableBalancing() sh.disableBalancing()
    sh.enableBalancing() sh.enableBalancing()
    sh.disableAutoSplit() sh.disableAutoSplit()
    sh.enableAutoSplit() sh.enableAutoSplit()
    sh.enableSharding() sh.enableSharding()
    sh.getBalancerState() sh.getBalancerState()
    sh.removeTagRange() sh.removeTagRange()
    sh.removeRangeFromZone() sh.removeRangeFromZone()
    sh.help() sh.help()
    sh.isBalancerRunning() sh.isBalancerRunning()
    sh.moveChunk() sh.moveChunk()
    sh.removeShardTag() sh.removeShardTag()
    sh.removeShardFromZone() sh.removeShardFromZone()
    sh.reshardCollection() sh.reshardCollection()
    sh.setBalancerState() sh.setBalancerState()
    sh.shardCollection() sh.shardCollection()
    sh.splitAt() sh.splitAt()
    sh.splitFind() sh.splitFind()
    sh.startBalancer() sh.startBalancer()
    sh.status() sh.status()
    sh.stopBalancer() sh.stopBalancer()
    sh.waitForBalancer() sh.waitForBalancer()
    sh.waitForBalancerOff() sh.waitForBalancerOff()
    sh.waitForPingChange() sh.waitForPingChange()
    sh.updateZoneKeyRange() sh.updateZoneKeyRange()
    convertShardKeyToHashed() convertShardKeyToHashed()

    Constructors

    Method 语法
    BinData() BinData()
    BulkWriteResult() BulkWriteResult()
    Date() Date()
    ObjectId() ObjectId()
    ObjectId.getTimestamp() ObjectId.getTimestamp()
    ObjectId.toString() ObjectId.toString()
    ObjectId.valueOf() ObjectId.valueOf()
    UUID() UUID()
    WriteResult() WriteResult()
    WriteResult.hasWriteError() WriteResult.hasWriteError()
    WriteResult.hasWriteConcernError() WriteResult.hasWriteConcernError()
    上一篇
    数据生成
    下一篇
    SQL任务