(phj.SrSSKJr SSKJrJrJrJrJrJ r J r SSK J r SSK J r SSKJrJr SSKJr SSKJrJr SS KJrJr SS KJr SS KJr \(aSS KJr SS KJ r SSK!J"r" "SS\\RF5r$g)zHClasses for representing collections for the Google Cloud Firestore API.) annotations) TYPE_CHECKINGAnyCallable GeneratorOptionalTupleUnion)gapic_v1)retry) aggregationdocument)query) transaction vector_query)BaseCollectionReference_item_to_document_ref)QueryResultsList)Watch)DocumentSnapshot)ExplainOptions)StreamGeneratorc^\rSrSrSrSU4SjjrSSjrSSjrSSjrS\ RRS4SSjjr S\ RRS4SS jjr SS jrS\ RRS4SS .SS jjjrS\ RRS4SS .SS jjjrSSjrSrU=r$)CollectionReference'aA reference to a collection in a Firestore database. The collection may already exist or this class can facilitate creation of documents within the collection. Args: path (Tuple[str, ...]): The components in the collection path. This is a series of strings representing each collection and sub-collection ID, as well as the document IDs for any documents that contain a sub-collection. kwargs (dict): The keyword arguments for the constructor. The only supported keyword is ``client`` and it must be a :class:`~google.cloud.firestore_v1.client.Client` if provided. It represents the client that created this collection reference. Raises: ValueError: if * the ``path`` is empty * there are an even number of elements * a collection ID in ``path`` is not a string * a document ID in ``path`` is not a string TypeError: If a keyword other than ``client`` is used. c.>[[U] "U0UD6 gN)superr__init__)selfpathkwargs __class__s W/var/www/html/venv/lib/python3.13/site-packages/google/cloud/firestore_v1/collection.pyrCollectionReference.__init__As !414B6Bc.[R"U5$)zMQuery factory. Returns: :class:`~google.cloud.firestore_v1.query.Query` ) query_modQueryr s r$_queryCollectionReference._queryDs t$$r&cJ[R"UR55$)zoAggregationQuery factory. Returns: :class:`~google.cloud.firestore_v1.aggregation_query.AggregationQuery` )r AggregationQueryr+r*s r$_aggregation_query&CollectionReference._aggregation_queryLs ++DKKM::r&cJ[R"UR55$)z`VectorQuery factory. Returns: :class:`~google.cloud.firestore_v1.vector_query.VectorQuery` )r VectorQueryr+r*s r$ _vector_query!CollectionReference._vector_queryTs '' 66r&NcpURUUUU5upVUR"U40UD6nURU4$)amCreate a document in the Firestore database with the provided data. Args: document_data (dict): Property names and values to use for creating the document. document_id (Optional[str]): The document identifier within the current collection. If not provided, an ID will be automatically assigned by the server (the assigned ID will be a random 20 character string composed of digits, uppercase and lowercase letters). 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: Tuple[:class:`google.protobuf.timestamp_pb2.Timestamp`, :class:`~google.cloud.firestore_v1.document.DocumentReference`]: Pair of * The ``update_time`` when the document was created/overwritten. * A document reference for the created document. Raises: :class:`google.cloud.exceptions.Conflict`: If ``document_id`` is provided and the document already exists. ) _prep_addcreate update_time)r document_data document_idr timeout document_refr" write_results r$addCollectionReference.add\sJD $~~       $**=CFC ''55r&c^TRXU5upETRRR"SUTRRS.UD6nU4SjU5$)aList all subdocuments of the current collection. Args: page_size (Optional[int]]): The maximum number of documents in each page of results from this request. Non-positive values are ignored. Defaults to a sensible value set by the API. 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.DocumentReference`]: iterator of subdocuments of the current collection. If the collection does not exist at the time of `snapshot`, the iterator will be empty )requestmetadatac3<># UHn[TU5v M g7fr)r).0ir s r$ 5CollectionReference.list_documents..sA1%dA..s)_prep_list_documents_client_firestore_apilist_documents _rpc_metadata)r page_sizer r;rAr"iterators` r$rL"CollectionReference.list_documentss`.33IgN<<..== \\//   BAAr&c@UR5RU5$r)r+ _chunkify)r chunk_sizes r$rRCollectionReference._chunkifys{{}&&z22r&)explain_optionsc^URX#5upVUbXFS'UR"SSU0UD6$)a.Read the documents in this collection. This sends a ``RunQuery`` RPC and returns a list of documents returned in the stream of ``RunQueryResponse`` messages. Args: transaction (Optional[:class:`~google.cloud.firestore_v1.transaction.transaction.Transaction`]): An existing transaction that this query will run 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. explain_options (Optional[:class:`~google.cloud.firestore_v1.query_profile.ExplainOptions`]): Options to enable query profiling for this query. When set, explain_metrics will be available on the returned generator. 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). Returns: QueryResultsList[DocumentSnapshot]: The documents in this collection that match the query. rUrrH)_prep_get_or_streamgetr rr r;rUrr"s r$rXCollectionReference.gets=D00@   &(7$ %yy;[;F;;r&cfURX#5upVU(aXFS'UR"SSU0UD6$)aPRead the documents in this collection. This sends a ``RunQuery`` RPC and then returns an iterator which consumes each document returned in the stream of ``RunQueryResponse`` messages. .. note:: The underlying stream of responses will time out after the ``max_rpc_timeout_millis`` value set in the GAPIC client configuration for the ``RunQuery`` API. Snapshots not consumed from the iterator before that point will be lost. 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: transaction (Optional[:class:`~google.cloud.firestore_v1.transaction. transaction.Transaction`]): An existing transaction that the query will run in. retry (Optional[google.api_core.retry.Retry]): Designation of what errors, if any, should be retried. Defaults to a system-specified policy. timeout (Optional[float]): The timeout for this request. Defaults to a system-specified value. explain_options (Optional[:class:`~google.cloud.firestore_v1.query_profile.ExplainOptions`]): Options to enable query profiling for this query. When set, explain_metrics will be available on the returned generator. Returns: `StreamGenerator[DocumentSnapshot]`: A generator of the query results. rUrrH)rWstreamrYs r$r\CollectionReference.streams:T00@  (7$ %||> >v>>r&clUR5n[R"X![R5$)aMonitor the documents in this collection. This starts a watch on this collection using a background thread. The provided callback is run on the snapshot of the documents. Args: callback (Callable[[:class:`~google.cloud.firestore.collection.CollectionSnapshot`], NoneType]): a callback to run when a change occurs. Example: from google.cloud import firestore_v1 db = firestore_v1.Client() collection_ref = db.collection(u'users') def on_snapshot(collection_snapshot, changes, read_time): for doc in collection_snapshot.documents: print(u'{} => {}'.format(doc.id, doc.to_dict())) # Watch this collection collection_watch = collection_ref.on_snapshot(on_snapshot) # Terminate this watch collection_watch.unsubscribe() )r+r for_queryrr)r callbackrs r$ on_snapshotCollectionReference.on_snapshots&4 u0I0IJJr&rH)returnNone)rczquery_mod.Query)rczaggregation.AggregationQuery)rczvector_query.VectorQuery) r9dictr:zUnion[str, None]r retries.Retry | object | Noner;Union[float, None]rczTuple[Any, Any])rNzUnion[int, None]r rfr;rgrczGenerator[Any, Any, None])rSint) rz$Union[transaction.Transaction, None]r rfr;rgrUOptional[ExplainOptions]rcz"QueryResultsList[DocumentSnapshot]) rz!Optional[transaction.Transaction]r rfr;zOptional[float]rUrircz!StreamGenerator[DocumentSnapshot])r`rrcr)__name__ __module__ __qualname____firstlineno____doc__rr+r/r3r methodDEFAULTr>rLrRrXr\ra__static_attributes__ __classcell__)r#s@r$rr'sj2C%;7)-/7/F/F&* )6)6&)6- )6 $ )6  )6Z'+/7/F/F&* B#B-B$ B # B@3 =A/7/F/F&* &< 59 &<9&<-&<$ &< 2 &< ,&/7/F/F#' .? 59 .?6.?-.?! .? 2 .? +.?`KKr&rN)%rn __future__rtypingrrrrrr r google.api_corer r retriesgoogle.cloud.firestore_v1r rrr(rr)google.cloud.firestore_v1.base_collectionrr'google.cloud.firestore_v1.query_resultsrgoogle.cloud.firestore_v1.watchr'google.cloud.firestore_v1.base_documentr'google.cloud.firestore_v1.query_profiler*google.cloud.firestore_v1.stream_generatorrr)rrHr&r$r~sZO"RRR$,;8?E1HFJvK1)//BvKr&