Reference documentation and code samples for the Cloud Firestore V1 Client class Index.
Cloud Firestore indexes enable simple and complex queries against documents in a database.
Generated from protobuf message google.firestore.admin.v1.Index
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
Output only. A server defined name for this index. The form of this name for composite indexes will be: |
↳ query_scope |
int
Indexes with a collection query scope specified allow queries against a collection that is the child of a specific document, specified at query time, and that has the same collection id. Indexes with a collection group query scope specified allow queries against all collections descended from a specific document, specified at query time, and that have the same collection id as this index. |
↳ fields |
array<Google\Cloud\Firestore\Admin\V1\Index\IndexField>
The fields supported by this index. For composite indexes, this is always 2 or more fields. The last field entry is always for the field path |
↳ state |
int
Output only. The serving state of the index. |
getName
Output only. A server defined name for this index.
The form of this name for composite indexes will be:
projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{composite_index_id}
For single field indexes, this field will be empty.
| Returns | |
|---|---|
| Type | Description |
string | |
setName
Output only. A server defined name for this index.
The form of this name for composite indexes will be:
projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{composite_index_id}
For single field indexes, this field will be empty.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getQueryScope
Indexes with a collection query scope specified allow queries against a collection that is the child of a specific document, specified at query time, and that has the same collection id.
Indexes with a collection group query scope specified allow queries against all collections descended from a specific document, specified at query time, and that have the same collection id as this index.
| Returns | |
|---|---|
| Type | Description |
int | |
setQueryScope
Indexes with a collection query scope specified allow queries against a collection that is the child of a specific document, specified at query time, and that has the same collection id.
Indexes with a collection group query scope specified allow queries against all collections descended from a specific document, specified at query time, and that have the same collection id as this index.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getFields
The fields supported by this index.
For composite indexes, this is always 2 or more fields.
The last field entry is always for the field path __name__. If, on
creation, __name__ was not specified as the last field, it will be added
automatically with the same direction as that of the last field defined. If
the final field in a composite index is not directional, the __name__
will be ordered ASCENDING (unless explicitly specified).
For single field indexes, this will always be exactly one entry with a
field path equal to the field path of the associated field.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField | |
setFields
The fields supported by this index.
For composite indexes, this is always 2 or more fields.
The last field entry is always for the field path __name__. If, on
creation, __name__ was not specified as the last field, it will be added
automatically with the same direction as that of the last field defined. If
the final field in a composite index is not directional, the __name__
will be ordered ASCENDING (unless explicitly specified).
For single field indexes, this will always be exactly one entry with a
field path equal to the field path of the associated field.
| Parameter | |
|---|---|
| Name | Description |
var |
array<Google\Cloud\Firestore\Admin\V1\Index\IndexField>
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getState
Output only. The serving state of the index.
| Returns | |
|---|---|
| Type | Description |
int | |
setState
Output only. The serving state of the index.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |