.TH "GCLOUD_ALPHA_SPANNER_SAMPLES_RUN" 1



.SH "NAME"
.HP
gcloud alpha spanner samples run \- run the given Cloud Spanner sample app



.SH "SYNOPSIS"
.HP
\f5gcloud alpha spanner samples run\fR \fIAPPNAME\fR \fB\-\-instance\-id\fR=\fIINSTANCE_ID\fR [\fB\-\-no\-cleanup\fR] [\fB\-\-database\-id\fR=\fIDATABASE_ID\fR] [\fB\-\-duration\fR=\fIDURATION\fR;\ default="1h"] [\fB\-\-skip\-init\fR] [\fIGCLOUD_WIDE_FLAG\ ...\fR]



.SH "DESCRIPTION"

\fB(ALPHA)\fR Each Cloud Spanner sample application includes a backend gRPC
service backed by a Cloud Spanner database and a workload script that generates
service traffic. This command creates and initializes the Cloud Spanner database
and runs both the backend service and workload script.

These sample apps are open source and available at
https://github.com/GoogleCloudPlatform/cloud\-spanner\-samples.

To see a list of available sample apps, run:

.RS 2m
$ gcloud alpha spanner samples list
.RE



.SH "EXAMPLES"

To run the 'finance' sample app using instance 'my\-instance', run:

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



.SH "POSITIONAL ARGUMENTS"

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

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


.RE
.sp

.SH "REQUIRED FLAGS"

.RS 2m
.TP 2m
\fB\-\-instance\-id\fR=\fIINSTANCE_ID\fR

The Cloud Spanner instance ID for the sample app.


.RE
.sp

.SH "OPTIONAL FLAGS"

.RS 2m
.TP 2m
\fB\-\-cleanup\fR

Delete the instance after running the sample app. Enabled by default, use
\fB\-\-no\-cleanup\fR to disable.

.TP 2m
\fB\-\-database\-id\fR=\fIDATABASE_ID\fR

ID of the new Cloud Spanner database to create for the sample app.

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

Duration of time allowed to run the sample app before stopping the service.

.TP 2m
\fB\-\-skip\-init\fR

Use an existing database instead of creating a new one.


.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 run
.RE

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