1. Sitecore CLIコマンド参照

CLI itemresコマンド

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

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

Sitecore Items as Resourcesプラグインにはitemresコマンドが含まれています。このコマンドは、設定可能なオプションを持つリソースファイル内にアイテムパッケージを作成します。

Items as Resourcesプラグインをインストールするには、以下のコードを実行します。

dotnet sitecore plugin add -n Sitecore.DevEx.Extensibility.ResourcePackage --version <version>

使用例

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

dotnet sitecore itemres [subcommand] [options]

サブコマンド

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

  • create - リソースパッケージを作成すること。

  • unicorn - ユニコーンリソースパッケージを作成すること。

  • cleanup - .datファイルに含まれるデータベース項目を、両方のエントリの項目データが等しい場合にクリーンアップします。このサブコマンドはCLI 4.1以降で利用可能です。

createサブコマンド

createサブコマンドは新しいアイテムおよびリソースパッケージを作成します。CLIはこのパッケージを慣例items.{databaseName}.{providedName}.datに基づいて名前付けします。

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

オプション

概要

-o, --output <OUTPUT>

必須。

パッケージから出力へのパス(提供されていない場合は拡張を追加します)。

--overwrite <OVERWRITE>

既存のパッケージを上書きします。

-i, --include <INCLUDE>

モジュール構成を含めてください。ワイルドカードや複数の値を許容しています。

-e, --exclude <EXCLUDE>

モジュール構成は明示的に除外してください。ワイルドカードや複数の値を許容しています。

-c, --config <CONFIG>

ルートsitecore.configディレクトリへのパス。

デフォルト:現在の作業ディレクトリ。

-v, --verbose

追加の診断およびパフォーマンスデータを報告してください。

-t, --trace

追加の診断およびパフォーマンスデータを報告してください。

-?, -h, --help

コマンドの助けを。

以下はcreateサブコマンドの使用例です。

指揮

結果

dotnet sitecore itemres create -o TestPackage

items.{databaseName}.TestPackage.datファイルを作成します。ファイルにはすべてのモジュールが含まれています。

dotnet sitecore itemres create -o test/TestPackage

testフォルダ内にitems.{databaseName}.TestPackage.datファイルを作成します。ファイルにはすべてのモジュールが含まれています。

重複した名前でTestPackageを作成しようと試みてください:

dotnet sitecore itemres create -o TestPackage

パッケージを作成せず、以下のメッセージが表示されます:

"The output path items.{databaseName}.TestPackage.dat already existed, but Overwrite was false."

重複した名前でTestPackageを作成しようと試みてください:

dotnet sitecore itemres create -o TestPackage --overwrite

パッケージを作成して上書きします。

dotnet sitecore itemres create -o TestPackage -i Project.Content.Test

パッケージを作成し、Project.Content.Testモジュールのみを含みます。

dotnet sitecore itemres create -o TestPackage -i Project.Content.Test, Project.Content

パッケージを作成し、Project.Content.TestモジュールとProject.Contentモジュールのみを含みます。

dotnet sitecore itemres create -o TestPackage -i *Test

パッケージを作成し、Project.Content.Testモジュールのみを含みます。ワイルドカード接頭辞で検出されます。

dotnet sitecore itemres create -o TestPackage -i *Test*

パッケージを作成し、Project.Content.TestモジュールとProject.Content.Test1モジュールのみを含みます。周囲のワイルドカードとともに見られます。

dotnet sitecore itemres create -o TestPackage -i Project*

パッケージを作成し、Project.Content、Project.Content.Test、Project.Content.Test1モジュールを含みます。ワイルドカード接尾辞付きで見られます。

dotnet sitecore itemres create -o TestPackage -e Project.Content.Test

パッケージを作成し、Project.Content.Testモジュールを除くProject.ContentとProject.Content.Test1モジュールのみを含みます。

dotnet sitecore itemres create -o TestPackage -e Project.Content.Test, Project.Content

パッケージを作成し、Project.ContentモジュールとProject.Content.Testモジュールを除き、Project.Content.Test1モジュールのみを含みます。

dotnet sitecore itemres create -o TestPackage -e *Test

パッケージを作成し、Project.ContentとProject.Content.Test1モジュールのみを含みます。ワイルドカード接頭辞の付いたProject.Content.Testモジュールは除外されます。

dotnet sitecore itemres create -o TestPackage -e *Test*

パッケージを作成し、Project.Contentモジュールのみを含みます。 Project.Content.TestおよびProject.Content.Test1モジュールを除外し、周辺のワイルドカードは除外します。

dotnet sitecore itemres create -o TestPackage -e Project*

パッケージを作成し、Project.Content、Project.Content.Test 、Project.Content.Test1モジュールをワイルドカード接尾辞で除外します。

dotnet sitecore itemres create -o TestPackage -i Project* -e Project.Content.Test

パッケージを作成し、ワイルドカード接尾辞付きのProject.ContentおよびProject.Content.Test1モジュールを含み、Project.Content.Testモジュールを除外します。

dotnet sitecore itemres create -o TestPackage -i Project.Content.Test -e Project.Content.Test

パッケージを作成せず、以下のメッセージが表示されます:

The include and exclude options contain the same modules at the same time

samplesフォルダからTestPackageを作成しようと試みてください:

dotnet sitecore itemres create -o TestPackage

パッケージを作成せず、以下のメッセージが表示されます:

error: Couldn't resolve a root configuration file (sitecore.json) in the current or any parent directory. Looks like the command might have been executed outside a Sitecore project?

samplesフォルダからTestPackageを作成しようと試みてください:

dotnet sitecore itemres create -o TestPackage -c Prototype/

samplesフォルダにパッケージを作成します。

dotnet sitecore itemres create -o TestPackage -v

ルート設定パスやパフォーマンスを持つノード数(例えば73ms(8.1ms/node)など、追加の診断およびパフォーマンスデータを作成します。

dotnet sitecore itemres create -o TestPackage -t

追加の診断およびパフォーマンスデータを作成します。例えばFSIndex:ファイルシステムのインデックスを70ms(9メタデータ)で読み込み、1ツリーのパッケージを作成した場合(例えば1983ms、9項目、220.3ms/node)で作成されます。

ユニコーン副司令部

unicornサブコマンドはUnicornシリアライズから特定の名前フォーマットitems.{databaseName}.{providedName}.datで新しいアイテムおよびリソースパッケージを作成します。

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

オプション

概要

-p, --path <INCLUDE>

必須。

ユニコーン・シリアライズへの道。

-o, --output <OUTPUT>

必須。

パッケージから出力へのパス(提供されていない場合は拡張を追加します)。複数の値を設定できます。

--overwrite <OVERWRITE>

既存のパッケージを上書きします。

-c, --config <CONFIG>

ルートsitecore.configディレクトリへのパス。

デフォルト:現在の作業ディレクトリ。

-v, --verbose

追加の診断およびパフォーマンスデータを報告してください。

-t, --trace

追加の診断およびパフォーマンスデータを報告してください。

-?, -h, --help

コマンドの助けを。

以下はunicornサブコマンドの使用例です。

指揮

結果

dotnet sitecore itemres unicorn -p "testItem" -o "TestPackage

items.{databaseName}.TestPackage.datファイルを作成します。

清掃小隊

cleanupサブコマンドは、両方のエントリの項目データが等しい場合に、.datファイルのデータベース項目を整理します。

警告

このコマンドはキャッシュの完全なクリーンアップを引き起こし、パフォーマンス低下を引き起こすことがあります。メンテナンス期間中に実行すべきです。

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

オプション

概要

-f, --force

フィールド比較なしでアイテムの強制清掃。バージョン5.1.28から利用可能。

-w, --what-if

アイテムを削除せずにアイテムの整理をシミュレートします。バージョン5.1.28から利用可能。

ヒント

このオプションは、アイテムが上書きされるかどうかを判断し、保管場所を特定するために使えます。

-p,--path

SitecoreのアイテムパスまたはGUIDでクリーンアップできます。 --forceまたは --what-ifオプションを使う場合、Sitecore 10.3で必須です。

-r,--recurse

指定された経路内のすべてのアイテムを再帰的にクリーンアップします。

-c, --config <CONFIG>

sitecore.json設定ファイルへのパス。

デフォルト: cwd。

-n, --environment-name <ENVIRONMENT_NAME>

使用予定のSitecore環境。

デフォルト: 'default'。

-v, --verbose

追加の診断およびパフォーマンスデータを報告してください。

-t, --trace

追加の診断およびパフォーマンスデータを報告してください。

-?, -h, --help

コマンドの助けを。

以下の表はcleanupサブコマンドの使用例を示しています:

指揮

結果

dotnet sitecore itemres cleanup

出力:

Starting cleaning up databases. 
Processing...
Cleaning up databases is finished:
Cleanup of resource items is finished for 'master' database. Removed: 13 item(s).
Cleanup of resource items is finished for 'core' database. Removed: 3 item(s).

dotnet sitecore itemres cleanup --force

出力:

Starting cleaning up databases.
Processing...
Cleaning up databases is finished:
Cleanup of resource items is finished for 'master' database. Removed: 1 item(s).
[master] [D] /sitecore/content/item1 (3d8f6795-1c4e-462d-8a81-be27b1aec5bd)
Cleanup of resource items is finished for 'core' database. Removed: 1 item(s).
[core] [D] /sitecore/content/item1 (3d8f6795-1c4e-462d-8a81-be27b1aec5bd)

dotnet sitecore itemres cleanup --what-if

出力:

What if mode is active. No changes will be made.
Starting cleaning up databases.
Processing...
Cleaning up databases is finished:
Cleanup of resource items is finished for 'master' database. Removed: 1 item(s).
[master] [D] /sitecore/content/ItemResCleanUpContent (6f0a7dcd-5a69-409f-bf58-8ee64eda4515)
Cleanup of resource items is finished for 'core' database. Removed: 0 item(s).

dotnet sitecore itemres cleanup --path /sitecore/content/ItemResCleanUpContent --force

出力:

Starting cleaning up databases.
Processing...
Cleaning up databases is finished:
Cleanup of resource items is finished for 'master' database. Removed: 1 item(s).
[master] [D] /sitecore/content/ItemResCleanUpContent (6f0a7dcd-5a69-409f-bf58-8ee64eda4515)
Cleanup of resource items is finished for 'core' database. Removed: 0 item(s).
この記事を改善するための提案がある場合は、 お知らせください!