gcloud_alpha_firestore_indexes_fields_describe (1)
NAME
- gcloud alpha firestore indexes fields describe - describe the index configuration of the given field
SYNOPSIS
-
gcloud alpha firestore indexes fields describe [[FIELD] --collection-group=COLLECTION_GROUP] [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) Describe the index configuration of the given field.
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 [project] attribute: provide the argument [field] on the command line with a fully specified name; with a fully specified name; set the property [core/project]; provide the argument [--project] on the command line. To set the [database] attribute: provide the argument [field] on the command line with a fully specified name; with a fully specified name; provide the argument [--database] on the command line (currently '(default)' is the only supported value).
-
- [FIELD]
-
ID of the field or fully qualified identifier for the field.
- --collection-group=COLLECTION_GROUP
-
Collection group of the field.
- 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 [project] attribute: provide the argument [field] on the command line with a fully specified name; with a fully specified name; set the property [core/project]; provide the argument [--project] on the command line. To set the [database] attribute: provide the argument [field] on the command line with a fully specified name; with a fully specified name; provide the argument [--database] on the command line (currently '(default)' is the only supported value).
-
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 describes the database-wide default index settings:
- $ gcloud alpha firestore indexes fields describe
The following command describes the index configuration of the timestamp field in the Events collection group.
-
$ gcloud alpha firestore indexes fields describe timestamp \
--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 fields describe