GPUdb C++ API  Version 7.0.8.0
gpudb::ExecuteProcRequest Struct Reference

A set of input parameters for executeProc(const ExecuteProcRequest&) const. More...

#include <gpudb/protocol/execute_proc.h>

Public Member Functions

 ExecuteProcRequest ()
 Constructs an ExecuteProcRequest object with default parameter values. More...
 
 ExecuteProcRequest (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_)
 Constructs an ExecuteProcRequest object with the specified parameters. More...
 

Public Attributes

std::string procName
 
std::map< std::string, std::string > params
 
std::map< std::string, std::vector< uint8_t > > binParams
 
std::vector< std::string > inputTableNames
 
std::map< std::string, std::vector< std::string > > inputColumnNames
 
std::vector< std::string > outputTableNames
 
std::map< std::string, std::string > options
 

Detailed Description

A set of input parameters for executeProc(const ExecuteProcRequest&) const.

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

Definition at line 19 of file execute_proc.h.

Constructor & Destructor Documentation

◆ ExecuteProcRequest() [1/2]

gpudb::ExecuteProcRequest::ExecuteProcRequest ( )
inline

Constructs an ExecuteProcRequest object with default parameter values.

Definition at line 26 of file execute_proc.h.

◆ ExecuteProcRequest() [2/2]

gpudb::ExecuteProcRequest::ExecuteProcRequest ( 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_ 
)
inline

Constructs an ExecuteProcRequest object with the specified parameters.

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.
[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.
[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. If no table names are specified, no data will be passed to the proc.
[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.
[in]outputTableNames_Names of the tables to which output data from the proc will be written. 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.
[in]options_Optional parameters.
  • gpudb::execute_proc_cache_input: A comma-delimited list of table names from inputTableNames from which input data will be cached for use in subsequent calls to /execute/proc with the use_cached_input option. Cached input data will be retained until the proc status is cleared with the /show/proc/status option of /show/proc/status and all proc instances using the cached data have completed. The default value is ''.
  • gpudb::execute_proc_use_cached_input: A comma-delimited list of run IDs (as returned from prior calls to /execute/proc) of running or completed proc instances from which input data cached using the cache_input option will be used. Cached input data will not be used for any tables specified in inputTableNames, but data from all other tables cached for the specified run IDs will be passed to the proc. If the same table was cached for multiple specified run IDs, the cached data from the first run ID specified in the list that includes that table will be used. The default value is ''.
  • gpudb::execute_proc_kifs_input_dirs: A comma-delimited list of KiFS directories whose local files will be made directly accessible to the proc through the API. (All KiFS files, local or not, are also accessible through the file system below the KiFS mount point.) Each name specified must the name of an existing KiFS directory. The default value is ''.
  • gpudb::execute_proc_run_tag: A string that, if not empty, can be used in subsequent calls to /show/proc/status or /kill/proc to identify the proc instance. The default value is ''.

Definition at line 122 of file execute_proc.h.

Member Data Documentation

◆ binParams

std::map<std::string, std::vector<uint8_t> > gpudb::ExecuteProcRequest::binParams

Definition at line 135 of file execute_proc.h.

◆ inputColumnNames

std::map<std::string, std::vector<std::string> > gpudb::ExecuteProcRequest::inputColumnNames

Definition at line 137 of file execute_proc.h.

◆ inputTableNames

std::vector<std::string> gpudb::ExecuteProcRequest::inputTableNames

Definition at line 136 of file execute_proc.h.

◆ options

std::map<std::string, std::string> gpudb::ExecuteProcRequest::options

Definition at line 139 of file execute_proc.h.

◆ outputTableNames

std::vector<std::string> gpudb::ExecuteProcRequest::outputTableNames

Definition at line 138 of file execute_proc.h.

◆ params

std::map<std::string, std::string> gpudb::ExecuteProcRequest::params

Definition at line 134 of file execute_proc.h.

◆ procName

std::string gpudb::ExecuteProcRequest::procName

Definition at line 133 of file execute_proc.h.


The documentation for this struct was generated from the following file: