o }l~iv@sddlmZddlmZddlZddlmZddlmZddl m Z ddl m Z ddl m Zdd lmZed d Gd d d Zed d GdddZed d GdddZed d GdddZed d GdddZed d GdddeZGdddeZGdddZ dS)) annotations)AnyN) dataclass) MessageToDict)MapValue)Value) ExplainStats) StringValueT)frozenc@&eZdZUdZdZded<ddZdS)ExplainOptionsa Explain options for the query. Set on a query object using the explain_options attribute at query construction time. :type analyze: bool :param analyze: Optional. Whether to execute this query. When false (the default), the query will be planned, returning only metrics from the planning stages. When true, the query will be planned and executed, returning the full query results along with both planning and execution stage metrics. FboolanalyzecCs d|jiS)Nr)rselfrn/var/www/newdalilibackend/backend/venv/lib/python3.10/site-packages/google/cloud/firestore_v1/query_profile.py_to_dict/s zExplainOptions._to_dictN)__name__ __module__ __qualname____doc__r__annotations__rrrrrr s  r c@r )PipelineExplainOptionsa Explain options for pipeline queries. Set on a pipeline.execution() or pipeline.stream() call, to provide explain_stats in the pipeline output :type mode: str :param mode: Optional. The mode of operation for this explain query. When set to 'analyze', the query will be executed and return the full query results along with execution statistics. :type output_format: str | None :param output_format: Optional. The format in which to return the explain stats. rstrmodecCs$dt|jdi}t|d}t|dS)Nr) string_value)fields) map_value)rrr)rout_dictvalue_pbrrr _to_valueGs  z PipelineExplainOptions._to_valueN)rrrrrrr!rrrrr3s   rc@seZdZUdZded<dS) PlanSummaryz Contains planning phase information about a query.` :type indexes_used: list[dict[str, Any]] :param indexes_used: The indexes selected for this query. zlist[dict[str, Any]] indexes_usedNrrrrrrrrrr"Ms  r"c@s2eZdZUdZded<ded<ded<ded<d S) ExecutionStatsa Execution phase information about a query. Only available when explain_options.analyze is True. :type results_returned: int :param results_returned: Total number of results returned, including documents, projections, aggregation results, keys. :type execution_duration: datetime.timedelta :param execution_duration: Total time to execute the query in the backend. :type read_operations: int :param read_operations: Total billable read operations. :type debug_stats: dict[str, Any] :param debug_stats: Debugging statistics from the execution of the query. Note that the debugging stats are subject to change as Firestore evolves intresults_returnedzdatetime.timedeltaexecution_durationread_operationszdict[str, Any] debug_statsNr$rrrrr%Ys  r%c@s4eZdZUdZded<eddZed dd Zd S) ExplainMetricsa ExplainMetrics contains information about the planning and execution of a query. When explain_options.analyze is false, only plan_summary is available. When explain_options.analyze is true, execution_stats is also available. :type plan_summary: PlanSummary :param plan_summary: Planning phase information about the query. :type execution_stats: ExecutionStats :param execution_stats: Execution phase information about the query. r" plan_summarycCst|jdd}t|didgd}d|vr>|di}tt|dd|jjt|d d|d id }t||d St |d S)NT)preserving_proto_field_namer,r#)r#execution_statsr'rr)r*)r'r(r)r*)r,_execution_stats)r,) r_pbr"getr%r&r.r(_ExplainAnalyzeMetricsr+) metrics_pb dict_reprr, stats_dictr.rrr_from_pbs    zExplainMetrics._from_pbreturnr%cCstd)NzAexecution_stats not available when explain_options.analyze=False.)QueryExplainErrorrrrrr.szExplainMetrics.execution_statsNr7r%) rrrrr staticmethodr6propertyr.rrrrr+rs   r+c@s0eZdZUdZded<ded<ed ddZd S) r2z| Subclass of ExplainMetrics that includes execution_stats. Only available when explain_options.analyze is True. r"r,r%r/r7cC|jS)N)r/rrrrr.sz&_ExplainAnalyzeMetrics.execution_statsNr9)rrrrrr;r.rrrrr2s r2c@seZdZdZdS)r8zW Error returned when there is a problem accessing query profiling information. N)rrrrrrrrr8sr8c@s.eZdZdZd ddZddd Zdd d Zd S)ra[ Contains query profiling statistics for a pipeline query. This class is not meant to be instantiated directly by the user. Instead, an instance of `ExplainStats` may be returned by pipeline execution methods when `explain_options` are provided. It provides methods to access the explain statistics in different formats. stats_pbExplainStats_pbcCs ||_dS)zk Args: stats_pb (ExplainStats_pb): The raw protobuf message for explain stats. N _stats_pb)rr=rrr__init__s zExplainStats.__init__r7rcCs(|jjj}t}||r|jStd)a Returns the explain stats as a string. This method is suitable for explain formats that have a text-based output, such as 'text' or 'json'. Returns: str: The string representation of the explain stats. Raises: QueryExplainError: If the explain stats payload from the backend is not a string. This can happen if a non-text output format was requested. zwUnable to decode explain stats. Did you request an output format that returns a string value, such as 'text' or 'json'?)r@r0datar Unpackvaluer8)rpb_datacontentrrrget_texts  zExplainStats.get_textcCr<)a( Returns the explain stats in an encoded proto format, as returned from the Firestore backend. The caller is responsible for unpacking this proto message. Returns: google.cloud.firestore_v1.types.explain_stats.ExplainStats: the proto from the backend r?rrrrget_rawszExplainStats.get_rawN)r=r>)r7r)r7r>)rrrrrArGrHrrrrrs  r) __future__rtypingrdatetime dataclassesrgoogle.protobuf.json_formatr(google.cloud.firestore_v1.types.documentrr-google.cloud.firestore_v1.types.explain_statsrr>google.protobuf.wrappers_pb2r r rr"r%r+r2 Exceptionr8rrrrs.        *