CSV ファイルをエクスポートする

gcloud

1. Cloud Storage バケットを作成します。

2. エクスポート オペレーション用の Cloud Storage バケットに対する権限をサービス アカウントに付与します。サービス アカウントの形式を使用して、エクスポート元のプロジェクトのサービス アカウントを特定します。サービス アカウントの形式は次のとおりです。

   service-PROJECT_NUMBER@gcp-sa-alloydb.iam.gserviceaccount.com

3. gcloud storage buckets add-iam-policy-binding を使用して、storage.objectAdmin IAM ロールをサービス アカウントに付与します。IAM 権限の設定については、IAM 権限の使用をご覧ください。

4. データベースを Cloud Storage バケットにエクスポートします。

   CSV をエクスポートするコマンド（TODOgcloud alloydb clusters export）を実行します。

   CSV 形式でデータをエクスポートするためのオプションは、次の表に示すとおりです。

   • --select-query（必須）: データを抽出するために使用する select クエリ。
   • --async（省略可）: 処理中のオペレーションの完了を待たずに、直ちに戻ります。
   • --field-delimiter（省略可）: ファイルの各行の列を区切る文字を指定します。デフォルトはカンマです。この引数の値は、16 進数の ASCII コードで指定する必要があります。
   • --quote-character（省略可）: データ値を引用符で囲むときに使用する引用符文字を指定します。デフォルトは二重引用符です。この引数の値は、16 進数の ASCII コードで指定する必要があります。
   • --escape-character（省略可）: エスケープが必要なデータ文字の前に付ける文字を指定します。デフォルトは --quote-character と同じです。この引数の値は、16 進数の ASCII コードで指定する必要があります。

   これらの機能を使用するには、該当するオプションを gcloud CLI コマンドに含めます。

   使用しない機能については、該当するパラメータを次のコマンドから削除します。

   gcloud alloydb clusters export CLUSTER_NAME
     --region=REGION
     --database=DATABASE_NAME
     --gcs-uri="gs://BUCKET_NAME/OBJECT_NAME"
     --select-query=SELECT_QUERY
     --field-delimiter=FIELD_DELIMITER
     --quote-character=QUOTE_CHARACTER
     --escape-character=ESCAPE_CHARACTER
     --csv

5. 以前に設定した IAM ロールを保持する必要がない場合は、直ちに取り消します。

REST v1

1. エクスポート先のバケットを作成します。

   gcloud storage buckets create gs://BUCKET_NAME --location=LOCATION_NAME --project=PROJECT_NAME>

2. サービス アカウントの形式を使用して、エクスポート元のプロジェクトのサービス アカウントを特定します。

   サービス アカウントの形式は次のとおりです。

    service-PROJECT_NUMBER@gcp-sa-alloydb.iam.gserviceaccount.com

   この操作を行うには、Cloud Storage バケットに対してエクスポート オペレーションを行える権限が付与されている必要があります。

3. gcloud storage buckets add-iam-policy-binding を使用して、サービス アカウントに storage.objectAdminIAM ロールを付与します。IAM 権限の設定については、IAM 権限の使用をご覧ください。

4. データベースをエクスポートします。
   

   次の HTTP メソッドと URL を使用します。

   POST https://alloydb.googleapis.com/v1/projects/PROJECT_ID/locations/REGION/clusters/CLUSTER_ID:export

   リクエストのデータを使用する前に、次のように置き換えます。

   • PROJECT_ID: プロジェクト ID。
   • REGION: AlloyDB クラスタがデプロイされているリージョン。
   • CLUSTER_ID: クラスタ ID。
   • BUCKET_NAME: Cloud Storage バケット名。
   • PATH_TO_CSV_FILE: CSV ファイルのパス。
   • DATABASE_NAME: AlloyDB クラスタ内のデータベースの名前。

   • SELECT_QUERY: エクスポート用の SQL クエリ。

   • ESCAPE_CHARACTER（省略可）: エスケープが必要なデータ文字の前に付ける文字。この引数の値は、16 進数の ASCII コードで指定する必要があります。たとえば、22 は二重引用符を表します。

   • QUOTE_CHARACTER（省略可）: 文字列データ型を持つ列の値を囲む文字。この引数の値は、16 進数の ASCII コードで指定する必要があります。たとえば、22 は二重引用符を表します。

   • FIELD_DELIMITER（省略可）: 列の値を分割する文字。この引数の値は、16 進数の ASCII コードで指定する必要があります。たとえば、2C はカンマを表します。

   リクエストの本文（JSON）:

   {
     "gcs_destination": {
       "uri": "gs://BUCKET_NAME/PATH_TO_CSV_FILE"
     },
     "database": "DATABASE_NAME",
     "csv_export_options": {
       "select_query": "SELECT_QUERY",
       "escape_character": "ESCAPE_CHARACTER",
       "quote_character": "QUOTE_CHARACTER",
       "field_delimiter": "FIELD_DELIMITER"
     }
   }
   

   リクエストを送信するには、次のいずれかのオプションを使用します。

       curl -X POST \
             -H "Authorization: Bearer $(gcloud auth print-access-token)" \
             -H "Content-Type: application/json; charset=utf-8" \
             -d @request.json \
             "https://alloydb.googleapis.com/v1/projects/PROJECT_ID/locations/REGION/clusters/CLUSTER_ID:export"
  

    $cred = gcloud auth print-access-token
    $headers = @{ "Authorization" = "Bearer $cred" }

    Invoke-WebRequest `
      -Method POST `
      -Headers $headers `
      -ContentType: "application/json; charset=utf-8" `
      -InFile request.json `
      -Uri "https://alloydb.googleapis.com/v1/projects/PROJECT_ID/locations/REGION/clusters/CLUSTER_ID:export"| Select-Object -Expand Content
  

次のような JSON レスポンスが返されます。

    {
     "name": "projects/PROJECT_ID/locations/REGION/operations/OPERATION_ID",
     "metadata": {
      "@type": "type.googleapis.com/google.cloud.alloydb.v1.OperationMetadata",
      "createTime": "2024-09-17T06:05:31.244428646Z",
      "target": "projects/PROJECT_ID/locations/REGION/clusters/TARGET_CLUSTER",
      "verb": "export",
      "requestedCancellation": false,
      "apiVersion": "v1"
     },
     "done": false
    }
  

以前に設定した IAM 権限を保持する必要がない場合は、直ちに削除してください。

リクエストのパラメータの一覧については、clusters:export をご覧ください。