1
0
Fork 0
mirror of https://github.com/imjasonh/gcloud-help synced 2026-07-08 10:35:03 +00:00

gcloud: Wed May 7 10:56:18 UTC 2025

This commit is contained in:
Automated 2025-05-07 10:56:18 +00:00
parent b03a332ad8
commit dfebca5b6c
222 changed files with 6775 additions and 1046 deletions

View file

@ -27,6 +27,9 @@ GROUPS
sessions
(ALPHA) Manage the sessions for Cloud Spanner databases.
splits
(ALPHA) Manage the split points for Spanner databases.
COMMANDS
COMMAND is one of the following:

View file

@ -0,0 +1,88 @@
NAME
gcloud alpha spanner databases splits add - add split points to a Spanner
database
SYNOPSIS
gcloud alpha spanner databases splits add (DATABASE : --instance=INSTANCE)
--splits-file=SPLITS_FILE [--initiator=INITIATOR]
[--split-expiration-date=SPLIT_EXPIRATION_DATE] [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) Add split points to a Spanner database.
EXAMPLES
To add split points to the given Spanner database, run:
$ gcloud alpha spanner databases splits add my-database-id \
--instance=my-instance-id --splits-file=path/to/splits.txt \
--initiator=my-initiator-string \
--split-expiration-date=2024-08-15T15:55:10Z
POSITIONAL ARGUMENTS
Database resource - The Cloud Spanner database on which to add split
points. 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.
REQUIRED FLAGS
--splits-file=SPLITS_FILE
The path of a file containing split points to add to the database.
Separate split points in the file with a new line. The file format is
<ObjectType>[space]<ObjectName>[space]<Split Value>, where the
ObjectType is one of TABLE or INDEX and the Split Value is the split
point key. For index, the split point key is the index key with or
without a full table key prefix.
OPTIONAL FLAGS
--initiator=INITIATOR
The tag to identify the initiator of the split points.
--split-expiration-date=SPLIT_EXPIRATION_DATE
The date when the split points become system managed and becomes
eligible for merging. The default is 10 days from the date of creation.
The maximum is 30 days from the date of creation.
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. These variants are also available:
$ gcloud spanner databases splits add
$ gcloud beta spanner databases splits add

View file

@ -0,0 +1,35 @@
NAME
gcloud alpha spanner databases splits - manage the split points for Spanner
databases
SYNOPSIS
gcloud alpha spanner databases splits COMMAND [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) Manage the split points for Spanner databases.
GCLOUD WIDE FLAGS
These flags are available to all commands: --help.
Run $ gcloud help for details.
COMMANDS
COMMAND is one of the following:
add
(ALPHA) Add split points to a Spanner database.
list
(ALPHA) List split points that are added by a user to a Spanner
database.
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:
$ gcloud spanner databases splits
$ gcloud beta spanner databases splits

View file

@ -0,0 +1,94 @@
NAME
gcloud alpha spanner databases splits list - list split points that are
added by a user to a Spanner database
SYNOPSIS
gcloud alpha spanner databases splits list (DATABASE : --instance=INSTANCE)
[--filter=EXPRESSION] [--limit=LIMIT] [--page-size=PAGE_SIZE]
[--sort-by=[FIELD,...]] [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) List split points that are added by a user to a Spanner database.
EXAMPLES
To list the user added split points of the given Spanner database, run:
$ gcloud alpha spanner databases splits list my-database-id \
--instance=my-instance-id
POSITIONAL ARGUMENTS
Database resource - The Cloud Spanner database on which to list split
points. 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.
LIST COMMAND FLAGS
--filter=EXPRESSION
Apply a Boolean filter EXPRESSION to each resource item to be listed.
If the expression evaluates True, then that item is listed. For more
details and examples of filter expressions, run $ gcloud topic filters.
This flag interacts with other flags that are applied in this order:
--flatten, --sort-by, --filter, --limit.
--limit=LIMIT
Maximum number of resources to list. The default is unlimited. This
flag interacts with other flags that are applied in this order:
--flatten, --sort-by, --filter, --limit.
--page-size=PAGE_SIZE
Some services group resource list output into pages. This flag
specifies the maximum number of resources per page. The default is
determined by the service if it supports paging, otherwise it is
unlimited (no paging). Paging may be applied before or after --filter
and --limit depending on the service.
--sort-by=[FIELD,...]
Comma-separated list of resource field key names to sort by. The
default order is ascending. Prefix a field with ``~'' for descending
order on that field. This flag interacts with other flags that are
applied in this order: --flatten, --sort-by, --filter, --limit.
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. These variants are also available:
$ gcloud spanner databases splits list
$ gcloud beta spanner databases splits list

View file

@ -28,7 +28,7 @@ GROUPS
(ALPHA) Manage Cloud Spanner instance configs.
instance-partitions
(ALPHA) Manage Cloud Spanner instance partitions.
(ALPHA) Manage Spanner instance partitions.
instances
(ALPHA) Manage Cloud Spanner instances.

View file

@ -1,6 +1,6 @@
NAME
gcloud alpha spanner instance-partitions create - create a Cloud Spanner
instance partition
gcloud alpha spanner instance-partitions create - create a Spanner instance
partition
SYNOPSIS
gcloud alpha spanner instance-partitions create
@ -10,10 +10,10 @@ SYNOPSIS
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) Create a Cloud Spanner instance partition.
(ALPHA) Create a Spanner instance partition.
EXAMPLES
To create a Cloud Spanner instance partition, run:
To create a Spanner instance partition, run:
$ gcloud alpha spanner instance-partitions create \
my-instance-partition-id --instance=my-instance-id \
@ -21,10 +21,10 @@ EXAMPLES
--description=my-instance-display-name --nodes=3
POSITIONAL ARGUMENTS
Instance partition resource - The Cloud Spanner instance partition to
create. 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.
Instance partition resource - The Spanner instance partition to create.
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 instance_partition on the command line with a
@ -35,17 +35,17 @@ POSITIONAL ARGUMENTS
This must be specified.
INSTANCE_PARTITION
ID of the instance-partition or fully qualified identifier for the
instance-partition.
ID of the instance partition or fully qualified identifier for the
instance partition.
To set the instance-partition attribute:
To set the instance partition attribute:
▸ provide the argument instance_partition 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 instance-partition.
The Cloud Spanner instance for the instance partition.
To set the instance attribute:
▸ provide the argument instance_partition on the command line with
@ -87,7 +87,9 @@ 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. This variant is also available:
access allowlist. These variants are also available:
$ gcloud spanner instance-partitions create
$ gcloud beta spanner instance-partitions create

View file

@ -1,25 +1,25 @@
NAME
gcloud alpha spanner instance-partitions delete - delete a Cloud Spanner
instance partition
gcloud alpha spanner instance-partitions delete - delete a Spanner instance
partition
SYNOPSIS
gcloud alpha spanner instance-partitions delete
(INSTANCE_PARTITION : --instance=INSTANCE) [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) Delete a Cloud Spanner instance partition.
(ALPHA) Delete a Spanner instance partition.
EXAMPLES
To delete a Cloud Spanner instance partition, run:
To delete a Spanner instance partition, run:
$ gcloud alpha spanner instance-partitions delete \
my-instance-partition-id --instance=my-instance-id
POSITIONAL ARGUMENTS
Instance partition resource - The Cloud Spanner instance partition to
delete. 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.
Instance partition resource - The Spanner instance partition to delete.
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 instance_partition on the command line with a
@ -30,17 +30,17 @@ POSITIONAL ARGUMENTS
This must be specified.
INSTANCE_PARTITION
ID of the instance-partition or fully qualified identifier for the
instance-partition.
ID of the instance partition or fully qualified identifier for the
instance partition.
To set the instance-partition attribute:
To set the instance partition attribute:
▸ provide the argument instance_partition 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 instance-partition.
The Cloud Spanner instance for the instance partition.
To set the instance attribute:
▸ provide the argument instance_partition on the command line with
@ -60,7 +60,9 @@ 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. This variant is also available:
access allowlist. These variants are also available:
$ gcloud spanner instance-partitions delete
$ gcloud beta spanner instance-partitions delete

View file

@ -16,10 +16,10 @@ EXAMPLES
my-instance-partition-id --instance=my-instance-id
POSITIONAL ARGUMENTS
Instance partition resource - The Cloud Spanner instance partition to
describe. 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.
Instance partition resource - The Spanner instance partition to describe.
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 instance_partition on the command line with a
@ -30,17 +30,17 @@ POSITIONAL ARGUMENTS
This must be specified.
INSTANCE_PARTITION
ID of the instance-partition or fully qualified identifier for the
instance-partition.
ID of the instance partition or fully qualified identifier for the
instance partition.
To set the instance-partition attribute:
To set the instance partition attribute:
▸ provide the argument instance_partition 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 instance-partition.
The Cloud Spanner instance for the instance partition.
To set the instance attribute:
▸ provide the argument instance_partition on the command line with

View file

@ -1,12 +1,12 @@
NAME
gcloud alpha spanner instance-partitions - manage Cloud Spanner instance
gcloud alpha spanner instance-partitions - manage Spanner instance
partitions
SYNOPSIS
gcloud alpha spanner instance-partitions COMMAND [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) Manage Cloud Spanner instance partitions.
(ALPHA) Manage Spanner instance partitions.
GCLOUD WIDE FLAGS
These flags are available to all commands: --help.
@ -17,10 +17,10 @@ COMMANDS
COMMAND is one of the following:
create
(ALPHA) Create a Cloud Spanner instance partition.
(ALPHA) Create a Spanner instance partition.
delete
(ALPHA) Delete a Cloud Spanner instance partition.
(ALPHA) Delete a Spanner instance partition.
describe
(ALPHA) Describe a Cloud Spanner instance partition.
@ -36,7 +36,9 @@ 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. This variant is also available:
access allowlist. These variants are also available:
$ gcloud spanner instance-partitions
$ gcloud beta spanner instance-partitions

View file

@ -25,10 +25,10 @@ EXAMPLES
my-instance-partition-id --instance=my-instance-id --nodes=1
POSITIONAL ARGUMENTS
Instance partition resource - The Cloud Spanner instance partition to
update. 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.
Instance partition resource - The Spanner instance partition to update.
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 instance_partition on the command line with a
@ -39,17 +39,17 @@ POSITIONAL ARGUMENTS
This must be specified.
INSTANCE_PARTITION
ID of the instance-partition or fully qualified identifier for the
instance-partition.
ID of the instance partition or fully qualified identifier for the
instance partition.
To set the instance-partition attribute:
To set the instance partition attribute:
▸ provide the argument instance_partition 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 instance-partition.
The Cloud Spanner instance for the instance partition.
To set the instance attribute:
▸ provide the argument instance_partition on the command line with