- 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:
gcloud firestore indexes fields describegcloud firestore indexes fields describe --database=(default)The following command describes the index configuration of the
timestampfield in theEventscollection group.gcloud firestore indexes fields describe timestamp --collection-group=Events - POSITIONAL ARGUMENTS
-
-
Field resource - Field to describe.
This can be omitted to describe the database-wide default index settings. 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
projectattribute:-
provide the argument
fieldon the command line with a fully specified name; - with a fully specified name;
-
provide the argument
--projecton the command line; -
set the property
core/project.
- [
FIELD] -
ID of the field or fully qualified identifier for the field.
To set the
fieldattribute:-
provide the argument
fieldon the command line; - .
-
provide the argument
--collection-group=COLLECTION_GROUP-
Collection group of the field.
To set the
collection-groupattribute:-
provide the argument
fieldon the command line with a fully specified name; - with a fully specified name;
-
provide the argument
--collection-groupon the command line; - .
-
provide the argument
--database=DATABASE-
Database of the field.
To set the
databaseattribute:-
provide the argument
fieldon the command line with a fully specified name; - with a fully specified name;
-
provide the argument
--databaseon the command line; -
the default value of argument [--database] is
(default).
-
provide the argument
-
provide the argument
-
Field resource - Field to describe.
- 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 for this API can be found at: https://cloud.google.com/firestore - NOTES
-
These variants are also available:
gcloud alpha firestore indexes fields describegcloud beta firestore indexes fields describe
gcloud firestore indexes fields describe
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-05-07 UTC.