gcloud dataproc workflow-templates add-job spark-sql Stay organized with collections Save and categorize content based on your preferences.
- NAME
- gcloud dataproc workflow-templates add-job spark-sql - add a SparkSql job to the workflow template
- SYNOPSIS
gcloud dataproc workflow-templates add-job spark-sql
--step-id
=STEP_ID
(--execute
=QUERY
,-e
QUERY
|--file
=FILE
,-f
FILE
)(--workflow-template
=WORKFLOW_TEMPLATE
:--region
=REGION
)[--driver-log-levels
=[PACKAGE
=LEVEL
,…]][--jars
=[JAR
,…]][--labels
=[KEY
=VALUE
,…]][--params
=[PARAM
=VALUE
,…]][--properties
=[PROPERTY
=VALUE
,…]][--properties-file
=PROPERTIES_FILE
][--start-after
=STEP_ID
,[STEP_ID
,…]][GCLOUD_WIDE_FLAG …
]
- DESCRIPTION
- Add a SparkSql job to the workflow template.
- EXAMPLES
- To add a SparkSql job executing query 'QUERY' to a the workflow template'my-workflow-template' in region 'us-central1' with step-id 'my-step-id' , run:
gclouddataprocworkflow-templatesadd-jobspark-sql--step-id=my-step_id-e=QUERY--workflow-template=my-workflow-template--region=us-central1
- REQUIRED FLAGS
--step-id
=STEP_ID
- The step ID of the job in the workflow template.
- Exactly one of these must be specified:
--execute
=QUERY
,-e
QUERY
- A Spark SQL query to execute as part of the job.
--file
=FILE
,-f
FILE
- HCFS URI of file containing Spark SQL script to execute as the job.
- Template resource - The name of the workflow template to add job to. Thearguments in this group can be used to specify the attributes of this resource.(NOTE) Some attributes are not given arguments in this group but can be set inother ways.
To set the
project
attribute:- provide the argument
--workflow-template
on the command line with afully specified name; - provide the argument
--project
on the command line; - set the property
core/project
.
This must be specified.
--workflow-template
=WORKFLOW_TEMPLATE
- ID of the template or fully qualified identifier for the template.
To set the
template
attribute:- provide the argument
--workflow-template
on the command line.
This flag argument must be specified if any of the other arguments in this groupare specified.
- provide the argument
--region
=REGION
- Dataproc region for the template. Each Dataproc region constitutes anindependent resource namespace constrained to deploying instances into ComputeEngine zones inside the region. Overrides the default
dataproc/region
property value for this command invocation.To set the
region
attribute:- provide the argument
--workflow-template
on the command line with afully specified name; - provide the argument
--region
on the command line; - set the property
dataproc/region
.
- provide the argument
- provide the argument
- OPTIONAL FLAGS
--driver-log-levels
=[PACKAGE
=LEVEL
,…]- A list of package to log4j log level pairs to configure driver logging. Forexample: root=FATAL,com.example=INFO
--jars
=[JAR
,…]- Comma separated list of jar files to be provided to the executor and driverclasspaths. May contain UDFs.
--labels
=[KEY
=VALUE
,…]- List of label KEY=VALUE pairs to add.
Keys must start with a lowercase character and contain only hyphens(
-
), underscores (_
), lowercase characters, andnumbers. Values must contain only hyphens (-
), underscores(_
), lowercase characters, and numbers. --params
=[PARAM
=VALUE
,…]- A list of key value pairs to set variables in the Hive queries.
--properties
=[PROPERTY
=VALUE
,…]- A list of key value pairs to configure Hive.
--properties-file
=PROPERTIES_FILE
- Path to a local file or a file in a Cloud Storage bucket containingconfiguration properties for the job. The client machine running this commandmust have read permission to the file.
Specify properties in the form of property=value in the text file. For example:
# Properties to set for the job:key1=value1key2=value2# Comment out properties not used.# key3=value3
If a property is set in both
--properties
and--properties-file
, the value defined in--properties
takes precedence. --start-after
=STEP_ID
,[STEP_ID
,…]- (Optional) List of step IDs to start this job after.
- GCLOUD WIDE FLAGS
- These flags are available to all commands:
--access-token-file
,--account
,--billing-project
,--configuration
,--flags-file
,--flatten
,--format
,--help
,--impersonate-service-account
,--log-http
,--project
,--quiet
,--trace-token
,--user-output-enabled
,--verbosity
.Run
$gcloud help
for details. - NOTES
- These variants are also available:
gcloudalphadataprocworkflow-templatesadd-jobspark-sql
gcloudbetadataprocworkflow-templatesadd-jobspark-sql
Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-05-07 UTC.