「SequoiaDB巨杉数据库」explain()（一）

语法

query.explain( [options] )

类别

SdbQuery

描述

获取查询的访问计划。

参数

参数名	参数类型	描述	是否必填
options	BSON 对象	访问计划执行参数	否

options 参数详细说明如下：

参数名	参数类型	描述	默认值
Run	布尔型	表示是否执行访问计划。 Run 选项为 true 表示执行访问计划，获取数据和时间信息。 Run 选项为 false 表示只获取访问计划的信息，并不执行。	false
Detail	布尔型	表示是否展示更详细的访问计划，展示涉及访问计划的协调节点、数据节点及相关的上下文信息。 Detail 选项为 true 表示展示详细的访问计划。 Detail 选项为 true 时默认展示一层详细的访问计划，需要使用 Expand 选项展示所有详细的访问计划。 Detail 选项为 false 表示不展示详细的访问计划。	false
Estimate	布尔型	表示是否展示详细的访问计划中的估算部分。 Estimate 选项为 true 表示展示详细的访问计划中的估算部分。 Estimate 选项为 false 表示不展示详细的访问计划中的估算部分。 如果 Estimate 选项显式设置，Detail 自动设置为 true。	Detail 选项的值
Expand	布尔型	表示是否展示详细的访问计划中的多层信息。 Expand 选项为 true 表示展示详细的访问计划中的多层信息。 Expand 选项为 false 表示仅展示一层详细的访问计划，该层的子层将不展开。 如果 Expand 选项显式设置，Detail 自动设置为 true。	false
Flatten	布尔型	表示是否展开每个节点和每个子表的访问计划的输出结果作为一条记录。 Flatten 选项为 true 表示展开输出结果。 Flatten 选项为 false 表示不展开输出结果，并组合成数组挂在上一级节点或者主表上展示。 如果 Flatten 选项显式设置，Detail 选项和 Expand 选项自动设置为 true。	false
Filter	字符串 或者 数组	表示对估算结果（Estimate 选项）的细节进行过滤。 Filter 选项为可以选择 "None"、"Output"、"Input"、"Filter"、"All"，或者其组合数组。 Filter 选项为 [] 或者 null 表示为 "None"。 1. "None" 表示不输出估算结果的任何细节。 2. "Input" 表示输出估算结果的输入细节。 3. "Filter" 表示输出估算结果的过滤细节。 4. "Output" 表示输出估算结果的输出细节。 5. "All" 表示输出估算结果的全部细节。 如果 Filter 选项显式设置，Detail 选项和 Estimate 选项自动设置为 true。	"All"
Location	BSON 对象	表示对访问计划的结果按照数据组进行过滤，使用命令位置参数项。 Location 选项仅支持 "GroupID" 和 "GroupName" 选项。 详细见 命令位置参数。 如果 Location 选项显式设置，Detail 选项自动设置为 true。	空
SubCollections	字符串 或者 数组	表示对访问计划的结果按照子表进行过滤。 SubCollections 选项只在带有主子表的访问计划时生效。 SubCollections 选项可以选择某个子表名，或者子表名的数组，表示只显示指定子表的访问计划。 SubCollections 选项为 [] 或者 null 表示为不进行过滤。 如果 SubCollections 选项显式设置，Detail 选项自动设置为 true。	空
Search	布尔型	表示是否查看查询优化器搜索过的访问计划，并查看查询优化器选择的结果。 Search 选项为 true 表示展示查询优化器的选择过程。 Search 选项为 false 表示不展示查询优化器的选择过程。 如果 Search 选项显式设置，Detail 选项和 Expand 选项自动设置为 true。	false
Evaluate	布尔型	表示是否查看查询优化器搜索过的访问计划的计算过程。 Evaluate 选项为 true 表示展示查询优化器的计算过程。 Evaluate 选项为 false 表示不展示查询优化器的计算过程。 如果 Evaluate 选项显式设置，Detail 选项、Search 选项和 Expand 选项自动设置成 true。	false

普通的访问计划

Detail 选项为 false 时，将会展示普通的访问计划。

普通集合的访问计划信息：

字段名	类型	描述
NodeName	字符串	访问计划所在的节点的名称
GroupName	字符串	访问计划所在的节点属于的复制组的名称
Role	字符串	访问计划所在的节点的角色 1. "data" 表示数据节点 2. "coord" 表示协调节点
Name	字符串	访问计划访问的集合的名称
ScanType	字符串	访问计划的扫描方式 1. "tbscan" 表示全表扫描 2. "ixscan" 表示索引扫描
IndexName	字符串	访问计划使用的索引的名称 全表扫描时为 ""
UseExtSort	布尔型	访问计划是否使用非索引排序
Query	BSON 对象	访问计划解析后的用户查询条件
IXBound	BSON 对象	访问计划使用索引的查找范围表扫描为 null
NeedMatch	布尔型	访问计划获取记录时是否需要根据匹配符进行过滤 NeedMatch 为 false 的情况有： 1. 没有查询条件 2. 查询条件可以被索引覆盖
ReturnNum	长整型	访问计划返回记录的个数
ElapsedTime	浮点数	访问计划查询耗时（单位：秒）
IndexRead	长整型	访问计划扫描索引记录的个数
DataRead	长整型	访问计划扫描数据记录的个数
UserCPU	浮点数	访问计划用户态 CPU 使用时间（单位：秒）
SysCPU	浮点数	访问计划内核态 CPU 使用时间（单位：秒）

垂直分区中主表的访问计划信息：

字段名	类型	描述
NodeName	字符串	访问计划所在的节点的名称
GroupName	字符串	访问计划所在的节点属于的复制组的名称
Role	字符串	访问计划所在的节点的角色 1. "data" 表示数据节点 2. "coord" 表示协调节点
Name	字符串	访问计划访问的集合的名称
SubCollections	数组	访问计划垂直分区表中各子表的访问计划

垂直分区中子表的访问计划信息：

字段名	类型	描述
Name	字符串	访问计划访问的集合的名称
ScanType	字符串	访问计划的扫描方式 1. "tbscan" 表示全表扫描 2. "ixscan" 表示索引扫描
IndexName	字符串	访问计划使用的索引的名称 全表扫描时为 ""
UseExtSort	布尔型	访问计划是否使用非索引排序
Query	BSON 对象	访问计划解析后的用户查询条件
IXBound	BSON 对象	访问计划使用索引的查找范围表扫描为 null
NeedMatch	布尔型	访问计划获取记录时是否需要根据匹配符进行过滤 NeedMatch 为 false 的情况有： 1. 没有查询条件 2. 查询条件可以被索引覆盖
ReturnNum	长整型	访问计划返回记录的个数
ElapsedTime	浮点数	访问计划查询耗时（单位：秒）
IndexRead	长整型	访问计划扫描索引记录的个数
DataRead	长整型	访问计划扫描数据记录的个数
UserCPU	浮点数	访问计划用户态 CPU 使用时间（单位：秒）
SysCPU	浮点数	访问计划内核态 CPU 使用时间（单位：秒）

Note:

1. 如果集合经过 split 分布在多个复制组，访问计划会按照一组一记录的方式返回。
2. 如果查询的匹配符不能命中垂直分区的任何一个分区时，查询将不会下发到数据节点上执行，此时的访问计划将返回一个带有协调节点的虚拟访问计划。

详细的访问计划

Detail 选项为 true 时，将会展示详细的访问计划。在协调节点和数据节点上展示的详细访问计划略有不同。

访问计划的搜索过程

Search 选项为 true 时，将会展示查询优化器搜索过的访问计划，并查看查询优化器选择的结果。

返回值

返回访问计划的游标，类型为 object 。

错误

如果出错则抛异常，并输出错误信息，可以通过getLastErrMsg()获取错误信息或通过getLastError()获取错误码。 关于错误处理可以参考常见错误处理指南。

常见错误可参考错误码。

 

相关文章请点击阅读

「SequoiaDB巨杉数据库」current()