gpudb::CreateProcRequest Struct Reference

A set of input parameters for const. More...

#include <gpudb/protocol/create_proc.h>

Public Member Functions
	CreateProcRequest ()
	Constructs a CreateProcRequest object with default parameter values. More...
	CreateProcRequest (const std::string &procName_, const std::string &executionMode_, const std::map< std::string, std::vector< uint8_t > > &files_, const std::string &command_, const std::vector< std::string > &args_, const std::map< std::string, std::string > &options_)
	Constructs a CreateProcRequest object with the specified parameters. More...

Public Attributes
std::string	procName
std::string	executionMode
std::map< std::string, std::vector< uint8_t > >	files
std::string	command
std::vector< std::string >	args
std::map< std::string, std::string >	options

Detailed Description

A set of input parameters for const.

Creates an instance (proc) of the user-defined functions (UDF) specified by the given command, options, and files, and makes it available for execution.

Definition at line 21 of file create_proc.h.

Constructor & Destructor Documentation

gpudb::CreateProcRequest::CreateProcRequest ( )

inline

Constructs a CreateProcRequest object with default parameter values.

Definition at line 27 of file create_proc.h.

gpudb::CreateProcRequest::CreateProcRequest ( const std::string &  procName_, const std::string &  executionMode_, const std::map< std::string, std::vector< uint8_t > > &  files_, const std::string &  command_, const std::vector< std::string > &  args_, const std::map< std::string, std::string > &  options_  )

inline

Constructs a CreateProcRequest object with the specified parameters.

Parameters

[in]	procName_	Name of the proc to be created. Must not be the name of a currently existing proc.
[in]	executionMode_	The execution mode of the proc. gpudb::create_proc_distributed: Input table data will be divided into data segments that are distributed across all nodes in the cluster, and the proc command will be invoked once per data segment in parallel. Output table data from each invocation will be saved to the same node as the corresponding input data. gpudb::create_proc_nondistributed: The proc command will be invoked only once per execution, and will not have direct access to any tables named as input or output table parameters in the call to /execute/proc. It will, however, be able to access the database using native API calls. The default value is gpudb::create_proc_distributed.
[in]	files_	A map of the files that make up the proc. The keys of the map are file names, and the values are the binary contents of the files. The file names may include subdirectory names (e.g. 'subdir/file') but must not resolve to a directory above the root for the proc. Files may be loaded from existing files in KiFS. Those file names should be prefixed with the uri kifs:// and the values in the map should be empty
[in]	command_	The command (excluding arguments) that will be invoked when the proc is executed. It will be invoked from the directory containing the proc files and may be any command that can be resolved from that directory. It need not refer to a file actually in that directory; for example, it could be 'java' if the proc is a Java application; however, any necessary external programs must be preinstalled on every database node. If the command refers to a file in that directory, it must be preceded with './' as per Linux convention. If not specified, and exactly one file is provided in files, that file will be invoked.
[in]	args_	An array of command-line arguments that will be passed to command when the proc is executed.
[in]	options_	Optional parameters. gpudb::create_proc_max_concurrency_per_node: The maximum number of concurrent instances of the proc that will be executed per node. 0 allows unlimited concurrency. The default value is '0'. gpudb::create_proc_set_environment: A python environment to use when executing the proc. Must be an existing environment, else an error will be returned. The default value is ''.

Definition at line 114 of file create_proc.h.

Member Data Documentation

std::vector<std::string> gpudb::CreateProcRequest::args

Definition at line 128 of file create_proc.h.

std::string gpudb::CreateProcRequest::command

Definition at line 127 of file create_proc.h.

std::string gpudb::CreateProcRequest::executionMode

Definition at line 125 of file create_proc.h.

std::map<std::string, std::vector<uint8_t> > gpudb::CreateProcRequest::files

Definition at line 126 of file create_proc.h.

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

Definition at line 129 of file create_proc.h.

std::string gpudb::CreateProcRequest::procName

Definition at line 124 of file create_proc.h.

---

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

• gpudb/protocol/create_proc.h