gcloud_alpha_firestore_indexes_composite_list (1)

NAME

gcloud alpha firestore indexes composite list - list composite indexes

SYNOPSIS

gcloud alpha firestore indexes composite list [--filter=EXPRESSION] [--limit=LIMIT] [--page-size=PAGE_SIZE] [--sort-by=[FIELD,...]] [--uri] [GCLOUD_WIDE_FLAG ...]

DESCRIPTION

(ALPHA) List composite indexes.

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.

GCLOUD WIDE FLAGS

These flags are available to all commands: --account, --configuration, --flags-file, --flatten, --format, --help, --log-http, --project, --quiet, --trace-token, --user-output-enabled, --verbosity. Run $ gcloud help for details.

API REFERENCE

This command uses the firestore/v1beta2 API. The full documentation for this API can be found at: cloud.google.com/firestore

EXAMPLES

The following command lists all composite indexes in the database:

$ gcloud alpha firestore indexes composite list

The following command lists composite indexes in the Events collection group:

$ gcloud alpha firestore indexes composite list \
    --filter=COLLECTION_GROUP:Events

NOTES

This command is currently in ALPHA and may change without notice. If this command fails with API permission errors despite specifying the right project, you will have to apply for early access and have your projects registered on the API whitelist to use it. To do so, contact Support at cloud.google.com/support This variant is also available:

$ gcloud beta firestore indexes composite list