NAME

gcloud firestore indexes fields list - list fields with non-default index settings

SYNOPSIS

gcloud firestore indexes fields list [--collection-group=COLLECTION_GROUP --database=DATABASE] [--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

$ gcloud firestore indexes fields list --database=(default)

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[titl\ e=INDEXES,box](fields.order.flatten(),fields.arrayConfig.flatten(),q\ ueryScope,state)')"

FLAGS

Collection group resource - Collection group of the index.

This can be omitted to include fields across all collection groups. 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;

—

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.

--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.

--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 [--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. 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