- NAME
-
- gcloud firestore indexes composite create - create a new composite index
- SYNOPSIS
-
-
gcloud firestore indexes composite create
--field-config
=[array-config
=ARRAY-CONFIG
],[field-path
=FIELD-PATH
],[order
=ORDER
],[vector-config
=VECTOR-CONFIG
] (--collection-group
=COLLECTION_GROUP
:--database
=DATABASE
) [--api-scope
=API_SCOPE
; default="any-api"] [--async
] [--query-scope
=QUERY_SCOPE
; default="collection"] [GCLOUD_WIDE_FLAG …
]
-
- DESCRIPTION
- Create a new composite index.
- EXAMPLES
-
The following command creates a composite index with fields
user_id
(in descending order) followed bytimestamp
(in descending order) in theEvents
collection group.gcloud firestore indexes composite create --collection-group=Events --field-config=field-path=user-id,order=descending --field-config=field-path=timestamp,order=descending
gcloud firestore indexes composite create --database=(default) --collection-group=Events --field-config=field-path=user-id,order=descending --field-config=field-path=timestamp,order=descending
- REQUIRED FLAGS
-
--field-config
=[array-config
=ARRAY-CONFIG
],[field-path
=FIELD-PATH
],[order
=ORDER
],[vector-config
=VECTOR-CONFIG
]-
Required, Configuration for an index field.
array-config
- Specifies the configuration for an array field. The only valid option is 'contains'. Exactly one of 'order', 'array-config', or 'vector-config' must be specified.
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', 'array-config', or 'vector-config' must be specified.
vector-config
-
Specifies the configuration for a vector field. Exactly one of 'order',
'array-config', or 'vector-config' must be specified.
dimension
-
Sets
dimension
value. flat
-
Sets
flat
value.
Shorthand Example:
--field-config='array-config=string,field-path=string,order=string,vector-config={"dimension": int, "flat": {"string"}}' --field-config='array-config=string,field-path=string,order=string,vector-config={"dimension": int, "flat": {"string"}}'
JSON Example:
--field-config='[{"array-config": "string", "field-path": "string", "order": "string", "vector-config": {"dimension": int, "flat": {"string"}}}]'
File Example:
--field-config=path_to_file.(yaml|json)
-
Collection group resource - Collection group of the index. 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
--collection-group
on the command line with a fully specified name; -
provide the argument
--project
on the command line; -
set the property
core/project
.
This must be specified.
--collection-group
=COLLECTION_GROUP
-
ID of the collection group or fully qualified identifier for the collection
group.
To set the
collection-group
attribute:-
provide the argument
--collection-group
on the command line.
This flag argument must be specified if any of the other arguments in this group are specified.
-
provide the argument
--database
=DATABASE
-
Database of the collection group.
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; -
the default value of argument [--database] is
(default)
.
-
provide the argument
-
provide the argument
- OPTIONAL FLAGS
-
--api-scope
=API_SCOPE
; default="any-api"-
Api scope the index applies to.
API_SCOPE
must be one of:any-api
,datastore-mode-api
. --async
- Return immediately, without waiting for the operation in progress to complete.
--query-scope
=QUERY_SCOPE
; default="collection"-
Query scope the index applies to.
QUERY_SCOPE
must be one of:collection
,collection-group
,collection-recursive
.
- 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 help
for details. - API REFERENCE
-
This command uses the
firestore/v1
API. 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 composite create
gcloud beta firestore indexes composite create
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 2024-08-20 UTC.