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

A set of input parameters for createProc(const CreateProcRequest&) 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 createProc(const CreateProcRequest&) const.

Creates an instance (proc) of the user-defined function (UDF) specified by the given command, options, and files, and makes it available for execution. For details on UDFs, see: User-Defined Functions

Definition at line 21 of file create_proc.h.

Constructor & Destructor Documentation

◆ CreateProcRequest() [1/2]

gpudb::CreateProcRequest::CreateProcRequest ( )
inline

Constructs a CreateProcRequest object with default parameter values.

Definition at line 27 of file create_proc.h.

◆ CreateProcRequest() [2/2]

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 access to any input or output table data.
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.
[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.

Definition at line 95 of file create_proc.h.

Member Data Documentation

◆ args

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

Definition at line 109 of file create_proc.h.

◆ command

std::string gpudb::CreateProcRequest::command

Definition at line 108 of file create_proc.h.

◆ executionMode

std::string gpudb::CreateProcRequest::executionMode

Definition at line 106 of file create_proc.h.

◆ files

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

Definition at line 107 of file create_proc.h.

◆ options

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

Definition at line 110 of file create_proc.h.

◆ procName

std::string gpudb::CreateProcRequest::procName

Definition at line 105 of file create_proc.h.


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