mirror of
https://github.com/imjasonh/gcloud-help
synced 2026-07-08 10:35:03 +00:00
123 lines
4.1 KiB
Text
123 lines
4.1 KiB
Text
NAME
|
|
gcloud alpha spanner cli - an interactive shell for Spanner
|
|
|
|
SYNOPSIS
|
|
gcloud alpha spanner cli (DATABASE : --instance=INSTANCE)
|
|
[--database-role=DATABASE_ROLE] [--delimiter=DELIMITER; default=";"]
|
|
[--execute=EXECUTE] [--host=HOST; default="localhost"] [--html]
|
|
[--idle-transaction-timeout=IDLE_TRANSACTION_TIMEOUT; default=60]
|
|
[--init-command=INIT_COMMAND] [--init-command-add=INIT_COMMAND_ADD]
|
|
[--port=PORT] [--prompt=PROMPT; default="spanner-cli> "]
|
|
[--skip-column-names] [--skip-system-command] [--source=SOURCE]
|
|
[--system-command=SYSTEM_COMMAND; default="ON"] [--table] [--tee=TEE]
|
|
[--xml] [GCLOUD_WIDE_FLAG ...]
|
|
|
|
DESCRIPTION
|
|
(ALPHA) An interactive shell for Spanner.
|
|
|
|
EXAMPLES
|
|
To start an interactive shell with your Spanner example database, run the
|
|
following command:
|
|
|
|
$ gcloud alpha spanner cli example-database \
|
|
--instance=example-instance
|
|
|
|
POSITIONAL ARGUMENTS
|
|
Database resource - The Cloud Spanner database to use within the
|
|
interactive shell. The arguments 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 in other ways.
|
|
|
|
To set the project attribute:
|
|
◆ provide the argument database on the command line with a fully
|
|
specified name;
|
|
◆ provide the argument --project on the command line;
|
|
◆ set the property core/project.
|
|
|
|
This must be specified.
|
|
|
|
DATABASE
|
|
ID of the database or fully qualified identifier for the database.
|
|
|
|
To set the database attribute:
|
|
▸ provide the argument database on the command line.
|
|
|
|
This positional argument must be specified if any of the other
|
|
arguments in this group are specified.
|
|
|
|
--instance=INSTANCE
|
|
The Cloud Spanner instance for the database.
|
|
|
|
To set the instance attribute:
|
|
▸ provide the argument database on the command line with a fully
|
|
specified name;
|
|
▸ provide the argument --instance on the command line;
|
|
▸ set the property spanner/instance.
|
|
|
|
FLAGS
|
|
--database-role=DATABASE_ROLE
|
|
Database role user used to access the database.
|
|
|
|
--delimiter=DELIMITER; default=";"
|
|
Set the statement delimiter.
|
|
|
|
--execute=EXECUTE
|
|
Execute the statement and then exits.
|
|
|
|
--host=HOST; default="localhost"
|
|
Host on which Spanner server is located.
|
|
|
|
--html
|
|
Show output in HTML format.
|
|
|
|
--idle-transaction-timeout=IDLE_TRANSACTION_TIMEOUT; default=60
|
|
Set the idle transaction timeout. The default timeout is 60 seconds.
|
|
|
|
--init-command=INIT_COMMAND
|
|
SQL statement to execute after startup.
|
|
|
|
--init-command-add=INIT_COMMAND_ADD
|
|
Additional SQL statement to execute after startup.
|
|
|
|
--port=PORT
|
|
Port number that gcloud uses to connect to Spanner.
|
|
|
|
--prompt=PROMPT; default="spanner-cli> "
|
|
Set the prompt to the specified format.
|
|
|
|
--skip-column-names
|
|
Do not show column names in output.
|
|
|
|
--skip-system-command
|
|
Do not allow system command.
|
|
|
|
--source=SOURCE
|
|
Execute the statement from a file and then exits.
|
|
|
|
--system-command=SYSTEM_COMMAND; default="ON"
|
|
Enable or disable system commands. Default: ON. SYSTEM_COMMAND must be
|
|
one of: ON, OFF.
|
|
|
|
--table
|
|
Show output in table format.
|
|
|
|
--tee=TEE
|
|
Append a copy of the output to a named file.
|
|
|
|
--xml
|
|
Show output in XML format.
|
|
|
|
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
|
|
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.
|
|
|