imjasonh/gcloud-help
1
0
Fork 0
mirror of https://github.com/imjasonh/gcloud-help synced 2026-07-18 23:08:48 +00:00
Code Activity

gcloud: Thu Jan 19 00:56:33 UTC 2023

Browse source
This commit is contained in:
Automated 2023-01-19 00:56:33 +00:00
parent 348d9760ee
commit 1248f773ec
1462 changed files with 51835 additions and 5402 deletions
Download patch file Download diff file Expand all files Collapse all files

59
gcloud/firestore/indexes/composite/create
View file

@ -2,9 +2,9 @@ NAME
gcloud firestore indexes composite create - create a new composite index
SYNOPSIS
gcloud firestore indexes composite create
--collection-group=COLLECTION_GROUP --field-config=FIELD_CONFIG
[--async] [GCLOUD_WIDE_FLAG ...]
gcloud firestore indexes composite create --field-config=FIELD_CONFIG
(--collection-group=COLLECTION_GROUP : --database=DATABASE) [--async]
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
Create a new composite index.
@ -19,27 +19,12 @@ EXAMPLES
--field-config=field-path=user-id,order=descending \
--field-config=field-path=timestamp,order=descending
$ gcloud firestore indexes composite create --database=(default) \
--collection-group=Events \
--field-config=field-path=user-id,order=descending \
--field-config=field-path=timestamp,order=descending
REQUIRED FLAGS
Collection group resource - Collection group of the index. 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;
◆ 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 [--database] on the command line (currently
'(default)' is the only supported value).
This must be specified.
--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.
--field-config=FIELD_CONFIG
Configuration for a field.
@ -66,6 +51,34 @@ REQUIRED FLAGS
option is 'contains'. Exactly one of 'order' or 'array-config' must
be specified.
Collection group resource - Collection group of the index. 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 --collection-group on the command line with a
fully specified name;
◆ set the property core/project;
◆ provide the argument --project on the command line.
This must be specified.
--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.
This flag argument must be specified if any of the other arguments in
this group are specified.
--database=DATABASE
Database of the collection group.
To set the database attribute:
▸ provide the argument --collection-group on the command line with
a fully specified name;
▸ provide the argument --database on the command line;
▸ the default value of argument [--database] is (default).
OPTIONAL FLAGS
--async
Return immediately, without waiting for the operation in progress to

32
gcloud/firestore/indexes/composite/delete
View file

@ -3,7 +3,8 @@ NAME
index
SYNOPSIS
gcloud firestore indexes composite delete INDEX [GCLOUD_WIDE_FLAG ...]
gcloud firestore indexes composite delete (INDEX : --database=DATABASE)
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
Delete the given composite index.
@ -13,20 +14,19 @@ EXAMPLES
$ gcloud firestore indexes composite delete 3421ef
$ gcloud firestore indexes composite delete 3421ef \
--database=(default)
POSITIONAL ARGUMENTS
Composite index resource - Index to delete. 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:
Composite index resource - Index 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 index 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 index on the command line with a fully specified
name;
◆ provide the argument [--database] on the command line (currently
'(default)' is the only supported value). To set the collection-group
attribute:
collection-group attribute:
◆ provide the argument index on the command line with a fully specified
name;
◆ provide the argument [--collection-group] on the command line.
@ -38,6 +38,18 @@ POSITIONAL ARGUMENTS
composite index. To set the index attribute:
▸ provide the argument index on the command line.
This positional argument must be specified if any of the other
arguments in this group are specified.
--database=DATABASE
Database of the composite index.
To set the database attribute:
▸ provide the argument index on the command line with a fully
specified name;
▸ provide the argument --database on the command line;
▸ the default value of argument [--database] is (default).
GCLOUD WIDE FLAGS
These flags are available to all commands: --access-token-file, --account,
--billing-project, --configuration, --flags-file, --flatten, --format,

32
gcloud/firestore/indexes/composite/describe
View file

@ -3,7 +3,8 @@ NAME
index
SYNOPSIS
gcloud firestore indexes composite describe INDEX [GCLOUD_WIDE_FLAG ...]
gcloud firestore indexes composite describe (INDEX : --database=DATABASE)
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
Describe the given composite index.
@ -13,20 +14,19 @@ EXAMPLES
$ gcloud firestore indexes composite describe 3421ef
$ gcloud firestore indexes composite describe 3421ef \
--database=(default)
POSITIONAL ARGUMENTS
Composite index resource - Index to describe. 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:
Composite index resource - Index 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 index 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 index on the command line with a fully specified
name;
◆ provide the argument [--database] on the command line (currently
'(default)' is the only supported value). To set the collection-group
attribute:
collection-group attribute:
◆ provide the argument index on the command line with a fully specified
name;
◆ provide the argument [--collection-group] on the command line.
@ -38,6 +38,18 @@ POSITIONAL ARGUMENTS
composite index. To set the index attribute:
▸ provide the argument index on the command line.
This positional argument must be specified if any of the other
arguments in this group are specified.
--database=DATABASE
Database of the composite index.
To set the database attribute:
▸ provide the argument index on the command line with a fully
specified name;
▸ provide the argument --database on the command line;
▸ the default value of argument [--database] is (default).
GCLOUD WIDE FLAGS
These flags are available to all commands: --access-token-file, --account,
--billing-project, --configuration, --flags-file, --flatten, --format,

28
gcloud/firestore/indexes/composite/list
View file

@ -2,9 +2,9 @@ NAME
gcloud firestore indexes composite list - list composite indexes
SYNOPSIS
gcloud firestore indexes composite list [--filter=EXPRESSION]
[--limit=LIMIT] [--page-size=PAGE_SIZE] [--sort-by=[FIELD,...]] [--uri]
[GCLOUD_WIDE_FLAG ...]
gcloud firestore indexes composite list [--database=DATABASE]
[--filter=EXPRESSION] [--limit=LIMIT] [--page-size=PAGE_SIZE]
[--sort-by=[FIELD,...]] [--uri] [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
List composite indexes.
@ -14,12 +14,34 @@ EXAMPLES
$ gcloud firestore indexes composite list
$ gcloud firestore indexes composite list --database=(default)
The following command lists composite indexes in the Events collection
group:
$ gcloud firestore indexes composite list \
--filter=COLLECTION_GROUP:Events
FLAGS
Collection group resource - Collection group of the index. 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;
◆ set the property core/project;
◆ provide the argument --project on the command line. To set the
collection-group attribute:
◆ provide the argument [--collection-group] on the command line.
--database=DATABASE
Database of the collection group.
To set the database attribute:
▸ provide the argument [--collection-group] on the command line
with a fully specified name;
▸ provide the argument --database on the command line;
▸ the default value of argument [--database] is (default).
LIST COMMAND FLAGS
--filter=EXPRESSION
Apply a Boolean filter EXPRESSION to each resource item to be listed.