Skip to main content
interface ExecuteProcRequest
bin_params?: Record<string, string>;
input_column_names?: Record<string, string[]>;
input_table_names?: string[];
options?: Record<string, string>;
output_table_names?: string[];
params?: Record<string, string>;
proc_name: string;
bin_params? input_column_names? input_table_names? options? output_table_names? params? proc_name
bin_params?: Record<string, string>

A map containing named binary parameters to pass to the proc. Each key/value pair specifies the name of a parameter and its value.

input_column_names?: Record<string, string[]>

Map of table names from 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_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.

input_table_names?: string[]

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.

options?: Record<string, string>

Optional parameters.

output_table_names?: string[]

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

params?: Record<string, string>

A map containing named parameters to pass to the proc. Each key/value pair specifies the name of a parameter and its value.

proc_name: string

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