- NAME
-
- gcloud firestore indexes composite list - list composite indexes
- SYNOPSIS
-
-
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.
- EXAMPLES
-
The following command lists all composite indexes in the database:
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;
-
provide the argument
--project
on the command line; -
set the property
core/project
.
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)
.
-
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.
- LIST COMMAND FLAGS
-
--filter
=EXPRESSION
-
Apply a Boolean filter
EXPRESSION
to each resource item to be listed. If the expression evaluatesTrue
, 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 theuri()
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 composite list
gcloud beta firestore indexes composite list
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-07-30 UTC.