Version:

show_proc_statusΒΆ

GPUdb.show_proc_status( run_id = '', options = {} )

Shows the statuses of running or completed proc instances. Results are grouped by run ID (as returned from execute_proc) and data segment ID (each invocation of the proc command on a data segment is assigned a data segment ID).

Input Parameter Description

Name Type Description
run_id str The run ID of a specific running or completed proc instance for which the status will be returned. If the run ID is not found, nothing will be returned. If not specified, the statuses of all running and completed proc instances will be returned. Default value is ''.
options dict of str

Optional parameters. Default value is an empty dict ( {} ).

Supported Parameters (keys) Parameter Description
clear_complete

If set to true, if a proc instance has completed (either successfully or unsuccessfully) then its status will be cleared and no longer returned in subsequent calls. Default value is 'false'. The allowed values are:

  • True
  • False

Output Parameter Description

Name Type Description
proc_names dict of str The proc names corresponding to the returned run IDs.
params dict of dicts of str The string params passed to execute_proc for the returned run IDs.
bin_params dict of dicts of str The binary params passed to execute_proc for the returned run IDs.
input_table_names dict of lists of str The input table names passed to execute_proc for the returned run IDs.
input_column_names dict of dicts of lists of str The input column names passed to execute_proc for the returned run IDs, supplemented with the column names for input tables not included in the input column name map.
output_table_names dict of lists of str The output table names passed to execute_proc for the returned run IDs.
options dict of dicts of str The optional parameters passed to execute_proc for the returned run IDs.
overall_statuses dict of str

Overall statuses for the returned run IDs. Note that these are rollups and individual statuses may differ between data segments for the same run ID; see output parameter statuses and output parameter messages for statuses from individual data segments.

Allowed Values Description
running The proc instance is currently running.
complete The proc instance completed with no errors.
killed The proc instance was killed before completion.
error The proc instance failed with an error.
statuses dict of dicts of str

Statuses for the returned run IDs, grouped by data segment ID.

Allowed Values Description
dict of str
Allowed Values Description
running The proc instance is currently running.
complete The proc instance completed with no errors.
killed The proc instance was killed before completion.
error The proc instance failed with an error.
messages dict of dicts of str Messages containing additional status information for the returned run IDs, grouped by data segment ID.
results dict of dicts of dicts of str String results for the returned run IDs, grouped by data segment ID.
bin_results dict of dicts of dicts of str Binary results for the returned run IDs, grouped by data segment ID.
timings dict of dicts of dicts of longs Timing information for the returned run IDs, grouped by data segment ID.