Console
    Contact Us Start free

    Cloud Firestore V1 Client - Class Index (1.53.0)

    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 \ V1

    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: 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< 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.

    ↳ density
    int

    Immutable. The density configuration of the index.

    ↳ multikey
    bool

    Optional. Whether the index is multikey. By default, the index is not multikey. For non-multikey indexes, none of the paths in the index definition reach or traverse an array, except via an explicit array index. For multikey indexes, at most one of the paths in the index definition reach or traverse an array, except via an explicit array index. Violations will result in errors. Note this field only applies to index with MONGODB_COMPATIBLE_API ApiScope.

    ↳ shard_count
    int

    Optional. The number of shards for 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

    getApiScope

    The API scope supported by this index.

    Returns
    Type
    Description
    int

    setApiScope

    The API scope supported by this index.

    Parameter
    Name
    Description
    var
    int
    Returns
    Type
    Description
    $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.

    Returns
    Type
    Description
    Google\Protobuf\Internal\RepeatedField

    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.

    Parameter
    Name
    Description
    var
    array< 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

    getDensity

    Immutable. The density configuration of the index.

    Returns
    Type
    Description
    int

    setDensity

    Immutable. The density configuration of the index.

    Parameter
    Name
    Description
    var
    int
    Returns
    Type
    Description
    $this

    getMultikey

    Optional. Whether the index is multikey. By default, the index is not multikey. For non-multikey indexes, none of the paths in the index definition reach or traverse an array, except via an explicit array index.

    For multikey indexes, at most one of the paths in the index definition reach or traverse an array, except via an explicit array index. Violations will result in errors. Note this field only applies to index with MONGODB_COMPATIBLE_API ApiScope.

    Returns
    Type
    Description
    bool

    setMultikey

    Optional. Whether the index is multikey. By default, the index is not multikey. For non-multikey indexes, none of the paths in the index definition reach or traverse an array, except via an explicit array index.

    For multikey indexes, at most one of the paths in the index definition reach or traverse an array, except via an explicit array index. Violations will result in errors. Note this field only applies to index with MONGODB_COMPATIBLE_API ApiScope.

    Parameter
    Name
    Description
    var
    bool
    Returns
    Type
    Description
    $this

    getShardCount

    Optional. The number of shards for the index.

    Returns
    Type
    Description
    int

    setShardCount

    Optional. The number of shards for the index.

    Parameter
    Name
    Description
    var
    int
    Returns
    Type
    Description
    $this
    Design a Mobile Site
    View Site in Mobile | Classic
    Share by: