Sitecore Command Line Interface参照

CLIインデックスコマンド

日本語翻訳に関する免責事項

このページの翻訳はAIによって自動的に行われました。可能な限り正確な翻訳を心掛けていますが、原文と異なる表現や解釈が含まれる場合があります。正確で公式な情報については、必ず英語の原文をご参照ください。

Sitecoreインデックスプラグインにはindexコマンドが含まれています。このコマンドはインデックス作成操作を自動化します。インデックスプラグインをインストールするには、以下のコードを実行します:

dotnet sitecore plugin add -n Sitecore.DevEx.Extensibility.Indexing

使用例

コマンドの使い方は以下の通りです:

dotnet sitecore index [subcommand] [options]

サブコマンド

以下のサブコマンドを使用できます:

list - 環境から利用可能なインデックスのリストを提供します。
schema-populate - 管理スキーマを埋め込む。
rebuild - すべてのインデックスを再構築する。
statistic - すべての指数の統計を表示します。

すべてのサブコマンドは権限要求が高い権限を必要とします。

リストサブコマンド

listサブコマンドは環境から利用可能なインデックスのリストを提供します。

listサブコマンドで以下のオプションを使用できます:

オプション	必須	概要
-n, --environment-name <environment-name>	オプション	Sitecore環境の利用。デフォルト: default。
-c, --config <CONFIG>	オプション	ルートディレクトリへのパスsitecore.config (デフォルト:cwd)。
-v, --verbose	オプション	追加の診断およびパフォーマンスデータを報告してください。
-t, --trace	オプション	追加の診断およびパフォーマンスデータを報告してください。
-?, -h, --help	オプション	コマンドの助けを。

例えば：

dotnet sitecore index list

コマンドの出力は利用可能なインデックスを示します:

Indexes list:
sitecore_core_index
sitecore_master_index
sitecore_horizon_index

スキーマ・ポピュレートサブコマンド

schema-populateサブコマンドは管理スキーマに割り当てられます。

schema-populateサブコマンドで以下のオプションを使用できます:

オプション	必須	概要
-i, --indexes <list-of-indexes>	オプション	指定されたインデックスのスキーマを埋めます。
-n, --environment-name <environment-name>	オプション	Sitecore環境の利用。デフォルト: default。
-c, --config <CONFIG>	オプション	ルートディレクトリへのパスsitecore.config (デフォルト:cwd)。
-v, --verbose	オプション	追加の診断およびパフォーマンスデータを報告してください。
-t, --trace	オプション	追加の診断およびパフォーマンスデータを報告してください。
-?, -h, --help	オプション	コマンドの助けを。

コマンドを使って特定のインデックスやすべてのインデックスを入力できます。

例えば、単一のインデックスを埋めるには、-iオプションを使ってそのインデックス名を指定します:

dotnet sitecore index schema-populate -i sitecore_master_index

プロセスが完了すると、結果が表示されます:

The search indexes have been populated.

Result:
sitecore_master_index [job ended]

インデックスを指定せずにコマンドを実行すると、管理スキーマ内のすべてのインデックスが埋め込まれます。例えば：

dotnet sitecore index schema-populate

プロセスが完了すると、埋め込まれたインデックスが表示されます:

The search indexes have been populated.

Result:
sitecore_core_index   [job ended] 
sitecore_master_index [job ended]

再構築サブコマンド

rebuildサブコマンドはすべてのインデックスを再構築します。

rebuildサブコマンドで以下のオプションを使用できます:

オプション	必須	概要
-i, --indexes <list-of-indexes>	オプション	指定されたインデックスを再構築します。
-n, --environment-name <environment-name>	オプション	Sitecore環境の利用。デフォルト: default。
-c, --config <CONFIG>	オプション	ルートディレクトリへのパスsitecore.config (デフォルト:cwd)。
-v, --verbose	オプション	追加の診断およびパフォーマンスデータを報告してください。
-t, --trace	オプション	追加の診断およびパフォーマンスデータを報告してください。
-?, -h, --help	オプション	コマンドの助けを。

コマンドを使って特定のインデックスやすべてのインデックスを再構築できます。

例えば、単一のインデックスを再構築するには、-iオプションを使ってインデックス名を指定します。

dotnet sitecore index rebuild -i sitecore_master_index

プロセスが完了すると、結果が表示されます:

The search indexes have been rebuilt.

Result:
sitecore_master_index [job ended] [units processsed: 16620]

インデックスを指定せずにコマンドを実行すると、管理スキーマ内のすべてのインデックスが再構築されます。例えば：

dotnet sitecore index rebuild

プロセス終了時には、再構築されたインデックスと処理済みユニット数が表示されます。

The search indexes have been rebuilt.

Result:
sitecore_core_index   [job ended] [units processsed: 13596]
sitecore_master_index [job ended] [units processsed: 16620]

統計サブコマンド

statisticサブコマンドはすべてのインデックスの統計を表示します。

statisticサブコマンドで以下のオプションを使用できます:

オプション	必須	概要
-n, --environment-name <environment-name>	オプション	Sitecore環境の利用。デフォルト: default。
-c, --config	オプション	ルートディレクトリへのパスsitecore.config (デフォルト:cwd)。
-t, --trace	オプション	追加の診断およびパフォーマンスデータを報告してください。
-?, -h, --help	オプション	コマンドの助けを。

例えば、次のコマンドを実行します:

dotnet sitecore index statistic

利用可能なインデックスに関する情報を表示します:

Index statistics:
 sitecore_core_index
  Rebuild Time: Never Run
  Last Updated: 08/13/2021 - 08:45 (UTC)
  Approximate Throughput: items per second
  Has Deletions: False
  Out of Date: False
  Document Count: 0
  Number of Fields: -1
  Number of Terms: -1

この記事を改善するための提案がある場合は、お知らせください!