imjasonh/gcloud-help
1
0
Fork 0
mirror of https://github.com/imjasonh/gcloud-help synced 2026-07-20 21:20:07 +00:00
Code Activity

gcloud: Tue Mar 1 04:29:52 UTC 2022

Browse source
This commit is contained in:
Automated 2022-03-01 04:29:52 +00:00
parent aab53307a8
commit 1456dab6c7
9791 changed files with 814712 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

76
gcloud/firestore/indexes/fields/describe Normal file
View file

@ -0,0 +1,76 @@
NAME
gcloud firestore indexes fields describe - describe the index configuration
of the given field
SYNOPSIS
gcloud firestore indexes fields describe
[[FIELD] --collection-group=COLLECTION_GROUP] [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
Describe the index configuration of the given field.
EXAMPLES
The following command describes the database-wide default index settings:
$ gcloud firestore indexes fields describe
The following command describes the index configuration of the timestamp
field in the Events collection group.
$ gcloud firestore indexes fields describe timestamp \
--collection-group=Events
POSITIONAL ARGUMENTS
Field resource - Field to describe.
This can be omitted to describe the database-wide default index settings.
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 field on the command line with a fully specified
name;
◆ with a fully specified name;
◆ set the property core/project;
◆ provide the argument --project on the command line. To set the
database attribute:
◆ provide the argument field on the command line with a fully specified
name;
◆ with a fully specified name;
◆ provide the argument [--database] on the command line (currently
'(default)' is the only supported value).
[FIELD]
ID of the field or fully qualified identifier for the field. To set
the field attribute:
▸ provide the argument field on the command line;
▸ .
--collection-group=COLLECTION_GROUP
Collection group of the field.
To set the collection-group attribute:
▸ provide the argument field on the command line with a fully
specified name;
▸ with a fully specified name;
▸ provide the argument --collection-group on the command line;
▸ .
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.
API REFERENCE
This command uses the firestore/v1 API. The full documentation for this API
can be found at: https://cloud.google.com/firestore
NOTES
These variants are also available:
$ gcloud alpha firestore indexes fields describe
$ gcloud beta firestore indexes fields describe

35
gcloud/firestore/indexes/fields/help Normal file
View file

@ -0,0 +1,35 @@
NAME
gcloud firestore indexes fields - manage single-field indexes for Cloud
Firestore
SYNOPSIS
gcloud firestore indexes fields COMMAND [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
Changes here apply to index settings for individual fields, and won't
affect any composite indexes using those fields.
GCLOUD WIDE FLAGS
These flags are available to all commands: --help.
Run $ gcloud help for details.
COMMANDS
COMMAND is one of the following:
describe
Describe the index configuration of the given field.
list
List fields with non-default index settings.
update
Update the index configuration of the given field.
NOTES
These variants are also available:
$ gcloud alpha firestore indexes fields
$ gcloud beta firestore indexes fields

109
gcloud/firestore/indexes/fields/list Normal file
View file

@ -0,0 +1,109 @@
NAME
gcloud firestore indexes fields list - list fields with non-default index
settings
SYNOPSIS
gcloud firestore indexes fields list [--collection-group=COLLECTION_GROUP]
[--filter=EXPRESSION] [--limit=LIMIT] [--page-size=PAGE_SIZE]
[--sort-by=[FIELD,...]] [--uri] [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
List fields that have had their index configurations exempted from the
automatic settings. This includes the field describing the database-wide
default index settings, unless otherwise filtered out.
EXAMPLES
The following command lists all fields with custom index settings:
$ gcloud firestore indexes fields list
The following command lists fields with custom index settings in the Events
collection group:
$ gcloud firestore indexes fields list --collection-group=Events
The following command lists the indexes of all fields with custom index
settings:
$ gcloud firestore indexes fields list --format="table[box](\
name,indexConfig.indexes:format='table[title=INDEXES,box](\
fields.order.flatten(),fields.arrayConfig.flatten(),queryScope,state)')"
FLAGS
Collection group resource - Collection group of the index.
This can be omitted to include fields across all collection groups. This
represents a Cloud 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 --collection-group on the command line with a
fully specified name;
◆ provide the argument [--collection-group] on the command line with a
fully specified name;
◆ set the property core/project;
◆ provide the argument --project on the command line. To set the
database attribute:
◆ provide the argument --collection-group on the command line with a
fully specified name;
◆ provide the argument [--collection-group] on the command line with a
fully specified name;
◆ provide the argument [--database] on the command line (currently
'(default)' is the only supported value).
--collection-group=COLLECTION_GROUP
ID of the collection group or fully qualified identifier for the
collection group. To set the collection-group attribute:
▸ provide the argument --collection-group on the command line;
▸ provide the argument [--collection-group] on the command line.
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.
--uri
Print a list of resource URIs instead of the default output, and change
the command output to a list of URIs. If this flag is used with
--format, the formatting is applied on this URI list. To display URIs
alongside other keys instead, use the uri() transform.
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.
API REFERENCE
This command uses the firestore/v1 API. The full documentation for this API
can be found at: https://cloud.google.com/firestore
NOTES
These variants are also available:
$ gcloud alpha firestore indexes fields list
$ gcloud beta firestore indexes fields list

127
gcloud/firestore/indexes/fields/update Normal file
View file

@ -0,0 +1,127 @@
NAME
gcloud firestore indexes fields update - update the index configuration of
the given field
SYNOPSIS
gcloud firestore indexes fields update
(FIELD : --collection-group=COLLECTION_GROUP)
(--clear-exemption | --disable-indexes
| --index=[array-config=ARRAY-CONFIG],[order=ORDER]) [--async]
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
Update the index configuration of the given field.
This creates an exemption for the field in question, allowing one to modify
the field's index settings and override the defaults.
EXAMPLES
The following command creates an exemption for the timestamp field in the
Events collection group, in which all indexes are disabled:
$ gcloud firestore indexes fields update timestamp \
--collection-group=Events
--disable-indexes
The following command creates an exemption for the timestamp field in the
Events collection group, in which the list of indexes is explicitly set to
[ASCENDING, DESCENDING]:
$ gcloud firestore indexes fields update timestamp \
--collection-group=Events \
--index=order=ASCENDING \
--index=order=DESCENDING
The following command clears the exemption on the timestamp field in the
Events collection group, so that the field will return to inheriting its
index settings from its ancestors:
$ gcloud firestore indexes fields update timestamp \
--collection-group=Events --clear-exemption
POSITIONAL ARGUMENTS
Field resource - Field 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 field on the command line with a fully specified
name;
◆ set the property core/project;
◆ provide the argument --project on the command line. To set the
database attribute:
◆ provide the argument field on the command line with a fully specified
name;
◆ provide the argument [--database] on the command line (currently
'(default)' is the only supported value).
This must be specified.
FIELD
ID of the field or fully qualified identifier for the field. To set
the field attribute:
▸ provide the argument field on the command line.
This positional must be specified if any of the other arguments in
this group are specified.
--collection-group=COLLECTION_GROUP
Collection group of the field.
To set the collection-group attribute:
▸ provide the argument field on the command line with a fully
specified name;
▸ provide the argument --collection-group on the command line.
REQUIRED FLAGS
Exactly one of these must be specified:
--clear-exemption
If provided, the field's current index configuration will be reverted
to inherit from its ancestor index configurations.
--disable-indexes
If provided, the field will no longer be indexed at all.
--index=[array-config=ARRAY-CONFIG],[order=ORDER]
An index for the field.
This flag can be repeated to provide multiple indexes. Any existing
indexes will be overwritten with the ones provided. Any omitted
indexes will be deleted if they currently exist.
The following keys are allowed:
order
Specifies the order. Valid options are: 'ascending',
'descending'. Exactly one of 'order' or 'array-config' must be
specified.
array-config
Specifies the configuration for an array field. The only valid
option is 'contains'. Exactly one of 'order' or 'array-config'
must be specified.
OPTIONAL FLAGS
--async
Return immediately, without waiting for the operation in progress to
complete.
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.
API REFERENCE
This command uses the firestore/v1 API. The full documentation for this API
can be found at: https://cloud.google.com/firestore
NOTES
These variants are also available:
$ gcloud alpha firestore indexes fields update
$ gcloud beta firestore indexes fields update