Cloud Spanner to Cloud Storage 模板

使用 Dataproc Serverless Cloud Spanner to Cloud Storage 模板将数据从 Spanner 数据库提取到 Cloud Storage。

使用模板

使用 gcloud CLI 或 Dataproc API 运行模板。

gcloud

在使用下面的命令数据之前,请先进行以下替换:

  • PROJECT_ID:必填。IAM 设置中列出的 Google Cloud 项目 ID。
  • REGION:必填。Compute Engine 区域
  • SUBNET:可选。如果未指定子网,则会选择 default 网络中指定 REGION 中的子网。

    示例: projects/PROJECT_ID/regions/REGION/subnetworks/SUBNET_NAME

  • TEMPLATE_VERSION:必填。指定 latest 作为最新的模板版本,或者指定特定版本的日期,例如 2023-03-17_v0.1.0-beta(访问 gs://dataproc-templates-binaries 或运行 gsutil ls gs://dataproc-templates-binaries 以列出可用的模板版本)。
  • INSTANCE:必填。Spanner 实例 ID。
  • DATABASE:必填。Spanner 数据库 ID。
  • TABLE:必填。Spanner 输入表名称或 Spanner 输入表上的 SQL 查询。

    示例(SQL 查询应放在括号内)(select * from TABLE)

  • CLOUD_STORAGE_OUTPUT_PATH:必填。用于存储输出的 Cloud Storage 路径。

    示例: gs://example-bucket/example-folder/

  • FORMAT:必填。输出数据格式。选项:avroparquetcsvjson注意:如果为 avro,您必须将“file:///usr/lib/spark/external/spark-avro.jar”添加到 jars gcloud CLI 标志或 API 字段中。

    示例(file:// 前缀引用 Dataproc Serverless jar 文件)

    --jars=file:///usr/lib/spark/external/spark-avro.jar, [ ... 其他罐子]
  • MODE:必填。Cloud Storage 输出的写入模式。 选项:appendoverwriteignoreerrorifexists
  • NUM_PARTITIONS:可选。可用于并行处理表读写的分区数上限。
  • INPUT_PARTITION_COLUMNLOWERBOUNDUPPERBOUND:可选。如果使用,则必须指定以下所有参数:
    • INPUT_PARTITION_COLUMN:Spanner 输入表分区列名称。
    • LOWERBOUND:Spanner 输入表分区列下限,用于确定分区步长。
    • UPPERBOUND:Spanner 输入表分区列上限,用于确定分区步长。
  • TEMP_VIEWTEMP_QUERY:可选。在将数据加载到 Cloud Storage 时,您可以使用这两个可选参数来应用 Spark SQL 转换。TEMP_VIEW 必须与查询中使用的表名相同,TEMP_QUERY 是查询语句。
  • SERVICE_ACCOUNT:可选。如果未提供此项,系统将使用默认 Compute Engine 服务帐号
  • PROPERTYPROPERTY_VALUE:可选。以英文逗号分隔的 Spark 属性=value 对列表。
  • LABELLABEL_VALUE:可选。以英文逗号分隔的“label=value”对列表。
  • LOG_LEVEL:可选。日志记录级别。可以是 ALLDEBUGERRORFATALINFOOFFTRACEWARN 中的一个。默认值:INFO
  • KMS_KEY:可选。用于加密的 Cloud Key Management Service 密钥。如果未指定密钥,系统会使用 Google 拥有和 Google 管理的密钥静态加密数据。

    示例: projects/PROJECT_ID/regions/REGION/keyRings/KEY_RING_NAME/cryptoKeys/KEY_NAME

执行以下命令:

Linux、macOS 或 Cloud Shell

gcloud dataproc batches submit spark \
    --class=com.google.cloud.dataproc.templates.main.DataProcTemplate \
    --version="1.1" \
    --project="PROJECT_ID" \
    --region="REGION" \
    --jars="gs://dataproc-templates-binaries/TEMPLATE_VERSION/java/dataproc-templates.jar" \
    --subnet="SUBNET" \
    --kms-key="KMS_KEY" \
    --service-account="SERVICE_ACCOUNT" \
    --properties="PROPERTY=PROPERTY_VALUE" \
    --labels="LABEL=LABEL_VALUE" \
    -- --template=SPANNERTOGCS \
    --templateProperty log.level="LOG_LEVEL" \
    --templateProperty project.id="PROJECT_ID" \
    --templateProperty spanner.gcs.input.spanner.id="INSTANCE" \
    --templateProperty spanner.gcs.input.database.id="DATABASE" \
    --templateProperty spanner.gcs.input.table.id="TABLE" \
    --templateProperty spanner.gcs.output.gcs.path="CLOUD_STORAGE_OUTPUT_PATH" \
    --templateProperty spanner.gcs.output.gcs.saveMode="MODE" \
    --templateProperty spanner.gcs.output.gcs.format="FORMAT" \
    --templateProperty spanner.gcs.input.sql.partitionColumn="INPUT_PARTITION_COLUMN" \
    --templateProperty spanner.gcs.input.sql.lowerBound="LOWERBOUND" \
    --templateProperty spanner.gcs.input.sql.upperBound="UPPERBOUND" \
    --templateProperty spanner.spanner.gcs.input.sql.numPartitions="NUM_PARTITIONS" \
    --templateProperty spanner.gcs.temp.table="TEMP_VIEW" \
    --templateProperty spanner.gcs.temp.query="TEMP_QUERY"

Windows (PowerShell)

gcloud dataproc batches submit spark `
    --class=com.google.cloud.dataproc.templates.main.DataProcTemplate `
    --version="1.1" `
    --project="PROJECT_ID" `
    --region="REGION" `
    --jars="gs://dataproc-templates-binaries/TEMPLATE_VERSION/java/dataproc-templates.jar" `
    --subnet="SUBNET" `
    --kms-key="KMS_KEY" `
    --service-account="SERVICE_ACCOUNT" `
    --properties="PROPERTY=PROPERTY_VALUE" `
    --labels="LABEL=LABEL_VALUE" `
    -- --template=SPANNERTOGCS `
    --templateProperty log.level="LOG_LEVEL" `
    --templateProperty project.id="PROJECT_ID" `
    --templateProperty spanner.gcs.input.spanner.id="INSTANCE" `
    --templateProperty spanner.gcs.input.database.id="DATABASE" `
    --templateProperty spanner.gcs.input.table.id="TABLE" `
    --templateProperty spanner.gcs.output.gcs.path="CLOUD_STORAGE_OUTPUT_PATH" `
    --templateProperty spanner.gcs.output.gcs.saveMode="MODE" `
    --templateProperty spanner.gcs.output.gcs.format="FORMAT" `
    --templateProperty spanner.gcs.input.sql.partitionColumn="INPUT_PARTITION_COLUMN" `
    --templateProperty spanner.gcs.input.sql.lowerBound="LOWERBOUND" `
    --templateProperty spanner.gcs.input.sql.upperBound="UPPERBOUND" `
    --templateProperty spanner.spanner.gcs.input.sql.numPartitions="NUM_PARTITIONS" `
    --templateProperty spanner.gcs.temp.table="TEMP_VIEW" `
    --templateProperty spanner.gcs.temp.query="TEMP_QUERY"

Windows (cmd.exe)

gcloud dataproc batches submit spark ^
    --class=com.google.cloud.dataproc.templates.main.DataProcTemplate ^
    --version="1.1" ^
    --project="PROJECT_ID" ^
    --region="REGION" ^
    --jars="gs://dataproc-templates-binaries/TEMPLATE_VERSION/java/dataproc-templates.jar" ^
    --subnet="SUBNET" ^
    --kms-key="KMS_KEY" ^
    --service-account="SERVICE_ACCOUNT" ^
    --properties="PROPERTY=PROPERTY_VALUE" ^
    --labels="LABEL=LABEL_VALUE" ^
    -- --template=SPANNERTOGCS ^
    --templateProperty log.level="LOG_LEVEL" ^
    --templateProperty project.id="PROJECT_ID" ^
    --templateProperty spanner.gcs.input.spanner.id="INSTANCE" ^
    --templateProperty spanner.gcs.input.database.id="DATABASE" ^
    --templateProperty spanner.gcs.input.table.id="TABLE" ^
    --templateProperty spanner.gcs.output.gcs.path="CLOUD_STORAGE_OUTPUT_PATH" ^
    --templateProperty spanner.gcs.output.gcs.saveMode="MODE" ^
    --templateProperty spanner.gcs.output.gcs.format="FORMAT" ^
    --templateProperty spanner.gcs.input.sql.partitionColumn="INPUT_PARTITION_COLUMN" ^
    --templateProperty spanner.gcs.input.sql.lowerBound="LOWERBOUND" ^
    --templateProperty spanner.gcs.input.sql.upperBound="UPPERBOUND" ^
    --templateProperty spanner.spanner.gcs.input.sql.numPartitions="NUM_PARTITIONS" ^
    --templateProperty spanner.gcs.temp.table="TEMP_VIEW" ^
    --templateProperty spanner.gcs.temp.query="TEMP_QUERY"

REST

在使用任何请求数据之前,请先进行以下替换:

  • PROJECT_ID:必填。IAM 设置中列出的 Google Cloud 项目 ID。
  • REGION:必填。Compute Engine 区域
  • SUBNET:可选。如果未指定子网,则会选择 default 网络中指定 REGION 中的子网。

    示例: projects/PROJECT_ID/regions/REGION/subnetworks/SUBNET_NAME

  • TEMPLATE_VERSION:必填。指定 latest 作为最新的模板版本,或者指定特定版本的日期,例如 2023-03-17_v0.1.0-beta(访问 gs://dataproc-templates-binaries 或运行 gsutil ls gs://dataproc-templates-binaries 以列出可用的模板版本)。
  • INSTANCE:必填。Spanner 实例 ID。
  • DATABASE:必填。Spanner 数据库 ID。
  • TABLE:必填。Spanner 输入表名称或 Spanner 输入表上的 SQL 查询。

    示例(SQL 查询应放在括号内)(select * from TABLE)

  • CLOUD_STORAGE_OUTPUT_PATH:必填。用于存储输出的 Cloud Storage 路径。

    示例: gs://example-bucket/example-folder/

  • FORMAT:必填。输出数据格式。选项:avroparquetcsvjson注意:如果为 avro,您必须将“file:///usr/lib/spark/external/spark-avro.jar”添加到 jars gcloud CLI 标志或 API 字段中。

    示例(file:// 前缀引用 Dataproc Serverless jar 文件)

    --jars=file:///usr/lib/spark/external/spark-avro.jar, [ ... 其他罐子]
  • MODE:必填。Cloud Storage 输出的写入模式。 选项:appendoverwriteignoreerrorifexists
  • NUM_PARTITIONS:可选。可用于并行处理表读写的分区数上限。
  • INPUT_PARTITION_COLUMNLOWERBOUNDUPPERBOUND:可选。如果使用,则必须指定以下所有参数:
    • INPUT_PARTITION_COLUMN:Spanner 输入表分区列名称。
    • LOWERBOUND:Spanner 输入表分区列下限,用于确定分区步长。
    • UPPERBOUND:Spanner 输入表分区列上限,用于确定分区步长。
  • TEMP_VIEWTEMP_QUERY:可选。在将数据加载到 Cloud Storage 时,您可以使用这两个可选参数来应用 Spark SQL 转换。TEMP_VIEW 必须与查询中使用的表名相同,TEMP_QUERY 是查询语句。
  • SERVICE_ACCOUNT:可选。如果未提供此项,系统将使用默认 Compute Engine 服务帐号
  • PROPERTYPROPERTY_VALUE:可选。以英文逗号分隔的 Spark 属性=value 对列表。
  • LABELLABEL_VALUE:可选。以英文逗号分隔的“label=value”对列表。
  • LOG_LEVEL:可选。日志记录级别。可以是 ALLDEBUGERRORFATALINFOOFFTRACEWARN 中的一个。默认值:INFO
  • KMS_KEY:可选。用于加密的 Cloud Key Management Service 密钥。如果未指定密钥,系统会使用 Google 拥有和 Google 管理的密钥静态加密数据。

    示例: projects/PROJECT_ID/regions/REGION/keyRings/KEY_RING_NAME/cryptoKeys/KEY_NAME

HTTP 方法和网址:

POST https://dataproc.googleapis.com/v1/projects/PROJECT_ID/locations/REGION/batches

请求 JSON 正文:


{
  "environmentConfig":{
    "executionConfig":{
      "subnetworkUri":"SUBNET",
      "kmsKey": "KMS_KEY",
      "serviceAccount": "SERVICE_ACCOUNT"
    }
  },
  "labels": {
    "LABEL": "LABEL_VALUE"
  },
  "runtimeConfig": {
    "version": "1.1",
    "properties": {
      "PROPERTY": "PROPERTY_VALUE"
    }
  },
  "sparkBatch":{
    "mainClass":"com.google.cloud.dataproc.templates.main.DataProcTemplate",
    "args":[
      "--template","SPANNERTOGCS",
      "--templateProperty","log.level=LOG_LEVEL",
      "--templateProperty","project.id=PROJECT_ID",
      "--templateProperty","spanner.gcs.input.spanner.id=INSTANCE",
      "--templateProperty","spanner.gcs.input.database.id=DATABASE",
      "--templateProperty","spanner.gcs.input.table.id=TABLE",
      "--templateProperty","spanner.gcs.output.gcs.path=CLOUD_STORAGE_OUTPUT_PATH",
      "--templateProperty","spanner.gcs.output.gcs.saveMode=MODE",
      "--templateProperty","spanner.gcs.output.gcs.format=FORMAT",
      "--templateProperty","spanner.gcs.input.sql.partitionColumn=INPUT_PARTITION_COLUMN",
      "--templateProperty","spanner.gcs.input.sql.lowerBound=LOWERBOUND",
      "--templateProperty","spanner.gcs.input.sql.upperBound=UPPERBOUND",
      "--templateProperty","spanner.gcs.input.sql.numPartitions=NUM_PARTITIONS",
      "--templateProperty","spanner.gcs.temp.table=TEMP_VIEW",
      "--templateProperty","spanner.gcs.temp.query=TEMP_QUERY"
    ],
    "jarFileUris":[
      "file:///usr/lib/spark/external/spark-avro.jar", "gs://dataproc-templates-binaries/TEMPLATE_VERSION/java/dataproc-templates.jar"
    ]
  }
}

如需发送您的请求,请展开以下选项之一:

您应该收到类似以下内容的 JSON 响应:


{
  "name": "projects/PROJECT_ID/regions/REGION/operations/OPERATION_ID",
  "metadata": {
    "@type": "type.googleapis.com/google.cloud.dataproc.v1.BatchOperationMetadata",
    "batch": "projects/PROJECT_ID/locations/REGION/batches/BATCH_ID",
    "batchUuid": "de8af8d4-3599-4a7c-915c-798201ed1583",
    "createTime": "2023-02-24T03:31:03.440329Z",
    "operationType": "BATCH",
    "description": "Batch"
  }
}