Feedback

×

• Feedback
• Was this page helpful?*
  • Yes
  • No
• Do you have any additional feedback?
  • Yes
  • No
• Additional Feedback

Vertica

Query Profiler

QueryProfiler([transactions, key_id, ...])

Base class to profile queries.

Methods:

QueryProfiler.export_profile(filename)	The export_profile() method provides a high-level interface for creating an export bundle of parquet files from a QueryProfiler instance.
QueryProfiler.get_cluster_config()	Returns the Cluster configuration.
QueryProfiler.get_cpu_time([kind, reverse, ...])	Returns the CPU Time by node and path_id chart.
QueryProfiler.get_qduration([unit])	Returns the Query duration.
QueryProfiler.get_qexecution([node_name, ...])	Returns the Query execution chart.
QueryProfiler.get_qexecution_report([...])	Returns the Query execution report.
QueryProfiler.get_qplan([return_report, ...])	Returns the Query Plan chart.
QueryProfiler.get_qplan_tree([path_id, ...])	Draws the Query Plan tree.
QueryProfiler.get_qplan_profile([unit, ...])	Returns the Query Plan chart.
QueryProfiler.get_qsteps([unit, kind, ...])	Returns the Query Execution Steps chart.
QueryProfiler.get_request([indent_sql, ...])	Returns the query linked to the object with the specified transaction ID and statement ID.
QueryProfiler.get_queries()	Returns all the queries and their respective information, of a QueryProfiler object.
QueryProfiler.get_query_events()	Returns a :py:class`vDataFrame` that contains a table listing query events.
QueryProfiler.get_rp_status()	Returns the RP status.
QueryProfiler.get_table([table_name])	Returns the associated Vertica Table.
QueryProfiler.get_version()	Returns the current Vertica version.
QueryProfiler.import_profile(target_schema, ...)	The static method import_profile can be used to create new QueryProfiler object from the contents of a export bundle.
QueryProfiler.insert(transactions)	Functions to insert new transactions to the copy of the performance tables.
QueryProfiler.set_position(idx)	A utility function to utilize a specific transaction from the QueryProfiler stack.
QueryProfiler.next()	A utility function to utilize the next transaction from the QueryProfiler stack.
QueryProfiler.previous()	A utility function to utilize the previous transaction from the QueryProfiler stack.
QueryProfiler.step(idx, *args, **kwargs)	Function to return the QueryProfiler Step.
QueryProfiler.to_html([path])	Creates an HTML report.
QueryProfiler.get_activity_time()	Returns the a report including: Elapsed, exec_time and I/O by node, activity & path_id.
QueryProfiler.get_qplan_explain([display_trees])	Returns the tree's query explain plan as a list of titles and trees.

Query Profiler Interface

QueryProfilerInterface([transactions, ...])

A class that inherits QueryProfiler and adds visualization features.

Methods:

QueryProfilerInterface.export_profile(filename)	The export_profile() method provides a high-level interface for creating an export bundle of parquet files from a QueryProfiler instance.
QueryProfilerInterface.get_cluster_config()	Returns the Cluster configuration.
QueryProfilerInterface.get_cpu_time()	Returns an interactive CPU Time by node and path_id.
QueryProfilerInterface.get_qduration([unit])	Returns the Query duration.
QueryProfilerInterface.get_qexecution([...])	Returns the Query execution chart.
QueryProfilerInterface.get_qexecution_report([...])	Returns the Query execution report.
QueryProfilerInterface.get_qplan([...])	Returns the Query Plan chart.
QueryProfilerInterface.get_qplan_tree([...])	Draws an interactive Query plan tree.
QueryProfilerInterface.get_qplan_profile([...])	Returns the Query Plan chart.
QueryProfilerInterface.get_qsteps([unit, ...])	Returns the Query Execution Steps chart.
QueryProfilerInterface.get_request([...])	Returns the query linked to the object with the specified transaction ID and statement ID.
QueryProfilerInterface.get_queries()	Returns all the queries and their respective information, of a QueryProfiler object.
QueryProfilerInterface.get_query_events()	Returns a :py:class`vDataFrame` that contains a table listing query events.
QueryProfilerInterface.get_rp_status()	Returns the RP status.
QueryProfilerInterface.get_table([table_name])	Returns the associated Vertica Table.
QueryProfilerInterface.get_version()	Returns the current Vertica version.
QueryProfilerInterface.main_tests()	This is the main test to run to get all the information needed to understand queries performances.
QueryProfilerInterface.next()	A utility function to utilize the next transaction from the QueryProfiler stack.
QueryProfilerInterface.previous()	A utility function to utilize the previous transaction from the QueryProfiler stack.
QueryProfilerInterface.set_position(idx)	A utility function to utilize a specific transaction from the QueryProfiler stack.
QueryProfilerInterface.step()	Function to return the QueryProfiler Step.
QueryProfilerInterface.to_html([path])	Creates an HTML report.
QueryProfilerInterface.client_data_test()	This test can be used to check if the time to send the data to client is too huge.
QueryProfilerInterface.clock_exec_time_test()	This test can be used to check if the execution time is near to the clock time.
QueryProfilerInterface.exec_time_test()	Checks if the parser of the SQL is taking too much time.
QueryProfilerInterface.get_activity_time()	Returns the a report including: Elapsed, exec_time and I/O by node, activity & path_id.
QueryProfilerInterface.get_qplan_explain([...])	Returns the tree's query explain plan as a list of titles and trees.
QueryProfilerInterface.get_qsteps_()	Returns an interactive Query Execution Steps chart.
QueryProfilerInterface.get_resource_acquisition()	Returns the a report including the resource acquisition.
QueryProfilerInterface.import_profile(...[, ...])	The static method import_profile can be used to create new QueryProfiler object from the contents of a export bundle.
QueryProfilerInterface.pool_queue_wait_time_test()	This test can be used to see if a pool takes too much time to be allocated.
QueryProfilerInterface.qsteps_clicked(_)
QueryProfilerInterface.query_events_test()	This test can be used to check all types of events.
QueryProfilerInterface.segmentation_test()	This test can be used to check if the data are correctly segmented.
QueryProfilerInterface.update_cpu_time(...)	Callback function that displays the CPU Time by node and path_id.
QueryProfilerInterface.update_qsteps(...)	Callback function that displays the Query Execution Steps.
QueryProfilerInterface.update_step(step_idx)	Callback function that calls a step function based on the step idx.

Query Profiler Comparison

QueryProfilerComparison(qprof1, qprof2)

Initializes a QueryProfilerComparison object with two QueryProfilerInterface instances for side-by-side comparison.

Methods:

QueryProfilerComparison.get_qplan_tree()	Displays the final side-by-side UI.
QueryProfilerComparison.sync_all_checkboxes()	Syncs all checkboxes between qprof1 and qprof2.
QueryProfilerComparison.unsync_all_checkboxes()	Unbind synchronization of checkboxes between qprof1 and qprof2.