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

Kills a running proc instance.

Parameters

run_id (str) –

The run ID of a running proc instance. If a proc with a matching run ID is not found or the proc instance has already completed, no procs will be killed. If not specified, all running proc instances will be killed. The default value is ‘’.

options (dict of str to str) –

Optional parameters. Allowed keys are:

  • run_tag – If input parameter run_id is specified, kill the 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, kill the proc instance(s) where a matching run tag was provided to GPUdb.execute_proc(). The default value is ‘’.

  • clear_execute_at_startup – If true, kill and remove the instance of the proc matching the auto-start run ID that was created to run when the database is started. The auto-start run ID was returned from GPUdb.execute_proc() and can be retrieved using GPUdb.show_proc(). Allowed values are:

    • true

    • false

    The default value is ‘false’.

The default value is an empty dict ( ).

Returns

A dict with the following entries–

run_ids (list of str) –

List of run IDs of proc instances that were killed.

info (dict of str to str) –

Additional information.