gcloud firestore indexes fields update - update the index configuration of the given field

gcloud firestore indexes fields update(FIELD :--collection-group=COLLECTION_GROUP--database=DATABASE)(--clear-exemption    |--disable-indexes    |--index=[KEY=VALUE,…])[--async][GCLOUD_WIDE_FLAG …]

This creates an exemption for the field in question, allowing one to modify thefield's index settings and override the defaults.

gcloudfirestoreindexesfieldsupdatetimestamp--collection-group=Events--disable-indexes

gcloudfirestoreindexesfieldsupdatetimestamp--database=(default)--collection-group=Events--disable-indexes

The following command creates an exemption for thetimestamp fieldin theEvents collection group, in which the list of indexes isexplicitly set to [ASCENDING, DESCENDING]:

gcloudfirestoreindexesfieldsupdatetimestamp--collection-group=Events--index=order=ASCENDING--index=order=DESCENDING

The following command clears the exemption on thetimestamp fieldin theEvents collection group, so that the field will return toinheriting its index settings from its ancestors:

gcloudfirestoreindexesfieldsupdatetimestamp--collection-group=Events--clear-exemption

Field resource - Field to update. The arguments in this group can be used tospecify the attributes of this resource. (NOTE) Some attributes are not givenarguments in this group but can be set in other ways.

To set theproject attribute:

• provide the argumentfield on the command line with a fullyspecified name;
• provide the argument--project on the command line;
• set the propertycore/project.

This must be specified.

FIELD

ID of the field or fully qualified identifier for the field.

To set thefield attribute:

• provide the argumentfield on the command line.

This positional argument must be specified if any of the other arguments in thisgroup are specified.

--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;
• 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;
• provide the argument--database on the command line;
• the default value of argument [--database] is(default).

Exactly one of these must be specified:

--clear-exemption

If provided, the field's current index configuration will be reverted to inheritfrom its ancestor index configurations.

--disable-indexes

If provided, the field will no longer be indexed at all.

--index=[KEY=VALUE,…]

An index for the field.

This flag can be repeated to provide multiple indexes. Any existing indexes willbe overwritten with the ones provided. Any omitted indexes will be deleted ifthey currently exist.

The following keys are allowed:

order

Specifies the order. Valid options are: 'ascending', 'descending'. Exactly oneof 'order' or 'array-config' must be specified.

array-config

Specifies the configuration for an array field. The only valid option is'contains'. Exactly one of 'order' or 'array-config' must be specified.

--async

Return immediately, without waiting for the operation in progress to complete.

Run$gcloud help for details.