.TH "GCLOUD_ALPHA_SPANNER_SAMPLES_WORKLOAD" 1



.SH "NAME"
.HP
gcloud alpha spanner samples workload \- generate gRPC traffic for a given sample app's backend service



.SH "SYNOPSIS"
.HP
\f5gcloud alpha spanner samples workload\fR \fIAPPNAME\fR [\fB\-\-duration\fR=\fIDURATION\fR;\ default="1h"] [\fB\-\-port\fR=\fIPORT\fR] [\fB\-\-target\-qps\fR=\fITARGET_QPS\fR] [\fIGCLOUD_WIDE_FLAG\ ...\fR]



.SH "DESCRIPTION"

\fB(ALPHA)\fR Before sending traffic to the backend service, create the database
and start the service with:

.RS 2m
$ gcloud alpha spanner samples init APPNAME \-\-instance\-id=INSTANCE_ID
$ gcloud alpha spanner samples backend APPNAME \e
  \-\-instance\-id=INSTANCE_ID
.RE

To run all three steps together, use:

.RS 2m
$ gcloud alpha spanner samples run APPNAME \-\-instance\-id=INSTANCE_ID
.RE



.SH "EXAMPLES"

To generate traffic for the 'finance' sample app, run:

.RS 2m
$ gcloud alpha spanner samples workload finance
.RE



.SH "POSITIONAL ARGUMENTS"

.RS 2m
.TP 2m
\fIAPPNAME\fR

The sample app name, e.g. "finance".


.RE
.sp

.SH "FLAGS"

.RS 2m
.TP 2m
\fB\-\-duration\fR=\fIDURATION\fR; default="1h"

Duration of time allowed to run before stopping the workload.

.TP 2m
\fB\-\-port\fR=\fIPORT\fR

Port of the running backend service.

.TP 2m
\fB\-\-target\-qps\fR=\fITARGET_QPS\fR

Target requests per second.


.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"

This command is currently in alpha and might change without notice. If this
command fails with API permission errors despite specifying the correct project,
you might be trying to access an API with an invitation\-only early access
allowlist. These variants are also available:

.RS 2m
$ gcloud spanner samples workload
.RE

.RS 2m
$ gcloud beta spanner samples workload
.RE