/execute/proc

URL: http://GPUDB_IP_ADDRESS:GPUDB_PORT/execute/proc

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	string	Name of the proc to execute. Must be the name of a currently existing proc.
params	map of string to strings	A map containing named parameters to pass to the proc. Each key/value pair specifies the name of a parameter and its value. The default value is an empty map ( {} ).
bin_params	map of string to bytes	A map containing named binary parameters to pass to the proc. Each key/value pair specifies the name of a parameter and its value. The default value is an empty map ( {} ).
input_table_names	array of strings	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. The default value is an empty array ( [] ).
input_column_names	map of string to arrays of strings	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. The default value is an empty map ( {} ).
output_table_names	array of strings	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. The default value is an empty array ( [] ).
options	map of string to strings	Optional parameters. The default value is an empty map ( {} ). 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. The 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. The default value is ''. kifs_input_dirs A comma-delimited list of KiFS directories whose local files will be made directly accessible to the proc through the API. (All KiFS files, local or not, are also accessible through the file system below the KiFS mount point.) Each name specified must the name of an existing KiFS directory. The default value is ''. run_tag A string that, if not empty, can be used in subsequent calls to /show/proc/status or /kill/proc to identify the proc instance. The default value is ''.

Output Parameter Description

The GPUdb server embeds the endpoint response inside a standard response structure which contains status information and the actual response to the query. Here is a description of the various fields of the wrapper:

Name	Type	Description
status	String	'OK' or 'ERROR'
message	String	Empty if success or an error message
data_type	String	'execute_proc_request' or 'none' in case of an error
data	String	Empty string
data_str	JSON or String	This embedded JSON represents the result of the /execute/proc endpoint: Name Type Description run_id string 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. info map of string to strings Additional information. Empty string in case of an error.