VSf9dZddlmZddlmZddlmZmZmZm Z ddl m Z ddl m Z ddlmZddlmZdd lmZdd lmZdd lmZdd lmZdd lmZmZmZm Z m!Z!m"Z"m#Z#ddl$m%Z%e#rddl&m'Z'GddeZ(y)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` )gapic_v1)retry) BaseClient _CLIENT_INFO_parse_batch_get _path_helper)CollectionGroup WriteBatch)CollectionReference)DocumentReference) FieldPath Transaction)client)grpc)Any GeneratorIterableListOptionalUnion TYPE_CHECKING)DocumentSnapshot) BulkWriterceZdZdZdddedf d!fd ZedZedZde de fdZ d e de fd Z d e defd Zddej"j$dfd edee dedej.dedeeedff dZej"j$dfdej.dedeeedffdZddddee efdeddee de fdZ!ddddee efdddee dee de f dZ"de#fdZ$defd Z%xZ&S)"ClientaClient 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. Nreturnc6tt| |||||y)N)project credentialsdatabase client_infoclient_options)superr__init__)selfr r!r"r#r$ __class__s _C:\Users\user\Documents\project_loop\venv\Lib\site-packages\google/cloud/firestore_v1/client.pyr&zClient.__init__Ss( fd$##) % ch|jtjtjtS)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. )_firestore_api_helperfirestore_grpc_transportFirestoreGrpcTransportfirestore_clientFirestoreClientr's r)_firestore_apizClient._firestore_apics,)) $ ; ;  , ,   r*c@|jtjS)zReturn the target (where the API is). Eg. "firestore.googleapis.com" Returns: str: The location of the API. )_target_helperr/r0r1s r)_targetzClient._targetps""#3#C#CDDr*collection_pathc*tt|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)r r)r'r6s r) collectionzClient.collectionzs:#L$AO$OOr* collection_idc6t|j|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. )r _get_collection_reference)r'r9s r)collection_groupzClient.collection_groups(t==mLMMr* document_pathc2t|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)r _document_path_helper)r'r=s r)documentzClient.documents)>! 'T ' ' 7 @D  r* references field_paths transactionrtimeoutc#K|j|||||\}}}|jjd||jd|} | D]} t | ||yw)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) _prep_get_allr2batch_get_documents _rpc_metadatar) r'rArBrCrrDrG reference_mapkwargsresponse_iteratorget_doc_responses r)get_allzClient.get_alls\*.););  [%* &DD//CC ''   !2 J "#3]DI I JAAc#K|j||\}}|jjd||jd|}|D]}|j |yw)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. rFNrI)_prep_collectionsr2list_collection_idsrLr8)r'rrDrGrNiteratorr9s r) collectionszClient.collections sq"00@:4&&:: ''   & 1M//-0 0 1rRi) bulk_writer chunk_size referencerXrrYcN||j}|j|||S)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. )rY)rX_recursive_delete)r'rZrXrYs r)recursive_deletezClient.recursive_delete)s98  **,K%%  !&  r*rrYdepthr_c "d}t|trn|jjt j gj |D])}|D]"}|dz }|j|j$+nyt|trG|jD]}||j||||dzz }|dz }|j|n"td|jj|dk(r|j|S)z'Recursion helper for `recursive_delete.rr^zUnexpected type for reference: ) isinstancer recursiveselectr document_id _chunkifydeleterZr rWr\ TypeErrorr(__name__close) r'rZrXrYr_ num_deletedchunkdoc_snapcol_refs r)r\zClient._recursive_deleteNs) i!4 5##%..012:& ; !&;H1$K&&x'9'9:;  ; #4 5$002 t55)!) 6    1 K   y )1)2E2E2N2N1OP  A:    r*ct|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. r r1s r)batchz Client.batch|s$r*c t|fi|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'rNs r)rCzClient.transactions 4*6**r*)rN)'ri __module__ __qualname____doc__rr&propertyr2r5strr r8r r<r r@rmethodDEFAULTlistrrretriesRetryfloatrrrrQrWrrintr]r\r rprC __classcell__)r(s@r)rr8s8         EEP3P3FP>NcNoN,! s! /@! L&*#''66 9J9Jc]9J! 9J }} 9J  9J #S$. /9Jz (661}}11 3T> " 1@/3$( # ,.??@# l+ # SM # # T%) ,,.??@,", SM , } , ,\ z +{+r*rN))rtgoogle.api_corerrrz%google.cloud.firestore_v1.base_clientrrrrgoogle.cloud.firestore_v1.queryr google.cloud.firestore_v1.batchr $google.cloud.firestore_v1.collectionr "google.cloud.firestore_v1.documentr $google.cloud.firestore_v1.field_pathr%google.cloud.firestore_v1.transactionr,google.cloud.firestore_v1.services.firestorerr/7google.cloud.firestore_v1.services.firestore.transportsrr-typingrrrrrrr'google.cloud.firestore_v1.base_documentr%google.cloud.firestore_v1.bulk_writerrrrIr*r)rs^ %,<6D@:=SRQQE@^+Z^+r*