gpudb::ExecuteSqlRequest Struct Reference

A set of parameters for GPUdb::executeSql. More...

#include <gpudb/protocol/execute_sql.h>

Public Member Functions
	ExecuteSqlRequest ()
	Constructs an ExecuteSqlRequest object with default parameters. 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
	SQL statement (query, DML, or DDL) to be executed. More...
int64_t	offset
	A positive integer indicating the number of initial results to skip (this can be useful for paging through the results). More...
int64_t	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. More...
std::string	encoding
	Specifies the encoding for returned records; either 'binary' or 'json'. More...
std::string	requestSchemaStr
	Avro schema of data. More...
std::vector< std::vector< uint8_t > >	data
	An array of binary-encoded data for the records to be binded to the SQL query. More...
std::map< std::string, std::string >	options
	Optional parameters. More...

Detailed Description

A set of parameters for GPUdb::executeSql.

Execute a SQL statement (query, DML, or DDL).

See SQL Support for the complete set of supported SQL commands.

When a caller wants all the results from a large query (e.g., more than max_get_records_size records), they can make multiple calls to this endpoint using the offset and limit parameters to page through the results. Normally, this will execute the statement query each time. To avoid re-executing the query each time and to keep the results in the same order, the caller should specify a paging_table name to hold the results of the query between calls and specify the paging_table on subsequent calls. When this is done, the caller should clear the paging table and any other tables in the result_table_list (both returned in the response) when they are done paging through the results. pagingTable (and result_table_list) will be empty if no paging table was created (e.g., when all the query results were returned in the first call).

Definition at line 41 of file execute_sql.h.

Constructor & Destructor Documentation

ExecuteSqlRequest() [1/3]

gpudb::ExecuteSqlRequest::ExecuteSqlRequest ( )

inline

Constructs an ExecuteSqlRequest object with default parameters.

Definition at line 46 of file execute_sql.h.

ExecuteSqlRequest() [2/3]

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 default value is 0. 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. The default value is -9999.
[in]	requestSchemaStr_	Avro schema of data_. The default value is ''.
[in]	data_	An array of binary-encoded data for the records to be binded to the SQL query. Or use query_parameters to pass the data in JSON format. The default value is an empty vector.
[in]	options_	Optional parameters. execute_sql_cost_based_optimization: If false, disables the cost-based optimization of the given query. Supported values: execute_sql_true execute_sql_false The default value is execute_sql_false. execute_sql_distributed_joins: If true, enables the use of distributed joins in servicing the given query. Any query requiring a distributed join will succeed, though hints can be used in the query to change the distribution of the source data to allow the query to succeed. Supported values: execute_sql_true execute_sql_false The default value is execute_sql_false. execute_sql_distributed_operations: If true, enables the use of distributed operations in servicing the given query. Any query requiring a distributed join will succeed, though hints can be used in the query to change the distribution of the source data to allow the query to succeed. Supported values: execute_sql_true execute_sql_false The default value is execute_sql_false. execute_sql_ignore_existing_pk: Specifies the record collision error-suppression policy for inserting into or updating a table with a primary key, only used when primary key record collisions are rejected (update_on_existing_pk is false). If set to true, any record insert/update that is rejected for resulting in a primary key collision with an existing table record will be ignored with no error generated. If false, the rejection of any insert/update for resulting in a primary key collision will cause an error to be reported. If the specified table does not have a primary key or if update_on_existing_pk is true, then this option has no effect. Supported values: execute_sql_true: Ignore inserts/updates that result in primary key collisions with existing records execute_sql_false: Treat as errors any inserts/updates that result in primary key collisions with existing records The default value is execute_sql_false. execute_sql_late_materialization: If true, Joins/Filters results will always be materialized ( saved to result tables format). Supported values: execute_sql_true execute_sql_false The default value is execute_sql_false. execute_sql_paging_table: When specified (or paging_table_ttl is set), the system will create a paging table to hold the results of the query, when the output has more records than are in the response (i.e., when hasMoreRecords is true). If the specified paging table exists, the records from the paging table are returned without re-evaluating the query. It is the caller's responsibility to clear the pagingTable and other tables in the result_table_list (both returned in the response) when they are done with this query. execute_sql_paging_table_ttl: Sets the TTL of the paging table. -1 indicates no timeout. Setting this option will cause a paging table to be generated when needed. The pagingTable and other tables in the result_table_list (both returned in the response) will be automatically cleared after the TTL expires, if set to a positive number. However, it is still recommended that the caller clear these tables when they are done with this query. execute_sql_parallel_execution: If false, disables the parallel step execution of the given query. Supported values: execute_sql_true execute_sql_false The default value is execute_sql_true. execute_sql_plan_cache: If false, disables plan caching for the given query. Supported values: execute_sql_true execute_sql_false The default value is execute_sql_true. execute_sql_prepare_mode: If true, compiles a query into an execution plan and saves it in query cache. Query execution is not performed and an empty response will be returned to user. Supported values: execute_sql_true execute_sql_false The default value is execute_sql_false. execute_sql_preserve_dict_encoding: If true, then columns that were dict encoded in the source table will be dict encoded in the projection table. Supported values: execute_sql_true execute_sql_false The default value is execute_sql_true. execute_sql_query_parameters: Query parameters in JSON array or arrays (for inserting multiple rows). This can be used instead of data_ and requestSchemaStr_. execute_sql_results_caching: If false, disables caching of the results of the given query. Supported values: execute_sql_true execute_sql_false The default value is execute_sql_true. execute_sql_rule_based_optimization: If false, disables rule-based rewrite optimizations for the given query. Supported values: execute_sql_true execute_sql_false The default value is execute_sql_true. execute_sql_ssq_optimization: If false, scalar subqueries will be translated into joins. Supported values: execute_sql_true execute_sql_false The default value is execute_sql_true. execute_sql_ttl: Sets the TTL of the intermediate result tables used in query execution. execute_sql_update_on_existing_pk: Specifies the record collision policy for inserting into or updating a table with a primary key. If set to true, any existing table record with primary key values that match those of a record being inserted or updated will be replaced by that record. If set to false, any such primary key collision will result in the insert/update being rejected and the error handled as determined by ignore_existing_pk. If the specified table does not have a primary key, then this option has no effect. Supported values: execute_sql_true: Replace the collided-into record with the record inserted or updated when a new/modified record causes a primary key collision with an existing record execute_sql_false: Reject the insert or update when it results in a primary key collision with an existing record The default value is execute_sql_false. execute_sql_validate_change_column: When changing a column using alter table, validate the change before applying it. If true, then validate all values. A value too large (or too long) for the new type will prevent any change. If false, then when a value is too large or long, it will be truncated. Supported values: execute_sql_true execute_sql_false The default value is execute_sql_true. execute_sql_current_schema: Use the supplied value as the default schema when processing this SQL command. The default value is an empty map.

Definition at line 453 of file execute_sql.h.

ExecuteSqlRequest() [3/3]

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 default value is 0. 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. The default value is -9999.
[in]	encoding_	Specifies the encoding for returned records; either 'binary' or 'json'. Supported values: execute_sql_binary execute_sql_json The default value is execute_sql_binary.
[in]	requestSchemaStr_	Avro schema of data_. The default value is ''.
[in]	data_	An array of binary-encoded data for the records to be binded to the SQL query. Or use query_parameters to pass the data in JSON format. The default value is an empty vector.
[in]	options_	Optional parameters. execute_sql_cost_based_optimization: If false, disables the cost-based optimization of the given query. Supported values: execute_sql_true execute_sql_false The default value is execute_sql_false. execute_sql_distributed_joins: If true, enables the use of distributed joins in servicing the given query. Any query requiring a distributed join will succeed, though hints can be used in the query to change the distribution of the source data to allow the query to succeed. Supported values: execute_sql_true execute_sql_false The default value is execute_sql_false. execute_sql_distributed_operations: If true, enables the use of distributed operations in servicing the given query. Any query requiring a distributed join will succeed, though hints can be used in the query to change the distribution of the source data to allow the query to succeed. Supported values: execute_sql_true execute_sql_false The default value is execute_sql_false. execute_sql_ignore_existing_pk: Specifies the record collision error-suppression policy for inserting into or updating a table with a primary key, only used when primary key record collisions are rejected (update_on_existing_pk is false). If set to true, any record insert/update that is rejected for resulting in a primary key collision with an existing table record will be ignored with no error generated. If false, the rejection of any insert/update for resulting in a primary key collision will cause an error to be reported. If the specified table does not have a primary key or if update_on_existing_pk is true, then this option has no effect. Supported values: execute_sql_true: Ignore inserts/updates that result in primary key collisions with existing records execute_sql_false: Treat as errors any inserts/updates that result in primary key collisions with existing records The default value is execute_sql_false. execute_sql_late_materialization: If true, Joins/Filters results will always be materialized ( saved to result tables format). Supported values: execute_sql_true execute_sql_false The default value is execute_sql_false. execute_sql_paging_table: When specified (or paging_table_ttl is set), the system will create a paging table to hold the results of the query, when the output has more records than are in the response (i.e., when hasMoreRecords is true). If the specified paging table exists, the records from the paging table are returned without re-evaluating the query. It is the caller's responsibility to clear the pagingTable and other tables in the result_table_list (both returned in the response) when they are done with this query. execute_sql_paging_table_ttl: Sets the TTL of the paging table. -1 indicates no timeout. Setting this option will cause a paging table to be generated when needed. The pagingTable and other tables in the result_table_list (both returned in the response) will be automatically cleared after the TTL expires, if set to a positive number. However, it is still recommended that the caller clear these tables when they are done with this query. execute_sql_parallel_execution: If false, disables the parallel step execution of the given query. Supported values: execute_sql_true execute_sql_false The default value is execute_sql_true. execute_sql_plan_cache: If false, disables plan caching for the given query. Supported values: execute_sql_true execute_sql_false The default value is execute_sql_true. execute_sql_prepare_mode: If true, compiles a query into an execution plan and saves it in query cache. Query execution is not performed and an empty response will be returned to user. Supported values: execute_sql_true execute_sql_false The default value is execute_sql_false. execute_sql_preserve_dict_encoding: If true, then columns that were dict encoded in the source table will be dict encoded in the projection table. Supported values: execute_sql_true execute_sql_false The default value is execute_sql_true. execute_sql_query_parameters: Query parameters in JSON array or arrays (for inserting multiple rows). This can be used instead of data_ and requestSchemaStr_. execute_sql_results_caching: If false, disables caching of the results of the given query. Supported values: execute_sql_true execute_sql_false The default value is execute_sql_true. execute_sql_rule_based_optimization: If false, disables rule-based rewrite optimizations for the given query. Supported values: execute_sql_true execute_sql_false The default value is execute_sql_true. execute_sql_ssq_optimization: If false, scalar subqueries will be translated into joins. Supported values: execute_sql_true execute_sql_false The default value is execute_sql_true. execute_sql_ttl: Sets the TTL of the intermediate result tables used in query execution. execute_sql_update_on_existing_pk: Specifies the record collision policy for inserting into or updating a table with a primary key. If set to true, any existing table record with primary key values that match those of a record being inserted or updated will be replaced by that record. If set to false, any such primary key collision will result in the insert/update being rejected and the error handled as determined by ignore_existing_pk. If the specified table does not have a primary key, then this option has no effect. Supported values: execute_sql_true: Replace the collided-into record with the record inserted or updated when a new/modified record causes a primary key collision with an existing record execute_sql_false: Reject the insert or update when it results in a primary key collision with an existing record The default value is execute_sql_false. execute_sql_validate_change_column: When changing a column using alter table, validate the change before applying it. If true, then validate all values. A value too large (or too long) for the new type will prevent any change. If false, then when a value is too large or long, it will be truncated. Supported values: execute_sql_true execute_sql_false The default value is execute_sql_true. execute_sql_current_schema: Use the supplied value as the default schema when processing this SQL command. The default value is an empty map.

Definition at line 872 of file execute_sql.h.

Member Data Documentation

data

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

An array of binary-encoded data for the records to be binded to the SQL query.

Or use query_parameters to pass the data in JSON format. The default value is an empty vector.

Definition at line 934 of file execute_sql.h.

encoding

std::string gpudb::ExecuteSqlRequest::encoding

Specifies the encoding for returned records; either 'binary' or 'json'.

Supported values:

• execute_sql_binary
• execute_sql_json

The default value is execute_sql_binary.

Definition at line 921 of file execute_sql.h.

limit

int64_t gpudb::ExecuteSqlRequest::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. The default value is -9999.

Definition at line 908 of file execute_sql.h.

offset

int64_t gpudb::ExecuteSqlRequest::offset

A positive integer indicating the number of initial results to skip (this can be useful for paging through the results).

The default value is 0. The minimum allowed value is 0. The maximum allowed value is MAX_INT.

Definition at line 894 of file execute_sql.h.

options

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

Optional parameters.

• execute_sql_cost_based_optimization: If false, disables the cost-based optimization of the given query. Supported values:
  • execute_sql_true
  • execute_sql_false
  The default value is execute_sql_false.
• execute_sql_distributed_joins: If true, enables the use of distributed joins in servicing the given query. Any query requiring a distributed join will succeed, though hints can be used in the query to change the distribution of the source data to allow the query to succeed. Supported values:
  • execute_sql_true
  • execute_sql_false
  The default value is execute_sql_false.
• execute_sql_distributed_operations: If true, enables the use of distributed operations in servicing the given query. Any query requiring a distributed join will succeed, though hints can be used in the query to change the distribution of the source data to allow the query to succeed. Supported values:
  • execute_sql_true
  • execute_sql_false
  The default value is execute_sql_false.
• execute_sql_ignore_existing_pk: Specifies the record collision error-suppression policy for inserting into or updating a table with a primary key, only used when primary key record collisions are rejected (update_on_existing_pk is false). If set to true, any record insert/update that is rejected for resulting in a primary key collision with an existing table record will be ignored with no error generated. If false, the rejection of any insert/update for resulting in a primary key collision will cause an error to be reported. If the specified table does not have a primary key or if update_on_existing_pk is true, then this option has no effect. Supported values:
  • execute_sql_true: Ignore inserts/updates that result in primary key collisions with existing records
  • execute_sql_false: Treat as errors any inserts/updates that result in primary key collisions with existing records
  The default value is execute_sql_false.
• execute_sql_late_materialization: If true, Joins/Filters results will always be materialized ( saved to result tables format). Supported values:
  • execute_sql_true
  • execute_sql_false
  The default value is execute_sql_false.
• execute_sql_paging_table: When specified (or paging_table_ttl is set), the system will create a paging table to hold the results of the query, when the output has more records than are in the response (i.e., when hasMoreRecords is true). If the specified paging table exists, the records from the paging table are returned without re-evaluating the query. It is the caller's responsibility to clear the pagingTable and other tables in the result_table_list (both returned in the response) when they are done with this query.
• execute_sql_paging_table_ttl: Sets the TTL of the paging table. -1 indicates no timeout. Setting this option will cause a paging table to be generated when needed. The pagingTable and other tables in the result_table_list (both returned in the response) will be automatically cleared after the TTL expires, if set to a positive number. However, it is still recommended that the caller clear these tables when they are done with this query.
• execute_sql_parallel_execution: If false, disables the parallel step execution of the given query. Supported values:
  • execute_sql_true
  • execute_sql_false
  The default value is execute_sql_true.
• execute_sql_plan_cache: If false, disables plan caching for the given query. Supported values:
  • execute_sql_true
  • execute_sql_false
  The default value is execute_sql_true.
• execute_sql_prepare_mode: If true, compiles a query into an execution plan and saves it in query cache. Query execution is not performed and an empty response will be returned to user. Supported values:
  • execute_sql_true
  • execute_sql_false
  The default value is execute_sql_false.
• execute_sql_preserve_dict_encoding: If true, then columns that were dict encoded in the source table will be dict encoded in the projection table. Supported values:
  • execute_sql_true
  • execute_sql_false
  The default value is execute_sql_true.
• execute_sql_query_parameters: Query parameters in JSON array or arrays (for inserting multiple rows). This can be used instead of data and requestSchemaStr.
• execute_sql_results_caching: If false, disables caching of the results of the given query. Supported values:
  • execute_sql_true
  • execute_sql_false
  The default value is execute_sql_true.
• execute_sql_rule_based_optimization: If false, disables rule-based rewrite optimizations for the given query. Supported values:
  • execute_sql_true
  • execute_sql_false
  The default value is execute_sql_true.
• execute_sql_ssq_optimization: If false, scalar subqueries will be translated into joins. Supported values:
  • execute_sql_true
  • execute_sql_false
  The default value is execute_sql_true.
• execute_sql_ttl: Sets the TTL of the intermediate result tables used in query execution.
• execute_sql_update_on_existing_pk: Specifies the record collision policy for inserting into or updating a table with a primary key. If set to true, any existing table record with primary key values that match those of a record being inserted or updated will be replaced by that record. If set to false, any such primary key collision will result in the insert/update being rejected and the error handled as determined by ignore_existing_pk. If the specified table does not have a primary key, then this option has no effect. Supported values:
  • execute_sql_true: Replace the collided-into record with the record inserted or updated when a new/modified record causes a primary key collision with an existing record
  • execute_sql_false: Reject the insert or update when it results in a primary key collision with an existing record
  The default value is execute_sql_false.
• execute_sql_validate_change_column: When changing a column using alter table, validate the change before applying it. If true, then validate all values. A value too large (or too long) for the new type will prevent any change. If false, then when a value is too large or long, it will be truncated. Supported values:
  • execute_sql_true
  • execute_sql_false
  The default value is execute_sql_true.
• execute_sql_current_schema: Use the supplied value as the default schema when processing this SQL command.

The default value is an empty map.

Definition at line 1183 of file execute_sql.h.

requestSchemaStr

std::string gpudb::ExecuteSqlRequest::requestSchemaStr

Avro schema of data.

The default value is ''.

Definition at line 926 of file execute_sql.h.

statement

std::string gpudb::ExecuteSqlRequest::statement

SQL statement (query, DML, or DDL) to be executed.

Definition at line 886 of file execute_sql.h.

---

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

• gpudb/protocol/execute_sql.h