gcloud_alpha_firestore_indexes_fields

gcloud_alpha_firestore_indexes_fields_update (1)

NAME

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

SYNOPSIS

gcloud alpha firestore indexes fields update (FIELD : --collection-group=COLLECTION_GROUP) (--clear-exemption | --disable-indexes | --index=[array-config=ARRAY-CONFIG],[order=ORDER]) [--async] [GCLOUD_WIDE_FLAG ...]

DESCRIPTION

(ALPHA) Update the index configuration of the given field.

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

POSITIONAL ARGUMENTS

Field resource - Field to update. 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; 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; provide the argument [--database] on the command line (currently '(default)' is the only supported value). This must be specified.

FIELD: ID of the field or fully qualified identifier for the field. This positional must be specified if any of the other arguments in this group are specified.
--collection-group=COLLECTION_GROUP: Collection group of the field.

REQUIRED FLAGS

Exactly one of these must be specified:

--clear-exemption

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

--disable-indexes

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

--index=[array-config=ARRAY-CONFIG],[order=ORDER]

An index for the field.
This flag can be repeated to provide multiple indexes. Any existing indexes will be overwritten with the ones provided. Any omitted indexes will be deleted if they currently exist. For example, to explicitly set the list of indexes for the tags field in the Events collection group to [ascending, contains], run:

: $ gcloud alpha firestore indexes fields update tags \
--collection-group=Events \
--index order=ascending --index array-config=contains

The following keys are allowed:

order: Specifies the order. Valid options are: 'ascending', 'descending'. Exactly one of '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.

OPTIONAL FLAGS

--async: Display information about the operation in progress, without waiting for the operation to complete.

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 creates an exemption for the timestamp field in the Events collection group, in which all indexes are disabled:

: $ gcloud alpha firestore indexes fields update timestamp \
--collection-group=Events
--disable-indexes

The following command creates an exemption for the timestamp field in the Events collection group, in which the list of indexes is explicitly set to [ASCENDING, DESCENDING]:

: $ gcloud alpha firestore indexes fields update timestamp \
    collection-group=Events \
    --index order=ASCENDING \
    --index order=DESCENDING

The following command clears the exemption on the timestamp field in the Events collection group, so that the field will return to inheriting its index settings from its ancestors:

: $ gcloud alpha firestore indexes fields update timestamp \
collection-group=Events --clear-exemption

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 update

gcloud_alpha_firestore_indexes_fields_update • man page

gcloud_alpha_firestore_indexes_fields_update • man page