Skip to main content

◆ executeProc() [1/4]

ExecuteProcResponse gpudb::GPUdb::executeProc (const ExecuteProcRequest &request_) const

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, inputTableNames and inputColumnNames may be passed to the proc to use for reading data, and outputTableNames 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
[in]request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

◆ executeProc() [2/4]

ExecuteProcResponse & gpudb::GPUdb::executeProc (const ExecuteProcRequest &request_,
ExecuteProcResponse &response_ ) const

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, inputTableNames and inputColumnNames may be passed to the proc to use for reading data, and outputTableNames 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
[in]request_Request object containing the parameters for the operation.
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

◆ executeProc() [3/4]

ExecuteProcResponse gpudb::GPUdb::executeProc (const std::string &procName,
const std::map< std::string, std::string > &params,
const std::map< std::string, std::vector< uint8_t > > &binParams,
const std::vector< std::string > &inputTableNames,
const std::map< std::string, std::vector< std::string > > &inputColumnNames,
const std::vector< std::string > &outputTableNames,
const std::map< std::string, std::string > &options ) const

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, inputTableNames and inputColumnNames may be passed to the proc to use for reading data, and outputTableNames 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
[in]procNameName of the proc to execute. Must be the name of a currently existing proc.
[in]paramsA 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.
[in]binParamsA 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.
[in]inputTableNamesNames 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 vector.
[in]inputColumnNamesMap of table names from inputTableNames 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 inputTableNames 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 map.
[in]outputTableNamesNames 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 inputTableNames, 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 vector.
[in]optionsOptional parameters.The default value is an empty map.
Returns
Response object containing the result of the operation.

◆ executeProc() [4/4]

ExecuteProcResponse & gpudb::GPUdb::executeProc (const std::string &procName,
const std::map< std::string, std::string > &params,
const std::map< std::string, std::vector< uint8_t > > &binParams,
const std::vector< std::string > &inputTableNames,
const std::map< std::string, std::vector< std::string > > &inputColumnNames,
const std::vector< std::string > &outputTableNames,
const std::map< std::string, std::string > &options,
ExecuteProcResponse &response_ ) const

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, inputTableNames and inputColumnNames may be passed to the proc to use for reading data, and outputTableNames 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
[in]procNameName of the proc to execute. Must be the name of a currently existing proc.
[in]paramsA 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.
[in]binParamsA 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.
[in]inputTableNamesNames 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 vector.
[in]inputColumnNamesMap of table names from inputTableNames 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 inputTableNames 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 map.
[in]outputTableNamesNames 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 inputTableNames, 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 vector.
[in]optionsOptional parameters.The default value is an empty map.
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).