U $FZhN8@sdZddlmZddlmZmZmZmZmZm Z m Z ddl m Z ddl m ZddlmZmZmZmZddlmZddlmZdd lmZdd lmZdd lmZdd lmZdd l m!Z"ddl#m$Z%ddl&m'Z'erddl(m)Z)GdddeZ*dS)aClient 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 :class:`~google.cloud.firestore_v1.client.Client` owns a :class:`~google.cloud.firestore_v1.collection.CollectionReference` * a :class:`~google.cloud.firestore_v1.client.Client` owns a :class:`~google.cloud.firestore_v1.document.DocumentReference` ) annotations) TYPE_CHECKINGAny GeneratorIterableListOptionalUnion)gapic_v1)retry) _CLIENT_INFO BaseClient_parse_batch_get _path_helper)DocumentSnapshot WriteBatch)CollectionReference)DocumentReference) FieldPath)CollectionGroup)client)grpc Transaction) BulkWritercseZdZdZdddedfddfdd ZeddZd d d d d Zd ddddZ d ddddZ dde j j dfdddddddddZe j j dfdddd d!d"Zdd#d$d%d&d'd'd(d)d*Zd#d+d,d%d-d'd'd'd.d/d0Zd1dd2d3Zd4dd5d6ZZS)7ClientaClient 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. Args: 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. If not passed, falls back to :attr:`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. NNone)returncstt|j|||||ddS)N)project credentialsdatabase client_infoclient_options)superr__init__)selfrr r!r"r# __class__g/home/aprabhat/apps/x.techxrdev.in/venv/lib/python3.8/site-packages/google/cloud/firestore_v1/client.pyr%Ts zClient.__init__cCs|tjtjtS)zLazy-loading getter GAPIC Firestore API. Returns: :class:`~google.cloud.gapic.firestore.v1`.firestore_client.FirestoreClient: The GAPIC client with the credentials of the current client. )Z_firestore_api_helperfirestore_grpc_transportZFirestoreGrpcTransportfirestore_clientZFirestoreClientr&r)r)r*_firestore_apids zClient._firestore_apistrr)collection_pathrcGstt|d|iS)aGet a reference to a collection. For a top-level collection: .. code-block:: python >>> client.collection('top') For a sub-collection: .. code-block:: python >>> client.collection('mydocs/doc/subcol') >>> # is the same as >>> client.collection('mydocs', 'doc', 'subcol') Sub-collections can be nested deeper in a similar fashion. Args: collection_path: Can either be * A single ``/``-delimited path to a collection * A tuple of collection path segments Returns: :class:`~google.cloud.firestore_v1.collection.CollectionReference`: A reference to a collection in the Firestore database. r)rr)r&r0r)r)r* collectionqszClient.collectionr) collection_idrcCst||S)a 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. .. code-block:: python >>> query = client.collection_group('mygroup') Args: collection_id (str) Identifies the collections to query over. Every collection or subcollection with this ID as the last segment of its path will be included. Cannot contain a slash. Returns: :class:`~google.cloud.firestore_v1.query.CollectionGroup`: The created Query. )rZ_get_collection_reference)r&r2r)r)r*collection_groupszClient.collection_groupr) document_pathrcGst|j|d|iS)a}Get a reference to a document in a collection. For a top-level document: .. code-block:: python >>> client.document('collek/shun') >>> # is the same as >>> client.document('collek', 'shun') For a document in a sub-collection: .. code-block:: python >>> 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. Args: document_path): Can either be * A single ``/``-delimited path to a document * A tuple of document path segments Returns: :class:`~google.cloud.firestore_v1.document.DocumentReference`: A reference to a document in a collection. r)rZ_document_path_helper)r&r4r)r)r*documents zClient.documentlistzIterable[str] | NonezTransaction | Nonezretries.Retry | object | Nonez float | Nonez&Generator[DocumentSnapshot, Any, None]) references field_paths transactionr timeoutrc csN||||||\}}}|jjf||jd|} | D]} t| ||Vq6dS)aRetrieve 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 :meth:`~google.cloud.firestore_v1.client.Client.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). Args: 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[:class:`~google.cloud.firestore_v1.transaction.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 :data:`None` if the document does not exist. requestmetadataN)Z _prep_get_allr.Zbatch_get_documents _rpc_metadatar) r&r7r8r9r r:r<Z reference_mapkwargsZresponse_iteratorZget_doc_responser)r)r*get_alls. zClient.get_allzGenerator[Any, Any, None])r r:rccsD|||\}}|jjf||jd|}|D]}||Vq.dS)aList top-level collections of the client's database. Args: 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: Sequence[:class:`~google.cloud.firestore_v1.collection.CollectionReference`]: iterator of subcollections of the current document. r;N)Z_prep_collectionsr.Zlist_collection_idsr>r1)r&r r:r<r?iteratorr2r)r)r* collectionsszClient.collectionsi) bulk_writer chunk_sizez-Union[CollectionReference, DocumentReference]zOptional['BulkWriter']int) referencerCrDrcCs |dkr|}|j|||dS)aUDeletes 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. Args: reference (Union[ :class:`@google.cloud.firestore_v1.collection.CollectionReference`, :class:`@google.cloud.firestore_v1.document.DocumentReference`, ]) The reference to be deleted. bulk_writer (Optional[:class:`@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. N)rD)rC_recursive_delete)r&rFrCrDr)r)r*recursive_delete szClient.recursive_deleterrDdepthz 'BulkWriter')rFrCrDrJrc Csd}t|trN|tg|D]"}|D]}|d7}||jq0q(nXt|t r| D]}||j ||||dd7}q`|d7}||nt d|j j|dkr||S)z'Recursion helper for `recursive_delete.rrIzUnexpected type for reference: ) isinstancer recursiveselectrZ document_idZ _chunkifydeleterFrrBrG TypeErrorr(__name__close) r&rFrCrDrJZ num_deletedchunkZdoc_snapZcol_refr)r)r*rGEs6       zClient._recursive_deletercCst|S)zGet a batch instance from this client. Returns: :class:`~google.cloud.firestore_v1.batch.WriteBatch`: A "write" batch to be used for accumulating document changes and sending the changes all at once. rr-r)r)r*batchssz Client.batchrcKs t|f|S)aDGet a transaction that uses this client. See :class:`~google.cloud.firestore_v1.transaction.Transaction` for more information on transactions and the constructor arguments. Args: kwargs (Dict[str, Any]): The keyword arguments (other than ``client``) to pass along to the :class:`~google.cloud.firestore_v1.transaction.Transaction` constructor. Returns: :class:`~google.cloud.firestore_v1.transaction.Transaction`: A transaction attached to this client. r)r&r?r)r)r*r9}szClient.transaction)rQ __module__ __qualname____doc__r r%propertyr.r1r3r5r methodDEFAULTr@rBrHrGrTr9 __classcell__r)r)r'r*r9s8 &= *. rN)+rW __future__rtypingrrrrrrr Zgoogle.api_corer r retriesZ%google.cloud.firestore_v1.base_clientr r rrZ'google.cloud.firestore_v1.base_documentrZgoogle.cloud.firestore_v1.batchrZ$google.cloud.firestore_v1.collectionrZ"google.cloud.firestore_v1.documentrZ$google.cloud.firestore_v1.field_pathrZgoogle.cloud.firestore_v1.queryrZ,google.cloud.firestore_v1.services.firestorerr,Z7google.cloud.firestore_v1.services.firestore.transportsrr+Z%google.cloud.firestore_v1.transactionrZ%google.cloud.firestore_v1.bulk_writerrrr)r)r)r*s" $