gcloud firestore indexes fields describe

NAME
gcloud firestore indexes fields describe - describe the index configuration of the given field
SYNOPSIS
gcloud firestore indexes fields describe[[FIELD]--collection-group=COLLECTION_GROUP--database=DATABASE][GCLOUD_WIDE_FLAG …]
DESCRIPTION
Describe the index configuration of the given field.
EXAMPLES
The following command describes the database-wide default index settings:
gcloudfirestoreindexesfieldsdescribe
gcloudfirestoreindexesfieldsdescribe--database=(default)

The following command describes the index configuration of thetimestamp field in theEvents collection group.

gcloudfirestoreindexesfieldsdescribetimestamp--collection-group=Events
POSITIONAL ARGUMENTS
Field resource - Field to describe.

This can be omitted to describe the database-wide default index settings. 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 theproject attribute:

  • provide the argumentfield on the command line with a fullyspecified name;
  • with a fully specified name;
  • provide the argument--project on the command line;
  • set the propertycore/project.
[FIELD]
ID of the field or fully qualified identifier for the field.

To set thefield attribute:

  • provide the argumentfield on the command line;
  • .
--collection-group=COLLECTION_GROUP
Collection group of the field.To set thecollection-group attribute:
  • provide the argumentfield on the command line with a fullyspecified name;
  • with a fully specified name;
  • provide the argument--collection-group on the command line;
  • .
--database=DATABASE
Database of the field.To set thedatabase attribute:
  • provide the argumentfield on the command line with a fullyspecified name;
  • with a fully specified name;
  • provide the argument--database on the command line;
  • the default value of argument [--database] is(default).
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 thefirestore/v1 API. The full documentation forthis API can be found at:https://cloud.google.com/firestore
NOTES
These variants are also available:
gcloudalphafirestoreindexesfieldsdescribe
gcloudbetafirestoreindexesfieldsdescribe

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 2026-01-21 UTC.