As of January 1, 2020 this library no longer supports Python 2 on the latest released version. Library versions released prior to that date will continue to be available. For more information please visit Python 2 support on Google Cloud.

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

class google.cloud.firestore_v1.base_client.BaseClient(project=None, credentials=None, database=None, client_info=<google.api_core.gapic_v1.client_info.ClientInfo object>, client_options=None)[source]¶

Bases: google.cloud.client.ClientWithProject

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.

Parameters

project (Optional[str]) – The project which the client acts on behalf of. If not passed, falls back to the default inferred from the environment.
credentials (Optional[Credentials]) – The OAuth2 Credentials to use for this client. If not passed, falls back to the default inferred from the environment.
database (Optional[str]) – The database name that the client targets. For now, DEFAULT_DATABASE (the default value) is the only valid database.
client_info (Optional[google.api_core.gapic_v1.client_info.ClientInfo]) – The client info used to send a user-agent string along with API requests. If None, then default info will be used. Generally, you only need to set this if you’re developing your own library or partner tool.
client_options (Union[dict, google.api_core.client_options.ClientOptions]) – Client options used to set user options on the client. API Endpoint should be set through client_options.

SCOPE: Optional[Tuple[str, ...]] = ('https://www.googleapis.com/auth/cloud-platform', 'https://www.googleapis.com/auth/datastore')¶: The scopes required for authenticating with the Firestore service.

bulk_writer(options: Optional[google.cloud.firestore_v1.bulk_writer.BulkWriterOptions] = None) → google.cloud.firestore_v1.bulk_writer.BulkWriter[source]¶

Get a BulkWriter instance from this client.

:param @google.cloud.firestore_v1.bulk_writer.BulkWriterOptions: :param Optional control parameters for the: :param @google.cloud.firestore_v1.bulk_writer.BulkWriter returned.:

Returns: A utility to efficiently create and save many WriteBatch instances to the server.
Return type: @google.cloud.firestore_v1.bulk_writer.BulkWriter

static field_path(*field_names: str) → str[source]¶

Create a field path from a list of nested field names.

A field path is a .-delimited concatenation of the field names. It is used to represent a nested field. For example, in the data

data = {
   'aa': {
       'bb': {
           'cc': 10,
       },
   },
}

the field path 'aa.bb.cc' represents the data stored in data['aa']['bb']['cc'].

Parameters: field_names – The list of field names.
Returns: The .-delimited field path.
Return type: str

static write_option(**kwargs) → Union[google.cloud.firestore_v1._helpers.ExistsOption, google.cloud.firestore_v1._helpers.LastUpdateOption][source]¶

Create a write option for write operations.

Write operations include set(), update() and delete().

One of the following keyword arguments must be provided:

last_update_time (google.protobuf.timestamp_pb2. Timestamp): A timestamp. When set, the target document must
exist and have been last updated at that time. Protobuf update_time timestamps are typically returned from methods that perform write operations as part of a “write result” protobuf or directly.
exists (bool): Indicates if the document being modified
should already exist.

Providing no argument would make the option have no effect (so it is not allowed). Providing multiple would be an apparent contradiction, since last_update_time assumes that the document was updated (it can’t have been updated if it doesn’t exist) and exists indicate that it is unknown if the document exists or not.

Parameters: kwargs (Dict[str, Any]) – The keyword arguments described above.
Raises: TypeError – If anything other than exactly one argument is provided by the caller.
Returns: The option to be used to configure a write message.
Return type: WriteOption

google.cloud.firestore_v1.base_client.DEFAULT_DATABASE = '(default)'¶

The default database used in a Client.

Type: str

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

class google.cloud.firestore_v1.client.Client(project=None, credentials=None, database=None, client_info=<google.api_core.gapic_v1.client_info.ClientInfo object>, client_options=None)[source]¶

Bases: google.cloud.firestore_v1.base_client.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.

Parameters

project (Optional[str]) – The project which the client acts on behalf of. If not passed, falls back to the default inferred from the environment.
credentials (Optional[Credentials]) – The OAuth2 Credentials to use for this client. If not passed, falls back to the default inferred from the environment.
database (Optional[str]) – The database name that the client targets. If not passed, falls back to DEFAULT_DATABASE.
client_info (Optional[google.api_core.gapic_v1.client_info.ClientInfo]) – The client info used to send a user-agent string along with API requests. If None, then default info will be used. Generally, you only need to set this if you’re developing your own library or partner tool.
client_options (Union[dict, google.api_core.client_options.ClientOptions]) – Client options used to set user options on the client. API Endpoint should be set through client_options.

batch() → google.cloud.firestore_v1.batch.WriteBatch[source]¶

Get a batch instance from this client.

Returns: A “write” batch to be used for accumulating document changes and sending the changes all at once.
Return type: WriteBatch

collection(*collection_path: str) → google.cloud.firestore_v1.collection.CollectionReference[source]¶

Get a reference to a collection.

For a top-level collection:

>>> client.collection('top')

For a sub-collection:

>>> client.collection('mydocs/doc/subcol')
>>> # is the same as
>>> client.collection('mydocs', 'doc', 'subcol')

Sub-collections can be nested deeper in a similar fashion.

Parameters

collection_path –

Can either be

A single /-delimited path to a collection
A tuple of collection path segments

Returns

A reference to a collection in the Firestore database.

Return type

CollectionReference

collection_group(collection_id: str) → google.cloud.firestore_v1.query.CollectionGroup[source]¶

Creates and returns a new Query that includes all documents in the database that are contained in a collection or subcollection with the given collection_id.

>>> query = client.collection_group('mygroup')

Parameters: collection_id (str) – Every collection or subcollection with this ID as the last segment of its path will be included. Cannot contain a slash.
Returns: The created Query.
Return type: CollectionGroup

collections(retry: google.api_core.retry.retry_unary.Retry = _MethodDefault._DEFAULT_VALUE, timeout: Optional[float] = None) → Generator[Any, Any, None][source]¶

List top-level collections of the client’s database.

Parameters

retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried. Defaults to a system-specified policy.
timeout (float) – The timeout for this request. Defaults to a system-specified value.

Returns

iterator of subcollections of the current document.

Return type

Sequence[CollectionReference]

document(*document_path: str) → google.cloud.firestore_v1.document.DocumentReference[source]¶

Get a reference to a document in a collection.

For a top-level document:

>>> client.document('collek/shun')
>>> # is the same as
>>> client.document('collek', 'shun')

For a document in a sub-collection:

>>> client.document('mydocs/doc/subcol/child')
>>> # is the same as
>>> client.document('mydocs', 'doc', 'subcol', 'child')

Documents in sub-collections can be nested deeper in a similar fashion.

Parameters

document_path) –

Can either be

A single /-delimited path to a document
A tuple of document path segments

Returns

A reference to a document in a collection.

Return type

DocumentReference

get_all(references: list, field_paths: Optional[Iterable[str]] = None, transaction: Optional[google.cloud.firestore_v1.transaction.Transaction] = None, retry: google.api_core.retry.retry_unary.Retry = _MethodDefault._DEFAULT_VALUE, timeout: Optional[float] = None) → Generator[google.cloud.firestore_v1.base_document.DocumentSnapshot, Any, None][source]¶

Retrieve a batch of documents.

Note

Documents returned by this method are not guaranteed to be returned in the same order that they are given in references.

Note

If multiple references refer to the same document, the server will only return one result.

See field_path() for more information on field paths.

If a transaction is used and it already has write operations added, this method cannot be used (i.e. read-after-write is not allowed).

Parameters

references (List[.DocumentReference, ...]) – Iterable of document references to be retrieved.
field_paths (Optional[Iterable[str, ...]]) – An iterable of field paths (.-delimited list of field names) to use as a projection of document fields in the returned results. If no value is provided, all fields will be returned.
transaction (Optional[Transaction]) – An existing transaction that these references will be retrieved in.
retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried. Defaults to a system-specified policy.
timeout (float) – The timeout for this request. Defaults to a system-specified value.

Yields

.DocumentSnapshot – The next document snapshot that fulfills the query, or None if the document does not exist.

recursive_delete(reference: Union[google.cloud.firestore_v1.collection.CollectionReference, google.cloud.firestore_v1.document.DocumentReference], *, bulk_writer: Optional[BulkWriter] = None, chunk_size: Optional[int] = 5000) → int[source]¶

Deletes documents and their subcollections, regardless of collection name.

Passing a CollectionReference leads to each document in the collection getting deleted, as well as all of their descendents.

Passing a DocumentReference deletes that one document and all of its descendents.

Parameters

(Union[ (reference) – @google.cloud.firestore_v1.collection.CollectionReference, @google.cloud.firestore_v1.document.DocumentReference,
]) – The reference to be deleted.
bulk_writer (Optional[@google.cloud.firestore_v1.bulk_writer.BulkWriter]) – The BulkWriter used to delete all matching documents. Supply this if you want to override the default throttling behavior.

transaction(**kwargs) → google.cloud.firestore_v1.transaction.Transaction[source]¶

Get a transaction that uses this client.

See Transaction for more information on transactions and the constructor arguments.

Parameters: kwargs (Dict[str, Any]) – The keyword arguments (other than client) to pass along to the Transaction constructor.
Returns: A transaction attached to this client.
Return type: Transaction

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

class google.cloud.firestore_v1.async_client.AsyncClient(project=None, credentials=None, database=None, client_info=<google.api_core.gapic_v1.client_info.ClientInfo object>, client_options=None)[source]¶

Bases: google.cloud.firestore_v1.base_client.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.

Parameters

project (Optional[str]) – The project which the client acts on behalf of. If not passed, falls back to the default inferred from the environment.
credentials (Optional[Credentials]) – The OAuth2 Credentials to use for this client. If not passed, falls back to the default inferred from the environment.
database (Optional[str]) – The database name that the client targets. For now, DEFAULT_DATABASE (the default value) is the only valid database.
client_info (Optional[google.api_core.gapic_v1.client_info.ClientInfo]) – The client info used to send a user-agent string along with API requests. If None, then default info will be used. Generally, you only need to set this if you’re developing your own library or partner tool.
client_options (Union[dict, google.api_core.client_options.ClientOptions]) – Client options used to set user options on the client. API Endpoint should be set through client_options.

batch() → google.cloud.firestore_v1.async_batch.AsyncWriteBatch[source]¶

Get a batch instance from this client.

Returns: A “write” batch to be used for accumulating document changes and sending the changes all at once.
Return type: AsyncWriteBatch

collection(*collection_path: str) → google.cloud.firestore_v1.async_collection.AsyncCollectionReference[source]¶

Get a reference to a collection.

For a top-level collection:

>>> client.collection('top')

For a sub-collection:

>>> client.collection('mydocs/doc/subcol')
>>> # is the same as
>>> client.collection('mydocs', 'doc', 'subcol')

Sub-collections can be nested deeper in a similar fashion.

Parameters

collection_path –

Can either be

A single /-delimited path to a collection
A tuple of collection path segments

Returns

A reference to a collection in the Firestore database.

Return type

AsyncCollectionReference

collection_group(collection_id: str) → google.cloud.firestore_v1.async_query.AsyncCollectionGroup[source]¶

Creates and returns a new AsyncQuery that includes all documents in the database that are contained in a collection or subcollection with the given collection_id.

>>> query = client.collection_group('mygroup')

Parameters: collection_id (str) – Every collection or subcollection with this ID as the last segment of its path will be included. Cannot contain a slash.
Returns: The created AsyncQuery.
Return type: AsyncCollectionGroup

async collections(retry: google.api_core.retry.retry_unary_async.AsyncRetry = _MethodDefault._DEFAULT_VALUE, timeout: Optional[float] = None) → AsyncGenerator[google.cloud.firestore_v1.async_collection.AsyncCollectionReference, Any][source]¶

List top-level collections of the client’s database.

Parameters

retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried. Defaults to a system-specified policy.
timeout (float) – The timeout for this request. Defaults to a system-specified value.

Returns

iterator of subcollections of the current document.

Return type

Sequence[AsyncCollectionReference]

document(*document_path: str) → google.cloud.firestore_v1.async_document.AsyncDocumentReference[source]¶

Get a reference to a document in a collection.

For a top-level document:

>>> client.document('collek/shun')
>>> # is the same as
>>> client.document('collek', 'shun')

For a document in a sub-collection:

>>> client.document('mydocs/doc/subcol/child')
>>> # is the same as
>>> client.document('mydocs', 'doc', 'subcol', 'child')

Documents in sub-collections can be nested deeper in a similar fashion.

Parameters

document_path –

Can either be

A single /-delimited path to a document
A tuple of document path segments

Returns

A reference to a document in a collection.

Return type

AsyncDocumentReference

async get_all(references: List[google.cloud.firestore_v1.async_document.AsyncDocumentReference], field_paths: Optional[Iterable[str]] = None, transaction=None, retry: google.api_core.retry.retry_unary_async.AsyncRetry = _MethodDefault._DEFAULT_VALUE, timeout: Optional[float] = None) → AsyncGenerator[google.cloud.firestore_v1.base_document.DocumentSnapshot, Any][source]¶

Retrieve a batch of documents.

Note

Documents returned by this method are not guaranteed to be returned in the same order that they are given in references.

Note

If multiple references refer to the same document, the server will only return one result.

See field_path() for more information on field paths.

If a transaction is used and it already has write operations added, this method cannot be used (i.e. read-after-write is not allowed).

Parameters

references (List[.AsyncDocumentReference, ...]) – Iterable of document references to be retrieved.
field_paths (Optional[Iterable[str, ...]]) – An iterable of field paths (.-delimited list of field names) to use as a projection of document fields in the returned results. If no value is provided, all fields will be returned.
transaction (Optional[AsyncTransaction]) – An existing transaction that these references will be retrieved in.
retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried. Defaults to a system-specified policy.
timeout (float) – The timeout for this request. Defaults to a system-specified value.

Yields

.DocumentSnapshot – The next document snapshot that fulfills the query, or None if the document does not exist.

async recursive_delete(reference: Union[google.cloud.firestore_v1.async_collection.AsyncCollectionReference, google.cloud.firestore_v1.async_document.AsyncDocumentReference], *, bulk_writer: Optional[BulkWriter] = None, chunk_size: Optional[int] = 5000)[source]¶

Deletes documents and their subcollections, regardless of collection name.

Passing an AsyncCollectionReference leads to each document in the collection getting deleted, as well as all of their descendents.

Passing an AsyncDocumentReference deletes that one document and all of its descendents.

Parameters

(Union[ (reference) – @google.cloud.firestore_v1.async_collection.CollectionReference, @google.cloud.firestore_v1.async_document.DocumentReference,
]) – The reference to be deleted.
bulk_writer (Optional[@google.cloud.firestore_v1.bulk_writer.BulkWriter]) – The BulkWriter used to delete all matching documents. Supply this if you want to override the default throttling behavior.

transaction(**kwargs) → google.cloud.firestore_v1.async_transaction.AsyncTransaction[source]¶

Get a transaction that uses this client.

See AsyncTransaction for more information on transactions and the constructor arguments.

Parameters: kwargs (Dict[str, Any]) – The keyword arguments (other than client) to pass along to the AsyncTransaction constructor.
Returns: A transaction attached to this client.
Return type: AsyncTransaction

Client¶

google-cloud-firestore

Navigation

Related Topics