GPUdb C++ API  Version 7.0.19.0
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
gpudb::ExecuteSqlRequest Struct Reference

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

#include <gpudb/protocol/execute_sql.h>

Public Member Functions

 ExecuteSqlRequest ()
 Constructs an ExecuteSqlRequest object with default parameter values. More...
 
 ExecuteSqlRequest (const std::string &statement_, const int64_t offset_, const int64_t limit_, const std::string &requestSchemaStr_, const std::vector< std::vector< uint8_t > > &data_, const std::map< std::string, std::string > &options_)
 Constructs an ExecuteSqlRequest object with the specified parameters. More...
 
 ExecuteSqlRequest (const std::string &statement_, const int64_t offset_, const int64_t limit_, const std::string &encoding_, const std::string &requestSchemaStr_, const std::vector< std::vector< uint8_t > > &data_, const std::map< std::string, std::string > &options_)
 Constructs an ExecuteSqlRequest object with the specified parameters. More...
 

Public Attributes

std::string statement
 
int64_t offset
 
int64_t limit
 
std::string encoding
 
std::string requestSchemaStr
 
std::vector< std::vector
< uint8_t > > 
data
 
std::map< std::string,
std::string > 
options
 

Detailed Description

A set of input parameters for const.

SQL Request

Definition at line 20 of file execute_sql.h.

Constructor & Destructor Documentation

gpudb::ExecuteSqlRequest::ExecuteSqlRequest ( )
inline

Constructs an ExecuteSqlRequest object with default parameter values.

Definition at line 27 of file execute_sql.h.

gpudb::ExecuteSqlRequest::ExecuteSqlRequest ( const std::string &  statement_,
const int64_t  offset_,
const int64_t  limit_,
const std::string &  requestSchemaStr_,
const std::vector< std::vector< uint8_t > > &  data_,
const std::map< std::string, std::string > &  options_ 
)
inline

Constructs an ExecuteSqlRequest object with the specified parameters.

Parameters
[in]statement_SQL statement (query, DML, or DDL) to be executed
[in]offset_A positive integer indicating the number of initial results to skip (this can be useful for paging through the results). The minimum allowed value is 0. The maximum allowed value is MAX_INT.
[in]limit_A positive integer indicating the maximum number of results to be returned, or END_OF_SET (-9999) to indicate that the maximum number of results allowed by the server should be returned. The number of records returned will never exceed the server's own limit, defined by the max_get_records_size parameter in the server configuration. Use hasMoreRecords to see if more records exist in the result to be fetched, and offset & limit to request subsequent pages of results.
[in]requestSchemaStr_Avro schema of data.
[in]data_An array of binary-encoded data for the records to be binded to the SQL query.
[in]options_Optional parameters.

Definition at line 220 of file execute_sql.h.

gpudb::ExecuteSqlRequest::ExecuteSqlRequest ( const std::string &  statement_,
const int64_t  offset_,
const int64_t  limit_,
const std::string &  encoding_,
const std::string &  requestSchemaStr_,
const std::vector< std::vector< uint8_t > > &  data_,
const std::map< std::string, std::string > &  options_ 
)
inline

Constructs an ExecuteSqlRequest object with the specified parameters.

Parameters
[in]statement_SQL statement (query, DML, or DDL) to be executed
[in]offset_A positive integer indicating the number of initial results to skip (this can be useful for paging through the results). The minimum allowed value is 0. The maximum allowed value is MAX_INT.
[in]limit_A positive integer indicating the maximum number of results to be returned, or END_OF_SET (-9999) to indicate that the maximum number of results allowed by the server should be returned. The number of records returned will never exceed the server's own limit, defined by the max_get_records_size parameter in the server configuration. Use hasMoreRecords to see if more records exist in the result to be fetched, and offset & limit to request subsequent pages of results.
[in]encoding_Specifies the encoding for returned records; either 'binary' or 'json'. The default value is gpudb::execute_sql_binary.
[in]requestSchemaStr_Avro schema of data.
[in]data_An array of binary-encoded data for the records to be binded to the SQL query.
[in]options_Optional parameters.

Definition at line 421 of file execute_sql.h.

Member Data Documentation

std::vector<std::vector<uint8_t> > gpudb::ExecuteSqlRequest::data

Definition at line 437 of file execute_sql.h.

std::string gpudb::ExecuteSqlRequest::encoding

Definition at line 435 of file execute_sql.h.

int64_t gpudb::ExecuteSqlRequest::limit

Definition at line 434 of file execute_sql.h.

int64_t gpudb::ExecuteSqlRequest::offset

Definition at line 433 of file execute_sql.h.

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

Definition at line 438 of file execute_sql.h.

std::string gpudb::ExecuteSqlRequest::requestSchemaStr

Definition at line 436 of file execute_sql.h.

std::string gpudb::ExecuteSqlRequest::statement

Definition at line 432 of file execute_sql.h.


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