Package Classes (2.17.0)

Summary of entries of Classes for firestore.

Classes

FirestoreAdminClient

The Cloud Firestore Admin API.

This API provides several administrative services for Cloud Firestore.

Project, Database, Namespace, Collection, Collection Group, and Document are used as defined in the Google Cloud Firestore API.

Operation: An Operation represents work being performed in the background.

The index service manages Cloud Firestore indexes.

Index creation is performed asynchronously. An Operation resource is created for each such asynchronous operation. The state of the operation (including any errors encountered) may be queried via the Operation resource.

The Operations collection provides a record of actions performed for the specified Project (including any Operations in progress). Operations are not created directly but through calls on other collections or resources.

An Operation that is done may be deleted so that it is no longer listed as part of the Operation collection. Operations are garbage collected after 30 days. By default, ListOperations will only return in progress and failed operations. To list completed operation, issue a ListOperations request with the filter done: true.

Operations are created by service FirestoreAdmin, but are accessed via service google.longrunning.Operations.

FirestoreBundle

A group of serialized documents and queries, suitable for longterm storage or query resumption.

If any queries are added to this bundle, all associated documents will be loaded and stored in memory for serialization.

Usage:

from google.cloud.firestore import Client, _helpers
from google.cloud.firestore_bundle import FirestoreBundle

db = Client()
bundle = FirestoreBundle('my-bundle')
bundle.add_named_query('all-users', db.collection('users')._query())
bundle.add_named_query(
    'top-ten-hamburgers',
    db.collection('hamburgers').limit(limit=10),
)
serialized: str = bundle.build()

# Store somewhere like a Google Cloud Storage bucket for retrieval by
# a client SDK.

AggregationQuery

Represents an aggregation query to the Firestore API.

AsyncAggregationQuery

Represents an aggregation query to the Firestore API.

AsyncWriteBatch

Accumulate write operations to be sent in a batch.

This has the same set of methods for write operations that xref_AsyncDocumentReference does, e.g. xref_create.

AsyncClient

Client for interacting with Google Cloud Firestore API.

Note: Since the Cloud Firestore API requires the gRPC transport, no _http argument is accepted by this class.

AsyncCollectionReference

A reference to a collection in a Firestore database.

The collection may already exist or this class can facilitate creation of documents within the collection.

AsyncDocumentReference

A reference to a document in a Firestore database.

The document may already exist or can be created by this class.

AsyncCollectionGroup

Represents a Collection Group in the Firestore API.

This is a specialization of .AsyncQuery that includes all documents in the database that are contained in a collection or subcollection of the given parent.

AsyncQuery

Represents a query to the Firestore API.

Instances of this class are considered immutable: all methods that would modify an instance instead return a new instance.

AsyncTransaction

Accumulate read-and-write operations to be sent in a transaction.

AggregationResult

A class representing result from Aggregation Query

AvgAggregation

Helper class that provides a standard way to create an ABC using inheritance.

BaseAggregation

Helper class that provides a standard way to create an ABC using inheritance.

BaseAggregationQuery

Represents an aggregation query to the Firestore API.

CountAggregation

Helper class that provides a standard way to create an ABC using inheritance.

SumAggregation

Helper class that provides a standard way to create an ABC using inheritance.

BaseBatch

Accumulate write operations to be sent in a batch.

This has the same set of methods for write operations that xref_DocumentReference does, e.g. xref_create.

BaseWriteBatch

Base class for a/sync implementations of the commit RPC. commit is useful for lower volumes or when the order of write operations is important.

BaseClient

Client for interacting with Google Cloud Firestore API.

Note: Since the Cloud Firestore API requires the gRPC transport, no _http argument is accepted by this class.

BaseCollectionReference

A reference to a collection in a Firestore database.

The collection may already exist or this class can facilitate creation of documents within the collection.

BaseDocumentReference

A reference to a document in a Firestore database.

The document may already exist or can be created by this class.

DocumentSnapshot

A snapshot of document data in a Firestore database.

This represents data retrieved at a specific time and may not contain all fields stored for the document (i.e. a hand-picked selection of fields may have been retrieved).

Instances of this class are not intended to be constructed by hand, rather they'll be returned as responses to various methods, such as xref_get.

And

Class representation of an AND Filter.

BaseCollectionGroup

Represents a Collection Group in the Firestore API.

This is a specialization of .Query that includes all documents in the database that are contained in a collection or subcollection of the given parent.

BaseCompositeFilter

Base class for a Composite Filter. (either OR or AND).

BaseFilter

Base class for Filters

BaseQuery

Represents a query to the Firestore API.

Instances of this class are considered immutable: all methods that would modify an instance instead return a new instance.

FieldFilter

Class representation of a Field Filter.

Or

Class representation of an OR Filter.

QueryPartition

Represents a bounded partition of a collection group query.

Contains cursors that can be used in a query as a starting and/or end point for the collection group query. The cursors may only be used in a query that matches the constraints of the query that produced this partition.

BaseTransaction

Accumulate read-and-write operations to be sent in a transaction.

WriteBatch

Accumulate write operations to be sent in a batch. Use this over BulkWriteBatch for lower volumes or when the order of operations within a given batch is important.

This has the same set of methods for write operations that xref_DocumentReference does, e.g. xref_create.

Client

Client for interacting with Google Cloud Firestore API.

Note: Since the Cloud Firestore API requires the gRPC transport, no _http argument is accepted by this class.

CollectionReference

A reference to a collection in a Firestore database.

The collection may already exist or this class can facilitate creation of documents within the collection.

DocumentReference

A reference to a document in a Firestore database.

The document may already exist or can be created by this class.

FieldPath

Field Path object for client use.

A field path is a sequence of element keys, separated by periods. Each element key can be either a simple identifier, or a full unicode string.

In the string representation of a field path, non-identifier elements must be quoted using backticks, with internal backticks and backslashes escaped with a backslash.

CollectionGroup

Represents a Collection Group in the Firestore API.

This is a specialization of .Query that includes all documents in the database that are contained in a collection or subcollection of the given parent.

Query

Represents a query to the Firestore API.

Instances of this class are considered immutable: all methods that would modify an instance instead return a new instance.

Transaction

Accumulate read-and-write operations to be sent in a transaction.

ArrayRemove

Field transform: remove values from an array field.

See: https://cloud.google.com/firestore/docs/reference/rpc/google.firestore.v1#google.firestore.v1.DocumentTransform.FieldTransform.FIELDS.google.firestore.v1.ArrayValue.google.firestore.v1.DocumentTransform.FieldTransform.remove_all_from_array

ArrayUnion

Field transform: appends missing values to an array field.

Increment

Field transform: increment a numeric field with specified value.

Maximum

Field transform: bound numeric field with specified value.

Minimum

Field transform: bound numeric field with specified value.

Sentinel

Sentinel objects used to signal special handling.

AggregationResult

The result of a single bucket from a Firestore aggregation query.

The keys of aggregate_fields are the same for all results in an aggregation query, unlike document queries which can have different fields present for each result.

AggregateFieldsEntry

The abstract base class for a message.

ArrayValue

An array value.

BatchGetDocumentsRequest

The request for Firestore.BatchGetDocuments][google.firestore.v1.Firestore.BatchGetDocuments].

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

BatchGetDocumentsResponse

The streamed response for Firestore.BatchGetDocuments][google.firestore.v1.Firestore.BatchGetDocuments].

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

BatchWriteRequest

The request for Firestore.BatchWrite][google.firestore.v1.Firestore.BatchWrite].

LabelsEntry

The abstract base class for a message.

BatchWriteResponse

The response from Firestore.BatchWrite][google.firestore.v1.Firestore.BatchWrite].

BeginTransactionRequest

The request for Firestore.BeginTransaction][google.firestore.v1.Firestore.BeginTransaction].

BeginTransactionResponse

The response for Firestore.BeginTransaction][google.firestore.v1.Firestore.BeginTransaction].

BitSequence

A sequence of bits, encoded in a byte array.

Each byte in the bitmap byte array stores 8 bits of the sequence. The only exception is the last byte, which may store 8 or fewer bits. The padding defines the number of bits of the last byte to be ignored as "padding". The values of these "padding" bits are unspecified and must be ignored.

To retrieve the first bit, bit 0, calculate: (bitmap[0] & 0x01) != 0. To retrieve the second bit, bit 1, calculate: (bitmap[0] & 0x02) != 0. To retrieve the third bit, bit 2, calculate: (bitmap[0] & 0x04) != 0. To retrieve the fourth bit, bit 3, calculate: (bitmap[0] & 0x08) != 0. To retrieve bit n, calculate: (bitmap[n / 8] & (0x01 << (n % 8))) != 0.

The "size" of a BitSequence (the number of bits it contains) is calculated by this formula: (bitmap.length * 8) - padding.

BloomFilter

A bloom filter (https://en.wikipedia.org/wiki/Bloom_filter).

The bloom filter hashes the entries with MD5 and treats the resulting 128-bit hash as 2 distinct 64-bit hash values, interpreted as unsigned integers using 2's complement encoding.

These two hash values, named h1 and h2, are then used to compute the hash_count hash values using the formula, starting at i=0:

h(i) = h1 + (i * h2)

These resulting values are then taken modulo the number of bits in the bloom filter to get the bits of the bloom filter to test for the given entry.

CommitRequest

The request for Firestore.Commit][google.firestore.v1.Firestore.Commit].

CommitResponse

The response for Firestore.Commit][google.firestore.v1.Firestore.Commit].

CreateDocumentRequest

The request for Firestore.CreateDocument][google.firestore.v1.Firestore.CreateDocument].

Cursor

A position in a query result set.

DeleteDocumentRequest

The request for Firestore.DeleteDocument][google.firestore.v1.Firestore.DeleteDocument].

Document

A Firestore document.

Must not exceed 1 MiB - 4 bytes.

FieldsEntry

The abstract base class for a message.

DocumentChange

A Document][google.firestore.v1.Document] has changed.

May be the result of multiple writes][google.firestore.v1.Write], including deletes, that ultimately resulted in a new value for the Document][google.firestore.v1.Document].

Multiple DocumentChange][google.firestore.v1.DocumentChange] messages may be returned for the same logical change, if multiple targets are affected.

DocumentDelete

A Document][google.firestore.v1.Document] has been deleted.

May be the result of multiple writes][google.firestore.v1.Write], including updates, the last of which deleted the Document][google.firestore.v1.Document].

Multiple DocumentDelete][google.firestore.v1.DocumentDelete] messages may be returned for the same logical delete, if multiple targets are affected.

DocumentMask

A set of field paths on a document. Used to restrict a get or update operation on a document to a subset of its fields. This is different from standard field masks, as this is always scoped to a Document][google.firestore.v1.Document], and takes in account the dynamic nature of Value][google.firestore.v1.Value].

DocumentRemove

A Document][google.firestore.v1.Document] has been removed from the view of the targets.

Sent if the document is no longer relevant to a target and is out of view. Can be sent instead of a DocumentDelete or a DocumentChange if the server can not send the new value of the document.

Multiple DocumentRemove][google.firestore.v1.DocumentRemove] messages may be returned for the same logical write or delete, if multiple targets are affected.

DocumentTransform

A transformation of a document.

FieldTransform

A transformation of a field of the document.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

ServerValue

A value that is calculated by the server.

ExecutionStats

Execution statistics for the query.

ExistenceFilter

A digest of all the documents that match a given target.

ExplainMetrics

Explain metrics for the query.

ExplainOptions

Explain options for the query.

GetDocumentRequest

The request for Firestore.GetDocument][google.firestore.v1.Firestore.GetDocument].

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

ListCollectionIdsRequest

The request for Firestore.ListCollectionIds][google.firestore.v1.Firestore.ListCollectionIds].

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

ListCollectionIdsResponse

The response from Firestore.ListCollectionIds][google.firestore.v1.Firestore.ListCollectionIds].

ListDocumentsRequest

The request for Firestore.ListDocuments][google.firestore.v1.Firestore.ListDocuments].

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

ListDocumentsResponse

The response for Firestore.ListDocuments][google.firestore.v1.Firestore.ListDocuments].

ListenRequest

A request for Firestore.Listen][google.firestore.v1.Firestore.Listen]

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

LabelsEntry

The abstract base class for a message.

ListenResponse

The response for Firestore.Listen][google.firestore.v1.Firestore.Listen].

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

MapValue

A map value.

FieldsEntry

The abstract base class for a message.

PartitionQueryRequest

The request for Firestore.PartitionQuery][google.firestore.v1.Firestore.PartitionQuery].

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

PartitionQueryResponse

The response for Firestore.PartitionQuery][google.firestore.v1.Firestore.PartitionQuery].

PlanSummary

Planning phase information for the query.

Precondition

A precondition on a document, used for conditional operations.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

RollbackRequest

The request for Firestore.Rollback][google.firestore.v1.Firestore.Rollback].

RunAggregationQueryRequest

The request for Firestore.RunAggregationQuery][google.firestore.v1.Firestore.RunAggregationQuery].

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

RunAggregationQueryResponse

The response for Firestore.RunAggregationQuery][google.firestore.v1.Firestore.RunAggregationQuery].

RunQueryRequest

The request for Firestore.RunQuery][google.firestore.v1.Firestore.RunQuery].

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

RunQueryResponse

The response for Firestore.RunQuery][google.firestore.v1.Firestore.RunQuery].

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

StructuredAggregationQuery

Firestore query for running an aggregation over a StructuredQuery][google.firestore.v1.StructuredQuery].

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Aggregation

Defines an aggregation that produces a single result.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Avg

Average of the values of the requested field.

Only numeric values will be aggregated. All non-numeric values including NULL are skipped.
If the aggregated values contain NaN, returns NaN. Infinity math follows IEEE-754 standards.
If the aggregated value set is empty, returns NULL.
Always returns the result as a double.

Count

Count of documents that match the query.

The COUNT(*) aggregation function operates on the entire document so it does not require a field reference.

Sum

Sum of the values of the requested field.

Only numeric values will be aggregated. All non-numeric values including NULL are skipped.
If the aggregated values contain NaN, returns NaN. Infinity math follows IEEE-754 standards.
If the aggregated value set is empty, returns 0.
Returns a 64-bit integer if all aggregated numbers are integers and the sum result does not overflow. Otherwise, the result is returned as a double. Note that even if all the aggregated values are integers, the result is returned as a double if it cannot fit within a 64-bit signed integer. When this occurs, the returned value will lose precision.
When underflow occurs, floating-point aggregation is non-deterministic. This means that running the same query repeatedly without any changes to the underlying values could produce slightly different results each time. In those cases, values should be stored as integers over floating-point numbers.

StructuredQuery

A Firestore query.

The query stages are executed in the following order:

from
where
select
order_by + start_at + end_at
offset
limit

CollectionSelector

A selection of a collection, such as messages as m1.

CompositeFilter

A filter that merges multiple other filters using the given operator.

Operator

A composite filter operator.

Direction

A sort direction.

FieldFilter

A filter on a specific field.

Operator

A field filter operator.

    Requires:

    -  That `field` come first in `order_by`.
LESS_THAN_OR_EQUAL (2):
    The given `field` is less than or equal to the given
    `value`.

    Requires:

    -  That `field` come first in `order_by`.
GREATER_THAN (3):
    The given `field` is greater than the given `value`.

    Requires:

    -  That `field` come first in `order_by`.
GREATER_THAN_OR_EQUAL (4):
    The given `field` is greater than or equal to the given
    `value`.

    Requires:

    -  That `field` come first in `order_by`.
EQUAL (5):
    The given `field` is equal to the given `value`.
NOT_EQUAL (6):
    The given `field` is not equal to the given `value`.

    Requires:

    -  No other `NOT_EQUAL`, `NOT_IN`, `IS_NOT_NULL`, or
       `IS_NOT_NAN`.
    -  That `field` comes first in the `order_by`.
ARRAY_CONTAINS (7):
    The given `field` is an array that contains the given
    `value`.
IN (8):
    The given `field` is equal to at least one value in the
    given array.

    Requires:

    -  That `value` is a non-empty `ArrayValue`, subject to
       disjunction limits.
    -  No `NOT_IN` filters in the same query.
ARRAY_CONTAINS_ANY (9):
    The given `field` is an array that contains any of the
    values in the given array.

    Requires:

    -  That `value` is a non-empty `ArrayValue`, subject to
       disjunction limits.
    -  No other `ARRAY_CONTAINS_ANY` filters within the same
       disjunction.
    -  No `NOT_IN` filters in the same query.
NOT_IN (10):
    The value of the `field` is not in the given array.

    Requires:

    -  That `value` is a non-empty `ArrayValue` with at most
       10 values.
    -  No other `OR`, `IN`, `ARRAY_CONTAINS_ANY`,
       `NOT_IN`, `NOT_EQUAL`, `IS_NOT_NULL`, or
       `IS_NOT_NAN`.
    -  That `field` comes first in the `order_by`.

FieldReference

A reference to a field in a document, ex: stats.operations.

Filter

A filter.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

FindNearest

Nearest Neighbors search config.

DistanceMeasure

The distance measure to use when comparing vectors.

Order

An order on a field.

Projection

The projection of document's fields to return.

UnaryFilter

A filter with a single operand.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Operator

A unary operator.

    Requires:

    -  No other `NOT_EQUAL`, `NOT_IN`, `IS_NOT_NULL`, or
       `IS_NOT_NAN`.
    -  That `field` comes first in the `order_by`.
IS_NOT_NULL (5):
    The given `field` is not equal to `NULL`.

    Requires:

    -  A single `NOT_EQUAL`, `NOT_IN`, `IS_NOT_NULL`, or
       `IS_NOT_NAN`.
    -  That `field` comes first in the `order_by`.

Target

A specification of a set of documents to listen to.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

DocumentsTarget

A target specified by a set of documents names.

QueryTarget

A target specified by a query.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

TargetChange

Targets being watched have changed.

TargetChangeType

The type of change.

    This will be sent after or with a `read_time` that is
    greater than or equal to the time at which the targets were
    added.

    Listeners can wait for this change if read-after-write
    semantics are desired.
RESET (4):
    The targets have been reset, and a new initial state for the
    targets will be returned in subsequent changes.

    After the initial state is complete, `CURRENT` will be
    returned even if the target was previously indicated to be
    `CURRENT`.

TransactionOptions

Options for creating a new transaction.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

ReadOnly

Options for a transaction that can only be used to read documents.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

ReadWrite

Options for a transaction that can be used to read and write documents. Firestore does not allow 3rd party auth requests to create read-write. transactions.

UpdateDocumentRequest

The request for Firestore.UpdateDocument][google.firestore.v1.Firestore.UpdateDocument].

Value

A message that can hold any of the supported value types.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Write

A write on a document.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

WriteRequest

The request for Firestore.Write][google.firestore.v1.Firestore.Write].

The first request creates a stream, or resumes an existing one from a token.

When creating a new stream, the server replies with a response containing only an ID and a token, to use in the next request.

When resuming a stream, the server first streams any responses later than the given token, then a response containing only an up-to-date token, to use in the next request.

LabelsEntry

The abstract base class for a message.

WriteResponse

The response for Firestore.Write][google.firestore.v1.Firestore.Write].

WriteResult

The result of applying a write.

Modules

client

API documentation for firestore_admin_v1.services.firestore_admin.client module.

bundle

Classes for representing bundles for the Google Cloud Firestore API.

aggregation

Classes for representing aggregation queries for the Google Cloud Firestore API.

A AggregationQuery can be created directly from a Collection and that can be a more common way to create an aggregation query than direct usage of the constructor.

async_aggregation

Classes for representing Async aggregation queries for the Google Cloud Firestore API.

A AsyncAggregationQuery can be created directly from a AsyncCollection and that can be a more common way to create an aggregation query than direct usage of the constructor.

async_batch

Helpers for batch requests to the Google Cloud Firestore API.

async_client

Client for interacting with the Google Cloud Firestore API.

This is the base from which all interactions with the API occur.

In the hierarchy of API concepts

a Client owns a AsyncCollectionReference
a Client owns a AsyncDocumentReference

async_collection

Classes for representing collections for the Google Cloud Firestore API.

async_document

Classes for representing documents for the Google Cloud Firestore API.

async_query

Classes for representing queries for the Google Cloud Firestore API.

A Query can be created directly from a Collection and that can be a more common way to create a query than direct usage of the constructor.

async_transaction

Helpers for applying Google Cloud Firestore changes in a transaction.

base_aggregation

Classes for representing aggregation queries for the Google Cloud Firestore API.

A AggregationQuery can be created directly from a Collection and that can be a more common way to create an aggregation query than direct usage of the constructor.

base_batch

Helpers for batch requests to the Google Cloud Firestore API.

base_client

Client for interacting with the Google Cloud Firestore API.

This is the base from which all interactions with the API occur.

In the hierarchy of API concepts

a Client owns a CollectionReference
a Client owns a DocumentReference

In the hierarchy of API concepts

a Client owns a CollectionReference
a Client owns a DocumentReference