Data Storeエクスポート

はじめに

Data Storeエクスポートコマンドの一般的な構文は以下の通りです。

JSON設定ファイルの構造

Data Storeエクスポートコマンドは、入力JSON設定ファイルで定義した条件に一致する、指定したテーブルからレコードを取得します。コマンドにJSONファイルを渡さない場合、または条件を指定しない場合、デフォルトでテーブルのすべてのレコードが読み取られます。

エクスポート操作の要件を指定するサンプルJSON設定ファイルは、コマンド実行時にオプションで渡すことができ、以下に示されています。

JSON設定ファイルでサポートされているパラメータは以下のように定義されています。

条件プロパティ

エクスポートジョブの処理状態

エクスポート操作には3つのジョブ処理状態があります。

• 進行中: インポートコマンドを実行するとすぐにジョブがこの状態に入ります。CLIはjob_idパラメータを表示し、JSONにコールバックURLを設定していない場合は、これを使用して後続のレスポンスのジョブ実行ステータスを手動で確認できます。
  
  コールバックURLを設定している場合、定義した形式でjob_idを含む状態レスポンスがURLにも送信されます。
• 成功: エクスポート操作が成功した場合、Catalystはクエリに一致するレコードを含むCSVファイルをダウンロードできるダウンロードURLを提供します。Catalystでは、CLIを通じて結果ファイルをシステムに直接ダウンロードすることもできます。コールバックURLを設定している場合、このレスポンスもURLに送信されます。
• 失敗: エクスポート操作が失敗した場合、CLIは発生したエラーの詳細を表示します。コールバックURLを設定している場合、このレスポンスもURLに送信されます。

エクスポートオプション

エクスポートコマンドの実行プロセスは、各オプションについてこのセクションで詳しく説明されています。Data Storeエクスポートコマンドは以下のオプションをサポートしています。

--config <path>

–configオプションを使用すると、システム内のJSON設定ファイルのパスを定義できます。

たとえば、以下のようにエクスポート操作を実行してJSONファイルパスを渡すことができます。

CLIは自動的にジョブの実行をスケジュールし、「進行中」としてマークします。job_idとともに実行プロセスのライブストリームを表示します。

ジョブが正常に実行された場合、CLIは結果ファイルをシステムにダウンロードするよう求めます。「y」と入力し、Enterを押してダウンロードします。

結果ファイルを含むZIPファイルがプロジェクトディレクトリにダウンロードされます。

Catalystが提供するダウンロードURLを使用して、CLIで作業していないときでも結果ファイルをダウンロードできます。APIコマンドとして実行する必要があります。

CSV結果ファイルには、エクスポートジョブクエリに一致するすべてのレコードの一覧が含まれます。

--table <name|id>

--tableオプションを使用すると、レコードを読み取るテーブルのテーブル名またはテーブルIDを指定できます。

前述の通り、JSONファイルでテーブル識別子を指定しない場合、またはコマンド実行時にJSONファイルを渡さない場合は、このオプションを使用して指定する必要があります。

Catalystは、JSONファイルで指定されたテーブルよりも、オプションで指定されたテーブルを優先します。どちらにもテーブルが指定されていない場合、CLIはコマンド実行中にエラーメッセージを表示します。

たとえば、以下の方法でテーブル識別子を指定できます。

CLIはエクスポート操作を実行し、指定されたテーブルからレコードを一括読み取りし、同じ方法で結果を提供します。

--page <page>

JSONパラメータのセクションで説明したように、テーブルから取得するレコードの範囲を示すページ値を指定できます。

たとえば、以下のコマンドを実行して200,001件目から400,000件目のレコードを取得できます。

--production

--productionオプションを使用すると、Catalystプロジェクトの本番環境でエクスポート操作を直接実行できます。このオプションを使用すると、本番環境のテーブルからレコードが一括読み取りされます。