execute_proc

GPUdb.execute_proc( proc_name = None, params = {}, bin_params = {},
                    input_table_names = [], input_column_names = {},
                    output_table_names = [], options = {} )

Executes a proc. This endpoint is asynchronous and does not wait for the proc to complete before returning.

Input Parameter Description

Name	Type	Description
proc_name	str	Name of the proc to execute. Must be the name of a currently existing proc.
params	dict of str	A map containing named parameters to pass to the proc. Each key/value pair specifies the name of a parameter and its value. Default value is an empty dict ( {} ).
bin_params	dict of str	A map containing named binary parameters to pass to the proc. Each key/value pair specifies the name of a parameter and its value. Default value is an empty dict ( {} ).
input_table_names	list of str	Names of the tables containing data to be passed to the proc. Each name specified must be the name of a currently existing table. If no table names are specified, no data will be passed to the proc. Default value is an empty list ( [] ).
input_column_names	dict of lists of str	Map of table names from input parameter input_table_names to lists of names of columns from those tables that will be passed to the proc. Each column name specified must be the name of an existing column in the corresponding table. If a table name from input parameter input_table_names is not included, all columns from that table will be passed to the proc. Default value is an empty dict ( {} ).
output_table_names	list of str	Names of the tables to which output data from the proc will be written. If a specified table does not exist, it will automatically be created with the same schema as the corresponding table (by order) from input parameter input_table_names, excluding any primary and shard keys. If a specified table is a non-persistent result table, it must not have primary or shard keys. If no table names are specified, no output data can be returned from the proc. Default value is an empty list ( [] ).
options	dict of str	Optional parameters. Default value is an empty dict ( {} ). Supported Parameters (keys) Parameter Description cache_input A comma-delimited list of table names from input parameter input_table_names from which input data will be cached for use in subsequent calls to execute_proc with the use_cached_input option. Cached input data will be retained until the proc status is cleared with the clear_complete option of show_proc_status and all proc instances using the cached data have completed. Default value is ''. use_cached_input A comma-delimited list of run IDs (as returned from prior calls to execute_proc) of running or completed proc instances from which input data cached using the cache_input option will be used. Cached input data will not be used for any tables specified in input parameter input_table_names, but data from all other tables cached for the specified run IDs will be passed to the proc. If the same table was cached for multiple specified run IDs, the cached data from the first run ID specified in the list that includes that table will be used. Default value is ''.

Output Parameter Description

Name	Type	Description
run_id	str	The run ID of the running proc instance. This may be passed to show_proc_status to obtain status information, or kill_proc to kill the proc instance.