1. Content Hubコマンドライン インターフェイス (CLI)

リソースのプル、プッシュ、比較、検証

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

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

シリアル化コマンドを使用すると、リソースをプル、プッシュ、比較、および検証できます。その後 、パッケージを作成してインストールできます

メモ

このセクションの一部の例では、--nameパラメーターにワイルドカードを含む値があります。パラメータにワイルドカードを割り当てると、リテラル値ではなくパターンに基づいてデータをターゲットにすることができます。たとえば、nameMyNamespace* を使用すると、名前がMyNamespaceで始まるすべてのリソースに影響します。

引っ張る

接続されたContent Hubインスタンスからリソースをフェッチするには、pullコマンドを使用します。作業ディレクトリは、初めてリソースをプルするときに自動的に初期化されます。

フェッチするリソースのタイプを指定するには、次の例に示すように、コマンドにパラメーターを追加します。

# Pulling all option lists
ch-cli serialization pull option-list 

# Option lists 
ch-cli serialization pull option-list -?

# Pulling option list by its name
ch-cli serialization pull option-list -n <NAME> 

# Pulling all entity definitions
ch-cli serialization pull entity-definition

# Entities
ch-cli serialization pull entity -?

# Entity definitions 
ch-cli serialization pull entity-definition -?

# Pulling an option list by its name
ch-cli serialization pull entity-definition -n <NAME> 

# Pulling an entity by id
ch-cli serialization pull entity --id <ENTITY_ID> 

# Pulling an entity by identifier
ch-cli serialization pull entity --id <ENTITY_IDENTIFIER> 

# Pulling an entity by name and definition
ch-cli serialization pull entity --name <ENTITY_NAME> --definition <ENTITY_DEFINITION_NAME> 

# Pulling all entities for an entity definition
ch-cli serialization pull entity --definition <ENTITY_DEFINITION_NAME> 

# Pulling an entity and its related entities
ch-cli serialization pull entity --name <NAME> --definition <ENTITY_DEFINITION_NAME> --include-relations
手記

id (34167など) と識別子 (asset.mae-mu-1421987など) は、別々のシステム・プロパティです。エンティティ名は、それぞれのエンティティ定義のDisplayTemplateプロパティに基づいて解決されます。DisplayTemplateプロパティに値がない場合は、エンティティ識別子がエンティティ名として使用されます。名前の競合を解決するには、名前にエンティティ識別子を追加します。

押す

接続されたContent Hubインスタンスにリソースをプッシュするには、pushコマンドを使用します。プッシュするリソースのタイプを指定するには、次の例に示すように、コマンドにパラメーターを追加します。

# Push a single option list by its name
ch-cli serialization push option-list --name <NAME> 

# Push all option lists
ch-cli serialization push option-list

# Push a single entity definition by its name
ch-cli serialization push entity-definition --name <NAME> 

# Push all entities of a certain definition
ch-cli serialization push entity --definition <DEFINITION_NAME> 

# Push all entities
ch-cli serialization push entity

比べる

diffコマンドを使用して、ローカルで使用可能なリソースとContent Hubインスタンスに存在するリソースを調べ、違いを強調表示します。デフォルトでは、出力には、エンティティが更新されたか (U)、追加されたか (A)、または削除されたか (D) の概要が表示されます。詳細な変更を確認するには、コマンドに --verboseフラグを追加します。

[U] SampleArticle
 [U] fields
  [U] id: Title
   [U] required
     false - true
  [A] id: ReleaseDate

リソースを比較するには、次のいずれかのコマンドを実行します。

# Compare all option lists
ch-cli serialization diff option-list

# Compare an option list by name
ch-cli serialization diff option-list --name <name> 

# Compare all entity definitions
ch-cli serialization diff entity-definition

# Compare an entity definition by name
ch-cli serialization diff entity-definition --name <name> 

# Compare all entities
ch-cli serialization diff entity

# Compare entities by name and definition
ch-cli serialization diff entity --name <NAME> --definition <ENTITY_DEFINITION_NAME> 

検証

CLIはYAMLファイルを検証して、たとえば、一意のID、有効なカルチャ識別子、フィールド長の制限の遵守などを確認します。

リソースの作業中であっても、リソースをローカルで検証するには、次のいずれかのコマンドを実行します。

# Validates options lists
ch-cli serialization validate option-list

# Validates entity definitions
ch-cli serialization validate entity-definition

# Validates entities
ch-cli serialization validate entity
この記事を改善するための提案がある場合は、 お知らせください!