gcloud alpha firestore indexes composite list - list composite indexes
gcloud alpha firestore indexes composite list [--database=DATABASE] [--filter=EXPRESSION] [--limit=LIMIT] [--page-size=PAGE_SIZE] [--sort-by=[FIELD,...]] [--uri] [GCLOUD_WIDE_FLAG ...]
(ALPHA) List composite indexes.
The following command lists all composite indexes in the database:
$ gcloud alpha firestore indexes composite list
$ gcloud alpha firestore indexes composite list --database=(default)
The following command lists composite indexes in the Events collection group:
$ gcloud alpha firestore indexes composite list \ --filter=COLLECTION_GROUP:Events
- 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).
- --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.
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.
This command uses the firestore/v1 API. The full documentation for this API can be found at: https://cloud.google.com/firestore
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 firestore indexes composite list
$ gcloud beta firestore indexes composite list