gcloud_alpha_firestore_indexes_composite_create (1)

NAME

gcloud alpha firestore indexes composite create - create a new composite index

SYNOPSIS

gcloud alpha firestore indexes composite create --collection-group=COLLECTION_GROUP --field-config=FIELD_CONFIG [--async] [GCLOUD_WIDE_FLAG ...]

DESCRIPTION

(ALPHA) Create a new composite index.

REQUIRED FLAGS

Collection group resource - Collection group of the index. This represents a Cloud 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 [--collection-group] 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 [--collection-group] 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.

--collection-group=COLLECTION_GROUP

ID of the collection group or fully qualified identifier for the collection group.

--field-config=FIELD_CONFIG

Configuration for a field.
This flag must be repeated to provide the ordered list of field configurations comprising the composite index. For example:

$ gcloud alpha firestore indexes composite create \
    --collection-group=Events \
    --field-config field-path=tags,array-config=contains \
    --field-config field-path=user_id,order=descending \
    --field-config field-path=timestamp,order=descending

The following keys are allowed:

field-path

Specifies the field path (e.g. 'address.city'). This is required.

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 a composite index with fields user_id (in descending order) followed by timestamp (in descending order) in the Events collection group.

$ gcloud alpha firestore indexes composite create \
    --collection-group=Events \
    --field-config field-path=user-id,order=descending \
    --field-config field-path=timestamp,order=descending

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 composite create