Plantilla de Cloud Spanner a Cloud Storage
Usa la plantilla de Dataproc sin servidor de Cloud Spanner a Cloud Storage para extraer datos de las bases de datos de Spanner a Cloud Storage.
Usa la plantilla
Ejecuta la plantilla con la CLI de gcloud o la API de Dataproc.
Antes de usar cualquiera de los datos de comando a continuación, realiza los siguientes reemplazos:
PROJECT_ID : Obligatorio. El ID de tu Google Cloud proyecto que aparece en la Configuración de IAMREGION : Obligatorio. Región de Compute Engine.SUBNET : Opcional Si no se especifica una subred, se selecciona la subred en la REGION especificada en la reddefault
.Ejemplo:
projects/PROJECT_ID/regions/REGION/subnetworks/SUBNET_NAME
TEMPLATE_VERSION : Obligatorio. Especificalatest
para la versión más reciente de la plantilla o la fecha de una versión específica, por ejemplo,2023-03-17_v0.1.0-beta
(visita gs://dataproc-templates-binaries o ejecutagcloud storage ls gs://dataproc-templates-binaries
para ver una lista de las versiones de plantilla disponibles).INSTANCE : Obligatorio. ID de la instancia de Spanner.DATABASE : Obligatorio. ID de la base de datos de Spanner.TABLE : Obligatorio. El nombre de la tabla de entrada de Spanner o una consulta de SQL en la tabla de entrada de SpannerEjemplo (la consulta en SQL debe estar entre paréntesis):
(select * from TABLE)
SPANNER_JDBC_DIALECT : Obligatorio. Dialecto JDBC de Spanner Opciones:googlesql
opostgresql
. La configuración predeterminada esgooglesql
.CLOUD_STORAGE_OUTPUT_PATH : Obligatorio. Es la ruta de acceso de Cloud Storage en la que se almacenará el resultado.Ejemplo:
gs://example-bucket/example-folder/
FORMAT : Obligatorio. Formato de datos de salida. Opciones:avro
,parquet
,csv
ojson
. Nota: Si esavro
, debes agregar "file:///usr/lib/spark/connector/spark-avro.jar
" al campo de API o a la marcajars
de la CLI de gcloud.Ejemplo (el prefijo
file://
hace referencia a un archivo jar de Dataproc Serverless):--jars=file:///usr/lib/spark/connector/spark-avro.jar,
[ ... other jars]MODE : Obligatorio. Es el modo de escritura para la salida de Cloud Storage. Opciones:append
,overwrite
,ignore
oerrorifexists
.NUM_PARTITIONS : Opcional Es la cantidad máxima de particiones que se pueden usar para el paralelismo de las operaciones de lectura y escritura de tablas.INPUT_PARTITION_COLUMN ,LOWERBOUND ,UPPERBOUND : Opcional. Si se usan, se deben especificar todos los siguientes parámetros:- INPUT_PARTITION_COLUMN: Es el nombre de la columna de partición de la tabla de entrada de Spanner.
- LOWERBOUND: Es el límite inferior de la columna de partición de la tabla de entrada de Spanner que se usa para determinar el ancho de paso de la partición.
- UPPERBOUND: Es el límite superior de la columna de partición de la tabla de entrada de Spanner que se usa para decidir el intervalo de partición.
TEMP_VIEW yTEMP_QUERY : opcional. Puedes usar estos dos parámetros opcionales para aplicar una transformación de Spark SQL mientras cargas datos en Cloud Storage. TEMP_VIEW debe ser igual al nombre de la tabla que se usa en la consulta, y TEMP_QUERY es la sentencia de consulta.SERVICE_ACCOUNT : Opcional Si no se proporciona, se usa la cuenta de servicio de Compute Engine predeterminada.PROPERTY yPROPERTY_VALUE : Opcional. Es una lista separada por comas de pares propiedad de Spark=value
.LABEL yLABEL_VALUE : Opcional. Es una lista separada por comas de pareslabel
=value
.LOG_LEVEL : Opcional Nivel de registro. Puede ser una de las siguientes opciones:ALL
,DEBUG
,ERROR
,FATAL
,INFO
,OFF
,TRACE
oWARN
. Valor predeterminado:INFO
.-
KMS_KEY : Opcional La clave de Cloud Key Management Service que se usará para la encriptación. Si no se especifica una clave, los datos se encriptan en reposo con un Google-owned and Google-managed encryption key.Ejemplo:
projects/PROJECT_ID/regions/REGION/keyRings/KEY_RING_NAME/cryptoKeys/KEY_NAME
Ejecuta el siguiente comando:
Linux, macOS o Cloud Shell
gcloud dataproc batches submit spark \ --class=com.google.cloud.dataproc.templates.main.DataProcTemplate \ --version="1.2" \ --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 " \ --templateProperty spanner.jdbc.dialect="SPANNER_JDBC_DIALECT "
Windows (PowerShell)
gcloud dataproc batches submit spark ` --class=com.google.cloud.dataproc.templates.main.DataProcTemplate ` --version="1.2" ` --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 " ` --templateProperty spanner.jdbc.dialect="SPANNER_JDBC_DIALECT "
Windows (cmd.exe)
gcloud dataproc batches submit spark ^ --class=com.google.cloud.dataproc.templates.main.DataProcTemplate ^ --version="1.2" ^ --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 " ^ --templateProperty spanner.jdbc.dialect="SPANNER_JDBC_DIALECT "
Antes de usar cualquiera de los datos de solicitud a continuación, realiza los siguientes reemplazos:
PROJECT_ID : Obligatorio. El ID de tu Google Cloud proyecto que aparece en la Configuración de IAMREGION : Obligatorio. Región de Compute Engine.SUBNET : Opcional Si no se especifica una subred, se selecciona la subred en la REGION especificada en la reddefault
.Ejemplo:
projects/PROJECT_ID/regions/REGION/subnetworks/SUBNET_NAME
TEMPLATE_VERSION : Obligatorio. Especificalatest
para la versión más reciente de la plantilla o la fecha de una versión específica, por ejemplo,2023-03-17_v0.1.0-beta
(visita gs://dataproc-templates-binaries o ejecutagcloud storage ls gs://dataproc-templates-binaries
para ver una lista de las versiones de plantilla disponibles).INSTANCE : Obligatorio. ID de la instancia de Spanner.DATABASE : Obligatorio. ID de la base de datos de Spanner.TABLE : Obligatorio. El nombre de la tabla de entrada de Spanner o una consulta de SQL en la tabla de entrada de SpannerEjemplo (la consulta en SQL debe estar entre paréntesis):
(select * from TABLE)
SPANNER_JDBC_DIALECT : Obligatorio. Dialecto JDBC de Spanner Opciones:googlesql
opostgresql
. La configuración predeterminada esgooglesql
.CLOUD_STORAGE_OUTPUT_PATH : Obligatorio. Es la ruta de acceso de Cloud Storage en la que se almacenará el resultado.Ejemplo:
gs://example-bucket/example-folder/
FORMAT : Obligatorio. Formato de datos de salida. Opciones:avro
,parquet
,csv
ojson
. Nota: Si esavro
, debes agregar "file:///usr/lib/spark/connector/spark-avro.jar
" al campo de API o a la marcajars
de la CLI de gcloud.Ejemplo (el prefijo
file://
hace referencia a un archivo jar de Dataproc Serverless):--jars=file:///usr/lib/spark/connector/spark-avro.jar,
[ ... other jars]MODE : Obligatorio. Es el modo de escritura para la salida de Cloud Storage. Opciones:append
,overwrite
,ignore
oerrorifexists
.NUM_PARTITIONS : Opcional Es la cantidad máxima de particiones que se pueden usar para el paralelismo de las operaciones de lectura y escritura de tablas.INPUT_PARTITION_COLUMN ,LOWERBOUND ,UPPERBOUND : Opcional. Si se usan, se deben especificar todos los siguientes parámetros:- INPUT_PARTITION_COLUMN: Es el nombre de la columna de partición de la tabla de entrada de Spanner.
- LOWERBOUND: Es el límite inferior de la columna de partición de la tabla de entrada de Spanner que se usa para determinar el ancho de paso de la partición.
- UPPERBOUND: Es el límite superior de la columna de partición de la tabla de entrada de Spanner que se usa para decidir el intervalo de partición.
TEMP_VIEW yTEMP_QUERY : opcional. Puedes usar estos dos parámetros opcionales para aplicar una transformación de Spark SQL mientras cargas datos en Cloud Storage. TEMP_VIEW debe ser igual al nombre de la tabla que se usa en la consulta, y TEMP_QUERY es la sentencia de consulta.SERVICE_ACCOUNT : Opcional Si no se proporciona, se usa la cuenta de servicio de Compute Engine predeterminada.PROPERTY yPROPERTY_VALUE : Opcional. Es una lista separada por comas de pares propiedad de Spark=value
.LABEL yLABEL_VALUE : Opcional. Es una lista separada por comas de pareslabel
=value
.LOG_LEVEL : Opcional Nivel de registro. Puede ser una de las siguientes opciones:ALL
,DEBUG
,ERROR
,FATAL
,INFO
,OFF
,TRACE
oWARN
. Valor predeterminado:INFO
.-
KMS_KEY : Opcional La clave de Cloud Key Management Service que se usará para la encriptación. Si no se especifica una clave, los datos se encriptan en reposo con un Google-owned and Google-managed encryption key.Ejemplo:
projects/PROJECT_ID/regions/REGION/keyRings/KEY_RING_NAME/cryptoKeys/KEY_NAME
Método HTTP y URL:
POST https://dataproc.googleapis.com/v1/projects/PROJECT_ID /locations/REGION /batches
Cuerpo JSON de la solicitud:
{ "environmentConfig":{ "executionConfig":{ "subnetworkUri":"SUBNET ", "kmsKey": "KMS_KEY ", "serviceAccount": "SERVICE_ACCOUNT " } }, "labels": { "LABEL ": "LABEL_VALUE " }, "runtimeConfig": { "version": "1.2", "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 ", "--templateProperty spanner.jdbc.dialect=SPANNER_JDBC_DIALECT " ], "jarFileUris":[ "file:///usr/lib/spark/connector/spark-avro.jar", "gs://dataproc-templates-binaries/TEMPLATE_VERSION /java/dataproc-templates.jar" ] } }
Para enviar tu solicitud, expande una de estas opciones:
curl (Linux, macOS o Cloud Shell)
Guarda el cuerpo de la solicitud en un archivo llamado request.json
y ejecuta el siguiente comando:
curl -X POST \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "Content-Type: application/json; charset=utf-8" \
-d @request.json \
"https://dataproc.googleapis.com/v1/projects/PROJECT_ID /locations/REGION /batches"
PowerShell (Windows)
Guarda el cuerpo de la solicitud en un archivo llamado request.json
y ejecuta el siguiente comando:
$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://dataproc.googleapis.com/v1/projects/PROJECT_ID /locations/REGION /batches" | Select-Object -Expand Content
Deberías recibir una respuesta JSON similar a la que se muestra a continuación:
{ "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" } }