Oak-run.jar索引用例 oak-run-jar-indexing-use-cases

Oak-run支持在命令行上索引用例，而无需通过AEM JMX控制台协调这些用例的执行。

使用oak-run.jar index命令方法管理Oak索引的总体优势包括：

以下各节将提供示例命令。 Oak-run索引命令支持所有NodeStore和BlobStore设置。 以下提供的示例介绍了具有FileDataStore和SegmentNodeStore的设置。

用例1 — 索引一致性检查 usercase1indexconsistencycheck

这是一个与索引损坏相关的用例。 有时无法确定哪些索引已损坏。 因此，Adobe提供了以下工具：

可以通过以下方式检查损坏的索引 --index-consistency-check 操作：

java -jar oak-run*.jar index --fds-path=/path/to/datastore  /path/to/segmentstore/ --index-consistency-check

这会在中生成报表 indexing-result/index-consistency-check-report.txt. 有关示例报表，请参阅下文：

Valid indexes :
        - /content/oak:index/enablementResourceName
        - /oak:index/cqProjectLucene
        - /oak:index/cqTagLucene
        - /oak:index/lucene
        - /oak:index/ntBaseLucene
        - /oak:index/socialLucene
    Invalid indexes :
        - /oak:index/atDamIndex
        - /oak:index/atIndex
        - /oak:index/cqPageLucene
        - /oak:index/damAssetLucene
        - /oak:index/groups
        - /oak:index/slingeventJob
        - /oak:index/users
        - /oak:index/workflowDataLucene
    Ignored indexes as these are not of type lucene:
        - /oak:index/acPrincipalName
        - /oak:index/active

好处 uc1benefits

现在，支持人员和系统管理员可以使用此工具快速确定哪些索引已损坏，然后重新为其编制索引。

用例2 — 索引统计数据 usecase2indexstatistics

为了诊断一些与查询性能Adobe相关的案例，通常需要现有的索引定义，即来自客户设置的与索引相关的统计数据。 到目前为止，此信息分散于多种资源。 为了更便于故障排除，Adobe创建了工具，该工具将：

现在，可以通过以下操作索引命令完成上述操作：

请参见下面的命令在实践中的工作方式示例：

java -jar oak-run*.jar index --fds-path=/path/to/datastore  /path/to/segmentstore/ --index-info --index-definitions --index-dump

报告将生成于 indexing-result/index-info.txt 和 indexing-result/index-definitions.json

此外，通过Web控制台提供相同的详细信息，这些详细信息将包含在配置转储zip中。 可在以下位置访问它们：

https://serverhost:serverport/system/console/status-oak-index-defn

好处 uc2benefits

此工具能够快速收集与索引或查询问题相关的所有所需详细信息，并减少提取此信息所花费的时间。

用例3 — 重新索引 usecase3reindexing

根据 方案有时必须执行重新索引。 目前，重新索引是通过设置 reindex 标记到 true 在索引定义节点中，通过CRXDE或通过Index Manager用户界面。 设置标记后，将异步完成重新索引。

关于重新索引需要注意以下几点：

为了实现这些目标，oak-run索引工具支持根据需要使用的不同重新索引模式。 oak-run index命令具有以下优点：

重新索引 — DocumentNodeStore reindexdocumentnodestore

对象 DocumentNodeStore 安装可通过单个oak-run命令执行重新索引：

java -jar oak-run*.jar index --reindex --index-paths=/oak:index/lucene --read-write --fds-path=/path/to/datastore mongodb://server:port/aem

这提供了以下好处

重新索引 — SegmentNodeStore reindexsegmentnodestore

对象 SegmentNodeStore 安装可通过以下方式之一重新编制索引：

联机重新索引 — SegmentNodeStore onlinereindexsegmentnodestore

遵循通过设置完成重新索引的既定方式 reindex 标志。

联机重新索引 — SegmentNodeStore - AEM实例正在运行 onlinereindexsegmentnodestoretheaeminstanceisrunning

对象 SegmentNodeStore 安装时，只有一个进程能够以读写模式访问区段文件。 因此，Oak-run索引中的一些操作需要执行额外的手动步骤。

这将涉及以下内容：

在此方案中，您不必停止AEM服务器或配置任何新实例。 但是，由于索引涉及遍历整个存储库，这会增加安装上的I/O负载，从而对运行时性能产生负面影响。

联机重新索引 — SegmentNodeStore - AEM实例已关闭 onlinereindexsegmentnodestoreaeminstanceisdown

对象 SegmentNodeStore 安装，可通过单个oak-run命令完成重新索引。 但是，必须关闭AEM实例。

您可以使用以下命令触发重新索引：

java -jar oak-run*.jar index --reindex --index-paths=/oak:index/lucene --read-write --fds-path=/path/to/datastore  /path/to/segmentstore/

这种方法与上面解释的方法的不同之处在于，检查点创建和索引导入会自动完成。 不利的一面是，AEM在此过程中必须停机。

带外重新索引 — SegmentNodeStore outofbandreindexsegmentnodestore

在此使用案例中，您可以对克隆的设置执行重新索引，以将对正在运行的AEM实例的影响降至最低：

在此使用案例中，假定数据存储可在其他实例上访问，如果 FileDataStore 位于基于云的存储解决方案（如EBS）上。 这不包括以下场景 FileDataStore 也进行了克隆。 如果索引定义不执行全文索引，则访问 DataStore 非必填。

用例4 — 更新索引定义 usecase4updatingindexdefinitions

目前，您可以通过以下方式传送索引定义更改 ACS确保索引 包。 这允许通过内容包来传送索引定义，此后需要通过设置来执行重新索引 reindex 标记到 true.

对于重新索引不需要很长的时间的较小安装，此方法非常有效。 但是，对于大型存储库，重新索引需要花费大量时间。 对于这种情况，我们现在可以使用oak-run索引工具。

Oak-run现在支持以JSON格式提供索引定义，并支持在带外模式下创建索引，在这种模式下，不会对实时实例执行任何更改。

对于此用例，需要考虑的流程是：