MarkLogic JS环境是否有xdmp:plan等效函数用于搜索请求分析

JS环境下的xdmp:plan等效实现 #

MarkLogic服务端JavaScript（SJS）环境原生提供了和XQuery版xdmp:plan功能完全对等的内置函数xdmp.plan()，二者入参规则、返回结构、索引分析逻辑完全一致，无需额外安装任何依赖即可直接调用。

JavaScript编写的MarkLogic查询分析方法 #

• 基础调用方式
  直接把未执行的CTS查询对象作为参数传入xdmp.plan()，就能拿到该搜索表达式被索引处理的完整预估流程，基础用法示例：

  // 构造待分析的目标查询
  const testQuery = cts.andQuery([
    cts.elementWordQuery(xs.QName("articleTitle"), "分布式数据库"),
    cts.elementRangeQuery(xs.QName("updateTime"), ">", xs.dateTime("2024-01-01T00:00:00"))
  ])
  // 生成执行计划
  const execPlan = xdmp.plan(testQuery)
  // 可直接打印、写日志或做结构化解析
  xdmp.log(execPlan)
  

• 计划结果核心判断规则
  • 先看每个查询子条件对应的indexable标识：值为true说明该条件可以被现有索引覆盖，直接通过索引匹配候选文档，性能较好；值为false说明该条件无法命中索引，需要在索引初筛后拉取文档内容做逐文档过滤，这类条件通常是性能瓶颈，需要调整查询写法或者补充对应索引。
  • 再看计划内的执行步骤节点：会明确列出命中的索引类型、候选文档预估量级、是否需要unfiltered过滤、步骤执行顺序等核心信息，字段语义和XQuery版本返回的计划完全一致，之前积累的XQuery计划判断经验可以直接复用。
  • 如果是用JSearch这类上层API写的查询（比如db.search()构造的查询），不需要重写成原生CTS写法，只要调用API的.query()方法拿到底层封装的CTS查询对象，就能直接传给xdmp.plan()做分析。
• 配套分析技巧
  xdmp.plan()返回的是查询执行前的静态预估结果，和真实运行情况可能存在偏差，可以配合两个手段做更准确的分析：
  • 用Query Console自带的Profile功能运行SJS查询，拿到实际执行时各步骤的真实耗时、索引调用次数、锁等待时长等数据，和静态计划对照排查问题。
  • 复杂查询可以配合xdmp.trace()开启执行追踪，拿到运行时的完整链路日志，定位隐蔽的性能卡点。

内容的提问来源于stack exchange，提问作者Nadia