gcloud beta firestore indexes fields list Stay organized with collections Save and categorize content based on your preferences.
- NAME
- gcloud beta firestore indexes fields list - list fields with non-default index settings
- SYNOPSIS
gcloud beta 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
(BETA)List fields that have had their index configurationsexempted from the automatic settings. This includes the field describing thedatabase-wide default index settings, unless otherwise filtered out.- EXAMPLES
- The following command lists all fields with custom index settings:
gcloudbetafirestoreindexesfieldslistgcloudbetafirestoreindexesfieldslist--database=(default)The following command lists fields with custom index settings in the
Eventscollection group:gcloudbetafirestoreindexesfieldslist--collection-group=EventsThe following command lists the indexes of all fields with custom indexsettings:
gcloudbetafirestoreindexesfieldslist--format="table[box](name,indexConfig.indexes:format='table[title=INDEXES,box](fields.order.flatten(),fields.arrayConfig.flatten(),queryScope,state)')" - FLAGS
- Collection group resource - Collection group of the index.
This can be omitted to include fields across all collection groups. Thearguments 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 inother ways.
To set the
projectattribute:- provide the argument
--collection-groupon the command line with afully specified name; - provide the argument [--collection-group] on the command line with a fullyspecified name;
- provide the argument
--projecton the command line; - set the property
core/project.
--collection-group=COLLECTION_GROUP- ID of the collection group or fully qualified identifier for the collectiongroup.
To set the
collection-groupattribute:- provide the argument
--collection-groupon the command line; - provide the argument [--collection-group] on the command line.
- provide the argument
--database=DATABASE- Database of the collection group.To set the
databaseattribute:- provide the argument
--collection-groupon the command line with afully specified name; - provide the argument [--collection-group] on the command line with a fullyspecified name;
- provide the argument
--databaseon the command line; - the default value of argument [--database] is
(default).
- provide the argument
- provide the argument
- Collection group resource - Collection group of the index.
- LIST COMMAND FLAGS
--filter=EXPRESSION- Apply a Boolean filter
EXPRESSIONto each resource itemto be listed. If the expression evaluatesTrue, then that item islisted. For more details and examples of filter expressions, run $gcloud topic filters. This flaginteracts 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. Thisflag 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 themaximum number of resources per page. The default is determined by the serviceif it supports paging, otherwise it is
unlimited(no paging).Paging may be applied before or after--filterand--limitdepending on the service. --sort-by=[FIELD,…]- Comma-separated list of resource field key names to sort by. The default orderis ascending. Prefix a field with ``~´´ for descending order on thatfield. 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 thecommand output to a list of URIs. If this flag is used with
--format, the formatting is applied on this URI list. To displayURIs 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 helpfor details. - API REFERENCE
- This command uses the
firestore/v1API. The full documentation forthis API can be found at:https://cloud.google.com/firestore - NOTES
- This command is currently in beta and might change without notice. Thesevariants are also available:
gcloudfirestoreindexesfieldslistgcloudalphafirestoreindexesfieldslist
Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-05-07 UTC.