Skip to main content
show_proc_status(run_id=”, options=)[source]

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

Parameters

run_id (str) –

The run ID of a specific proc instance for which the status will be returned. If a proc with a matching run ID is not found, the response will be empty. If not specified, the statuses of all executed proc instances will be returned. The default value is ‘’.

options (dict of str to str) –

Optional parameters. Allowed keys are:

  • 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. Allowed values are:

    • true

    • false

    The default value is ‘false’.

  • run_tag – If input parameter run_id is specified, return the status for a proc instance that has a matching run ID and a matching run tag that was provided to GPUdb.execute_proc(). If input parameter run_id is not specified, return statuses for all proc instances where a matching run tag was provided to GPUdb.execute_proc(). The default value is ‘’.

The default value is an empty dict ( ).

Returns

A dict with the following entries–

proc_names (dict of str to str) –

The proc names corresponding to the returned run IDs.

params (dict of str to dicts of str to str) –

The string params passed to GPUdb.execute_proc() for the returned run IDs.

bin_params (dict of str to dicts of str to bytes) –

The binary params passed to GPUdb.execute_proc() for the returned run IDs.

input_table_names (dict of str to lists of str) –

The input table names passed to GPUdb.execute_proc() for the returned run IDs.

input_column_names (dict of str to dicts of str to lists of str) –

The input column names passed to GPUdb.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 str to lists of str) –

The output table names passed to GPUdb.execute_proc() for the returned run IDs.

options (dict of str to dicts of str to str) –

The optional parameters passed to GPUdb.execute_proc() for the returned run IDs.

overall_statuses (dict of str to 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 are:

  • 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.

  • none – The proc instance does not have a status, i.e. it has not yet ran.

statuses (dict of str to dicts of str to str) –

Statuses for the returned run IDs, grouped by data segment ID. Allowed values are:

  • 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.

  • none – The proc instance does not have a status, i.e. it has not yet ran.

messages (dict of str to dicts of str to str) –

Messages containing additional status information for the returned run IDs, grouped by data segment ID.

results (dict of str to dicts of str to dicts of str to str) –

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

bin_results (dict of str to dicts of str to dicts of str to bytes) –

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

output (dict of str to dicts of str to dicts of str to lists of str) –

Output lines for the returned run IDs, grouped by data segment ID. Allowed keys are:

  • stdout – Output lines from stdout.

  • stderr – Output lines from stderr.

timings (dict of str to dicts of str to dicts of str to longs) –

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

info (dict of str to str) –

Additional information.