execute_proc
- execute_proc(
proc_name: string,
params?: Record<string, string>,
bin_params?: Record<string, string>,
input_table_names?: string[],
input_column_names?: Record<string, string[]>,
output_table_names?: string[],
options?: Record<string, string>,
callback?: GPUdbCallback,
): Promise<ExecuteProcResponse>Parameters
- proc_name: string
Name of the proc to execute. Must be the name of a currently existing proc.
Optionalparams: 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.
Optionalbin_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.
Optionalinput_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.
Optionalinput_column_names: Record<string, string[]>Map of table names from
input_table_namesto 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 frominput_table_namesis 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.Optionaloutput_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.Optionaloptions: Record<string, string>Optional parameters.
Optionalcallback: GPUdbCallbackOptional callback function
Returns Promise<ExecuteProcResponse>
Promise<Types.ExecuteProcResponse> - Promise resolving to the response
- Defined in src/GPUdb.ts:8512
- proc_name: string
execute_proc_request
- execute_proc_request(
request: ExecuteProcRequest,
callback?: GPUdbCallback,
): Promise<ExecuteProcResponse>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_table_namesandinput_column_namesmay be passed to the proc to use for reading data, andoutput_table_namesmay 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
- request: ExecuteProcRequest
Request object containing the parameters for the operation
Optionalcallback: GPUdbCallbackOptional callback function
Returns Promise<ExecuteProcResponse>
Promise<Types.ExecuteProcResponse> - Promise resolving to the response
- Defined in src/GPUdb.ts:8450
- request: ExecuteProcRequest
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_table_namesandinput_column_namesmay be passed to the proc to use for reading data, andoutput_table_namesmay be passed to the proc to use for writing data.If the proc being executed is non-distributed, these table parameters will be ignored.