BDB XML shell有一个内置的帮助工具,只需在命令行输入help:
help
执行成功如下所示:
Command Summary
# - 注释. 不做任何操作
abort - 放弃当前的事务
addAlias - 将别名添加到默认容器
addIndex -将索引添加到默认容器
commit - 提交当前事务然后开始一个新的事务
compactContainer - 压缩容器以缩小其尺寸
contextQuery - 使用最后结果作为上下文项执行查询表达式
cquery - 在默认容器的上下文中执行表达式
createContainer - 创建一个新容器,该容器将成为默认容器
debug - 调试给定的查询表达式或默认的预解析查询
debugOptimization - 调试优化命令 - 仅供内部使用
delIndex - 从默认容器中删除索引
echo - 原文输出
getDocuments - 从默认容器中按名称获取文档
getMetaData - 从指定文档中获取元数据项
help - 打印帮助信息。 使用'help commandName'获取扩展帮助
info - 获取默认容器的信息
listIndexes - 列出默认容器中的所有索引
lookupEdgeIndex - 在默认容器中执行边缘索引查找
lookupIndex -在默认容器中执行索引查找
lookupStats - 在默认容器上查找索引统计信息
openContainer - 打开容器,并将其用作默认容器
preload - 预加载(打开)容器
prepare - 准备给定的查询表达式作为默认的预解析查询
print - 打印最新结果,可选择打印到文件
putDocument - 将文档插入默认容器
query - 执行给定的查询表达式或默认的预解析查询
queryPlan - 打印指定查询表达式的查询计划
quit - 退出程序
reindexContainer - 重新索引容器,可选择更改索引类型
removeAlias - 从默认容器中删除别名
removeContainer - 删除容器
removeDocument - 从默认容器中删除文档
run - 将给定文件作为脚本运行
setAutoIndexing - 设置默认容器的自动索引状态
setBaseUri - 在默认上下文中set/get基本uri
setIgnore - 告诉shell忽略脚本错误
setLazy - 在默认上下文中设置延迟评估的开启或关闭
setMetaData - 在指定文档上设置元数据项
setNamespace - 在默认上下文中创建前缀 - >命名空间绑定
setProjection - 启用或禁用文档投影优化的使用
setQueryTimeout - 在默认上下文中以秒为单位设置查询超时
setReturnType - 在默认上下文中设置返回类型
setTypedVariable - 在默认上下文中将变量设置为指定的类型
setVariable - 在默认上下文中设置变量
setVerbose - 设置此shell的详细程度
sync - 将当前容器同步到磁盘
time - 在定时器中包装命令
transaction - 为要使用的所有后续操作创建事务
upgradeContainer -将容器升级到当前容器格式
verifyContainer - 验证容器是否为当前容器格式
要获取额外更详细的帮助,比如想查看创建容器的详细语法
命令行输入如下:
help createContainer
执行成功如下所示:
帮助文本包含有关命令的有用信息以及用于实现特定命令的API调用。
这有助于您找到API文档的相关部分,其中提供了更多详细信息,还可以用作以交互方式探索API调用的常用子集的方法。
debug命令为XQueries提供调试工具。 但是,它目前仅对深入了解查询计划的开发人员有用。 也就是说,您可以输入以下命令来试用调试器:
debug xquery 其中xquery是您要调试的查询。 (XQueries将在本手册的下一章中介绍)。
进入调试器后,您可以使用help命令获取特定于调试器的帮助。 使用step命令在查询计划中前进一条指令。 使用run执行查询计划的其余部分。