execute\_proc(proc\_name=None, params={"{"}{"}"}, bin\_params={"{"}{"}"}, input\_table\_names=\[], input\_column\_names={"{"}{"}"}, output\_table\_names=\[], options={"{"}{"}"})\[source]

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

If the proc being executed is distributed, input parameter input\_table\_names and input parameter input\_column\_names may be passed to the proc to use for reading data, and input parameter output\_table\_names may be passed to the proc to use for writing data.

If the proc being executed is non-distributed, these table parameters will be ignored.

Parameters

proc\_name (str) –

Name of the proc to execute. Must be the name of a currently existing proc.

params (dict of str to str) –

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 dict ( {"{"}{"}"} ).

bin\_params (dict of str 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 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, in \[schema\_name.]table\_name format, using standard name resolution rules. If no table names are specified, no data will be passed to the proc. This parameter is ignored if the proc has a non-distributed execution mode. The default value is an empty list ( \[] ). The user can provide a single element (which will be automatically promoted to a list internally) or a list.

input\_column\_names (dict of str to 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. This parameter is ignored if the proc has a non-distributed execution mode. The 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, each in \[schema\_name.]table\_name format, using standard name resolution rules and meeting table naming criteria. 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. This parameter is ignored if the proc has a non-distributed execution mode. The default value is an empty list ( \[] ). The user can provide a single element (which will be automatically promoted to a list internally) or a list.

options (dict of str to str) –

Optional parameters. Allowed keys are:

cache\_input – No longer supported; option will be ignored. The default value is ‘’.
use\_cached\_input – No longer supported; option will be ignored. The default value is ‘’.
run\_tag – A string that, if not empty, can be used in subsequent calls to GPUdb.show\_proc\_status() or GPUdb.kill\_proc() to identify the proc instance. The default value is ‘’.
max\_output\_lines – The maximum number of lines of output from stdout and stderr to return via GPUdb.show\_proc\_status(). If the number of lines output exceeds the maximum, earlier lines are discarded. The default value is ‘100’.
execute\_at\_startup – If true, an instance of the proc will run when the database is started instead of running immediately. The output parameter run\_id can be retrieved using GPUdb.show\_proc() and used in GPUdb.show\_proc\_status(). Allowed values are:
- true
- false
The default value is ‘false’.
execute\_at\_startup\_as – Sets the alternate user name to execute this proc instance as when execute\_at\_startup is true. The default value is ‘’.

The default value is an empty dict ( {"{"}{"}"} ).

Returns

A dict with the following entries–

run\_id (str) –

The run ID of the running proc instance. This may be passed to GPUdb.show\_proc\_status() to obtain status information, or GPUdb.kill\_proc() to kill the proc instance.

info (dict of str to str) –

Additional information. Allowed keys are:

deferred\_tables – \

The default value is an empty dict ( {"{"}{"}"} ).