cpdctl wx-data コマンドの使用法と例に関する追加情報

このトピックでは、 cpdctl wx-data のコマンドラインインターフェイス（CLI）のいくつかの使用シナリオガイダンスを提供し、さまざまなコマンドとその実用的な例を取り上げます。 cpdctl は IBM® watsonx.data リソースを管理する方法を提供するが、いくつかの例では、実行を成功させるためにプラットフォーム固有の調整が必要である。 このトピックでは、特にWindowsを使用しているユーザーが、提供されている例を自分のオペレーティングシステムに合わせて修正する必要がある主要なシナリオを紹介します。 さらに、JSON形式のキー・バリュー・ペアがこれらのコマンドでどのように利用されるかを明確にし、Windowsユーザーに必要なフォーマットについて概説している。

このトピックのすべての例は、「wx-dataコマンド --help(-h)" の使用方法」セクションで説明されているヘルプコマンドを使用して取得した例に基づいて参照されています。

シナリオ1：ライン継続または新規ライン入力

macOS および Linux: コマンドのヘルプ例で使用されるバックスラッシュ ( ) 文字は、複数行の コマンドで行の継続を示すために使用される。 cpdctl wx-data``\ cpdctl これにより、複雑なコマンドオプションを指定する際の可読性が向上する。

./cpdctl wx-data engine attach \
    --id presto785 \
    --catalog-names icebergCatalog \
    --name presto \
    --instance-id 1234567890

Windows： Windowsのコマンドプロンプトと PowerShell は、行の継続のためのバックスラッシュ(◆)を同じようにサポートしていません。 ユーザーはコマンド全体を1行で記述しなければならない。

cpdctl wx-data engine attach --id presto785 --catalog-names icebergCatalog --name presto --instance-id 1234567890

シナリオ2：コマンド・オプションのJSONキー・バリュー・ペア

cpdctl wx-dataコマンドにJSON形式のオプションを入力するには、以下の2つの方法があります：

このシナリオで提供されている例は、説明目的のみのためにCreate --help の出力から一部抜粋したものです。

  • 多くのcpdctl wx-dataコマンドは、JSON形式のキー・バリュー・ペアを利用して、複雑なコマンド群を1つのセットで指定します。 これらのJSON文字列は、ヘルプの例にあるように、コマンドラインに直接組み込むことができる。

    --associated-catalog '{
    "catalog_name": "hivecos",
    "catalog_tags": ["tag_1", "tag_2"],
    "catalog_type": "hive-hadoop2"
  }'

  • cpdctl CLI --help 出力のOPTIONSは、JSONキー・バリュー・ペアの1行の選択肢を示す。

    --associated-catalog-name "hivecos" --associated-catalog-tags ["tag_1", "tag_2"] --associated-catalog-type "hive-hadoop2"

シナリオ3：異なるオペレーティング・システムにおけるJSONキー・バリュー・ペアの使用フォーマット

macOS および Linux: および で JSON フォーマットのキー・バリュー・ペアを使用する場合、 のサンプル・フォーマットをそのまま使用することができます。 macOS Linux --help

--associated-catalog '{
    "catalog_name": "hivecos",
    "catalog_tags": ["tag_1", "tag_2"],
    "catalog_type": "hive-hadoop2"
  }'

Windows： WindowsでJSON形式のキーと値のペアを使用する場合、コマンドプロンプトと PowerShell's の引用符の処理に合わせて書式を調整する必要があります。

  • Windowsコマンドプロンプト：JSON文字列を囲む一重引用符(')を二重引用符(")に置き換え、内部の二重引用符(")をすべてバックスラッシュ(∕)でエスケープする必要があります。

    --associated-catalog "{\"catalog_name\": \"hivecos\", \"catalog_tags\": [\"tag_1\", \"tag_2\"], \"catalog_type\": \"hive-hadoop2\"}"

  • Windows PowerShell: すべての内部二重引用符(")はバックスラッシュ( ")でエスケープされなければならない。

    --associated-catalog '{\"catalog_name\": \"hivecos\", \"catalog_tags\": [\"tag_1\", \"tag_2\"], \"catalog_type\": \"hive-hadoop2\"}'

シナリオ4: および tablemaint コマンド sparkjob における検証失敗 --api-key の回避策

一部の特殊なケースでは、 --api-key フラグが tablemaintsparkjob create` `およびコマンドで使用時に検証に失敗する場合、代わりに隠しフラグ`` --en-apikey を使用してエンコード済みのAPIキーを手動で提供できます。

ソフトウェアの watsonx.data デプロイメントには、以下の形式を使用してください --en-apikey "ZenApiKey <Encoded_API_Key>"

エンコードされたキーを作成します：

echo -n "username:<CPD_API_KEY>" | base64

デプロイメント watsonx.dataSaaS では、次の形式を使用してください --en-apikey "Basic <Encoded_API_Key>"

エンコードされたキーを作成します：

echo -n "ibmlhapikey_<username>:<SAAS_API_KEY>" | base64