A set of parameters for GPUdb::executeProc. More…
#include <gpudb/protocol/execute_proc.h>
Public Member Functions | |
| ExecuteProcRequest () | |
| Constructs an ExecuteProcRequest object with default parameters. | |
| ExecuteProcRequest (const std::string &procName_, const std::map< std::string, std::string > ¶ms_, 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_) | |
| Constructs an ExecuteProcRequest object with the specified parameters. | |
Public Attributes | |
| std::string | procName |
| Name of the proc to execute. | |
| std::map< std::string, std::string > | params |
| A map containing named parameters to pass to the proc. | |
| std::map< std::string, std::vector< uint8_t > > | binParams |
| A map containing named binary parameters to pass to the proc. | |
| std::vector< std::string > | inputTableNames |
| Names of the tables containing data to be passed to the proc. | |
| std::map< std::string, std::vector< std::string > > | inputColumnNames |
| Map of table names from inputTableNames to lists of names of columns from those tables that will be passed to the proc. | |
| std::vector< std::string > | outputTableNames |
| 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. | |
| std::map< std::string, std::string > | options |
| Optional parameters. | |
Detailed Description
A set of parameters for GPUdb::executeProc.
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.
Definition at line 26 of file execute_proc.h.
Constructor & Destructor Documentation
◆ ExecuteProcRequest() [1/2]
| inline |
Constructs an ExecuteProcRequest object with default parameters.
Definition at line 31 of file execute_proc.h.
◆ ExecuteProcRequest() [2/2]
| inline |
Constructs an ExecuteProcRequest object with the specified parameters.
| [in] | procName_ | Name of the proc to execute. Must be the name of a currently existing proc. |
| [in] | params_ | 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. |
| [in] | binParams_ | 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. |
| [in] | inputTableNames_ | 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 vector. |
| [in] | inputColumnNames_ | Map 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] | outputTableNames_ | 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 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] | options_ | Optional parameters.
|
Definition at line 171 of file execute_proc.h.
Member Data Documentation
◆ binParams
| std::map<std::string, std::vector<uint8_t> > gpudb::ExecuteProcRequest::binParams |
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.
Definition at line 200 of file execute_proc.h.
◆ inputColumnNames
| std::map<std::string, std::vector<std::string> > gpudb::ExecuteProcRequest::inputColumnNames |
Map 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.
Definition at line 223 of file execute_proc.h.
◆ inputTableNames
| std::vector<std::string> gpudb::ExecuteProcRequest::inputTableNames |
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 vector.
Definition at line 212 of file execute_proc.h.
◆ options
| std::map<std::string, std::string> gpudb::ExecuteProcRequest::options |
Optional parameters.
- execute_proc_cache_input: No longer supported; option will be ignored. The default value is ”.
- execute_proc_use_cached_input: No longer supported; option will be ignored. The default value is ”.
- execute_proc_run_tag: A string that, if not empty, can be used in subsequent calls to GPUdb::showProcStatus or GPUdb::killProc to identify the proc instance. The default value is ”.
- execute_proc_max_output_lines: The maximum number of lines of output from stdout and stderr to return via GPUdb::showProcStatus. If the number of lines output exceeds the maximum, earlier lines are discarded. The default value is ‘100’.
- execute_proc_execute_at_startup: If true, an instance of the proc will run when the database is started instead of running immediately. The runId can be retrieved using GPUdb::showProc and used in GPUdb::showProcStatus. Supported values:The default value is execute_proc_false.
- execute_proc_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 map.
Definition at line 293 of file execute_proc.h.
◆ outputTableNames
| std::vector<std::string> gpudb::ExecuteProcRequest::outputTableNames |
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 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.
Definition at line 241 of file execute_proc.h.
◆ params
| std::map<std::string, std::string> gpudb::ExecuteProcRequest::params |
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.
Definition at line 193 of file execute_proc.h.
◆ procName
| std::string gpudb::ExecuteProcRequest::procName |
Name of the proc to execute.
Must be the name of a currently existing proc.
Definition at line 186 of file execute_proc.h.
The documentation for this struct was generated from the following file:
- gpudb/protocol/execute_proc.h