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
Namespace
Google \ Cloud \ Firestore \ Admin \ V1Methods
__construct
Constructor.
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: projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{composite_index_id}
For single field indexes, this field will be empty.
↳ 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.
↳ api_scope
int
The API scope supported by this index.
↳ fields
array< Google\Cloud\Firestore\Admin\V1\Index\IndexField
>
The fields supported by this index. For composite indexes, this requires a minimum of 2 and a maximum of 100 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.
↳ 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.
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.
var
string
$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.
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.
var
int
$this
getApiScope
The API scope supported by this index.
int
setApiScope
The API scope supported by this index.
var
int
$this
getFields
The fields supported by this index.
For composite indexes, this requires a minimum of 2 and a maximum of 100
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.
setFields
The fields supported by this index.
For composite indexes, this requires a minimum of 2 and a maximum of 100
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.
$this
getState
Output only. The serving state of the index.
int
setState
Output only. The serving state of the index.
var
int
$this
