File: //snap/google-cloud-cli/396/help/man/man1/gcloud_dataproc_jobs_submit_hive.1
.TH "GCLOUD_DATAPROC_JOBS_SUBMIT_HIVE" 1
.SH "NAME"
.HP
gcloud dataproc jobs submit hive \- submit a Hive job to a cluster
.SH "SYNOPSIS"
.HP
\f5gcloud dataproc jobs submit hive\fR (\fB\-\-cluster\fR=\fICLUSTER\fR\ |\ \fB\-\-cluster\-labels\fR=[\fIKEY\fR=\fIVALUE\fR,...]) (\fB\-\-execute\fR=\fIQUERY\fR,\ \fB\-e\fR\ \fIQUERY\fR\ |\ \fB\-\-file\fR=\fIFILE\fR,\ \fB\-f\fR\ \fIFILE\fR) [\fB\-\-async\fR] [\fB\-\-bucket\fR=\fIBUCKET\fR] [\fB\-\-continue\-on\-failure\fR] [\fB\-\-driver\-required\-memory\-mb\fR=\fIDRIVER_REQUIRED_MEMORY_MB\fR] [\fB\-\-driver\-required\-vcores\fR=\fIDRIVER_REQUIRED_VCORES\fR] [\fB\-\-jars\fR=[\fIJAR\fR,...]] [\fB\-\-labels\fR=[\fIKEY\fR=\fIVALUE\fR,...]] [\fB\-\-max\-failures\-per\-hour\fR=\fIMAX_FAILURES_PER_HOUR\fR] [\fB\-\-max\-failures\-total\fR=\fIMAX_FAILURES_TOTAL\fR] [\fB\-\-params\fR=[\fIPARAM\fR=\fIVALUE\fR,...]] [\fB\-\-properties\fR=[\fIPROPERTY\fR=\fIVALUE\fR,...]] [\fB\-\-properties\-file\fR=\fIPROPERTIES_FILE\fR] [\fB\-\-region\fR=\fIREGION\fR] [\fIGCLOUD_WIDE_FLAG\ ...\fR]
.SH "DESCRIPTION"
Submit a Hive job to a cluster.
.SH "EXAMPLES"
To submit a Hive job with a local script, run:
.RS 2m
$ gcloud dataproc jobs submit hive \-\-cluster=my\-cluster \e
\-\-file=my_queries.q
.RE
To submit a Hive job with inline queries, run:
.RS 2m
$ gcloud dataproc jobs submit hive \-\-cluster=my\-cluster \e
\-e="CREATE EXTERNAL TABLE foo(bar int) LOCATION \e
'gs://my_bucket/'" \-e="SELECT * FROM foo WHERE bar > 2"
.RE
.SH "REQUIRED FLAGS"
.RS 2m
.TP 2m
Exactly one of these must be specified:
.RS 2m
.TP 2m
\fB\-\-cluster\fR=\fICLUSTER\fR
The Dataproc cluster to submit the job to.
.TP 2m
\fB\-\-cluster\-labels\fR=[\fIKEY\fR=\fIVALUE\fR,...]
List of label KEY=VALUE pairs to add.
Keys must start with a lowercase character and contain only hyphens (\f5\-\fR),
underscores (\f5_\fR), lowercase characters, and numbers. Values must contain
only hyphens (\f5\-\fR), underscores (\f5_\fR), lowercase characters, and
numbers.
Labels of Dataproc cluster on which to place the job.
.RE
.sp
.TP 2m
Exactly one of these must be specified:
.RS 2m
.TP 2m
\fB\-\-execute\fR=\fIQUERY\fR, \fB\-e\fR \fIQUERY\fR
A Hive query to execute as part of the job.
.TP 2m
\fB\-\-file\fR=\fIFILE\fR, \fB\-f\fR \fIFILE\fR
HCFS URI of file containing Hive script to execute as the job.
.RE
.RE
.sp
.SH "OPTIONAL FLAGS"
.RS 2m
.TP 2m
\fB\-\-async\fR
Return immediately, without waiting for the operation in progress to complete.
.TP 2m
\fB\-\-bucket\fR=\fIBUCKET\fR
The Cloud Storage bucket to stage files in. Defaults to the cluster's configured
bucket.
.TP 2m
\fB\-\-continue\-on\-failure\fR
Whether to continue if a single query fails.
.TP 2m
\fB\-\-driver\-required\-memory\-mb\fR=\fIDRIVER_REQUIRED_MEMORY_MB\fR
The memory allocation requested by the job driver in megabytes (MB) for
execution on the driver node group (it is used only by clusters with a driver
node group).
.TP 2m
\fB\-\-driver\-required\-vcores\fR=\fIDRIVER_REQUIRED_VCORES\fR
The vCPU allocation requested by the job driver for execution on the driver node
group (it is used only by clusters with a driver node group).
.TP 2m
\fB\-\-jars\fR=[\fIJAR\fR,...]
Comma separated list of jar files to be provided to the Hive and MR. May contain
UDFs.
.TP 2m
\fB\-\-labels\fR=[\fIKEY\fR=\fIVALUE\fR,...]
List of label KEY=VALUE pairs to add.
Keys must start with a lowercase character and contain only hyphens (\f5\-\fR),
underscores (\f5_\fR), lowercase characters, and numbers. Values must contain
only hyphens (\f5\-\fR), underscores (\f5_\fR), lowercase characters, and
numbers.
.TP 2m
\fB\-\-max\-failures\-per\-hour\fR=\fIMAX_FAILURES_PER_HOUR\fR
Specifies the maximum number of times a job can be restarted per hour in event
of failure. Default is 0 (no retries after job failure).
.TP 2m
\fB\-\-max\-failures\-total\fR=\fIMAX_FAILURES_TOTAL\fR
Specifies the maximum total number of times a job can be restarted after the job
fails. Default is 0 (no retries after job failure).
.TP 2m
\fB\-\-params\fR=[\fIPARAM\fR=\fIVALUE\fR,...]
A list of key value pairs to set variables in the Hive queries.
.TP 2m
\fB\-\-properties\fR=[\fIPROPERTY\fR=\fIVALUE\fR,...]
A list of key value pairs to configure Hive.
.TP 2m
\fB\-\-properties\-file\fR=\fIPROPERTIES_FILE\fR
Path to a local file or a file in a Cloud Storage bucket containing
configuration properties for the job. The client machine running this command
must have read permission to the file.
Specify properties in the form of property=value in the text file. For example:
.RS 2m
# Properties to set for the job:
key1=value1
key2=value2
# Comment out properties not used.
# key3=value3
.RE
If a property is set in both \f5\-\-properties\fR and
\f5\-\-properties\-file\fR, the value defined in \f5\-\-properties\fR takes
precedence.
.TP 2m
\fB\-\-region\fR=\fIREGION\fR
Dataproc region to use. Each Dataproc region constitutes an independent resource
namespace constrained to deploying instances into Compute Engine zones inside
the region. Overrides the default \fBdataproc/region\fR property value for this
command invocation.
.RE
.sp
.SH "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 \fB$ gcloud help\fR for details.
.SH "NOTES"
These variants are also available:
.RS 2m
$ gcloud alpha dataproc jobs submit hive
.RE
.RS 2m
$ gcloud beta dataproc jobs submit hive
.RE