Class Client (2.0.2)

Version 2.0.2

• 2.19.0 (latest)
• 2.18.0
• 2.17.2
• 2.16.1
• 2.15.0
• 2.14.0
• 2.13.1
• 2.12.0
• 2.11.1
• 2.10.1
• 2.9.1
• 2.8.0
• 2.7.3
• 2.6.1
• 2.5.3
• 2.4.0
• 2.3.4
• 2.2.0
• 2.1.3
• 2.0.2
• 1.9.2
• 1.8.1
• 1.7.0
• 1.6.2
• 1.5.0
• 1.4.0
• 1.3.0

Client(project=None, credentials=None, database='(default)', client_info=<google.api_core.gapic_v1.client_info.ClientInfo object>, client_options=None)

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
Name	Description
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[google.auth.credentials.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.

Methods

batch

batch()

Get a batch instance from this client.

Returns
Type	Description
WriteBatch	A "write" batch to be used for accumulating document changes and sending the changes all at once.

collection

collection(*collection_path: Tuple[str])

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.

Parameter
Name	Description
collection_path	Tuple[str, ...] Can either be * A single /-delimited path to a collection * A tuple of collection path segments

Returns
Type	Description
CollectionReference	A reference to a collection in the Firestore database.

collection_group

collection_group(collection_id: str)

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')

Parameter
Name	Description
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
Type	Description
CollectionGroup	The created Query.

collections

collections(retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None)

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

Parameters
Name	Description
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
Type	Description
Sequence[CollectionReference]	iterator of subcollections of the current document.

document

document(*document_path: Tuple[str])

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.

Parameter
Name	Description
document_path	Tuple[str, ...] Can either be * A single /-delimited path to a document * A tuple of document path segments

Returns
Type	Description
DocumentReference	A reference to a document in a collection.

get_all

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 = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None)

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.

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

See xref_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
Name	Description
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 :Yields: *.DocumentSnapshot* -- The next document snapshot that fulfills the query, or :data:None if the document does not exist. The timeout for this request. Defaults to a system-specified value.

transaction

transaction(**kwargs)

Get a transaction that uses this client.

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

Parameter
Name	Description
kwargs	Dict[str, Any] The keyword arguments (other than client) to pass along to the Transaction constructor.

Returns
Type	Description
Transaction	A transaction attached to this client.