verticapy.performance.vertica.qprof_interface.QueryProfilerInterface#
- class verticapy.performance.vertica.qprof_interface.QueryProfilerInterface(transactions: None | str | list[int] | list[tuple[int, int]] = None, key_id: str | None = None, resource_pool: str | None = None, target_schema: None | str | dict = None, overwrite: bool = False, add_profile: bool = True, check_tables: bool = True, iterchecks: bool = False)#
A class that inherits
QueryProfiler
and adds visualization features.- __init__(transactions: None | str | list[int] | list[tuple[int, int]] = None, key_id: str | None = None, resource_pool: str | None = None, target_schema: None | str | dict = None, overwrite: bool = False, add_profile: bool = True, check_tables: bool = True, iterchecks: bool = False) None #
Methods
__init__
([transactions, key_id, ...])apply_tree_settings
(_)...
export_profile
(filename)The
export_profile()
method provides a high-level interface for creating an export bundle of parquet files from a QueryProfiler instance.Returns the Cluster configuration.
Returns an interactive CPU Time by node and
path_id
.get_qduration
([unit])Returns the Query duration.
get_qexecution
([node_name, metric, path_id, ...])Returns the Query execution chart.
Returns the Query execution report.
get_qplan
([return_report, print_plan])Returns the Query Plan chart.
get_qplan_profile
([unit, kind, ...])Returns the Query Plan chart.
get_qplan_tree
([use_javascript])Draws an interactive Query plan tree.
Returns an interactive Query Execution Steps chart.
get_queries
()Returns all the queries and their respective information, of a
QueryProfiler
object.Returns a :py:class`vDataFrame` that contains a table listing query events.
get_request
([indent_sql, print_sql, return_html])Returns the query linked to the object with the specified transaction ID and statement ID.
Returns the RP status.
get_step_funcs
()...
get_table
([table_name])Returns the associated Vertica Table.
Returns the current Vertica version.
import_profile
(target_schema, key_id, filename)The static method
import_profile
can be used to create newQueryProfiler
object from the contents of a export bundle.next
()A utility function to utilize the next transaction from the
QueryProfiler
stack.next_button_clicked
(button)Callback function triggered when the user click on the button to go to the next transaction/query.
next_step_clicked
(button)...
prev_button_clicked
(button)Callback function triggered when the user click on the button to go to the previous transaction/query.
prev_step_clicked
(button)...
previous
()A utility function to utilize the previous transaction from the
QueryProfiler
stack.qsteps_clicked
(_)refresh_clicked
(button)...
set_position
(idx)A utility function to utilize a specific transaction from the
QueryProfiler
stack.step
()Function to return the
QueryProfiler
Step.update_cpu_time
(transaction_idx, kind, ...)Callback function that displays the CPU Time by node and
path_id
.update_qplan_tree
(metric, index, path_id, ...)Callback function that displays the Query Plan Tree.
update_qsteps
(transaction_idx, clicked)Callback function that displays the Query Execution Steps.
update_query_display
()Updates the query display text widget with the current query.
update_step
(step_idx)Callback function that calls a step function based on the step idx.