com.gpudb.protocol

Class ExecuteSqlRequest

java.lang.Object

com.gpudb.protocol.ExecuteSqlRequest

All Implemented Interfaces:

org.apache.avro.generic.GenericContainer, org.apache.avro.generic.IndexedRecord

public class ExecuteSqlRequest
extends Object
implements org.apache.avro.generic.IndexedRecord

A set of parameters for GPUdb.executeSqlRaw(ExecuteSqlRequest).

SQL Request

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ExecuteSqlRequest.Encoding Specifies the encoding for returned records; either 'binary' or 'json'.
static class	ExecuteSqlRequest.Options Optional parameters.

Constructor Summary

Constructors

Constructor and Description
ExecuteSqlRequest() Constructs an ExecuteSqlRequest object with default parameters.
ExecuteSqlRequest(String statement, long offset, long limit, String requestSchemaStr, List<ByteBuffer> data, Map<String,String> options) Constructs an ExecuteSqlRequest object with the specified parameters.
ExecuteSqlRequest(String statement, long offset, long limit, String encoding, String requestSchemaStr, List<ByteBuffer> data, Map<String,String> options) Constructs an ExecuteSqlRequest object with the specified parameters.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
Object	get(int index) This method supports the Avro framework and is not intended to be called directly by the user.
static org.apache.avro.Schema	getClassSchema() This method supports the Avro framework and is not intended to be called directly by the user.
List<ByteBuffer>	getData()
String	getEncoding()
long	getLimit()
long	getOffset()
Map<String,String>	getOptions()
String	getRequestSchemaStr()
org.apache.avro.Schema	getSchema() This method supports the Avro framework and is not intended to be called directly by the user.
String	getStatement()
int	hashCode()
void	put(int index, Object value) This method supports the Avro framework and is not intended to be called directly by the user.
ExecuteSqlRequest	setData(List<ByteBuffer> data)
ExecuteSqlRequest	setEncoding(String encoding)
ExecuteSqlRequest	setLimit(long limit)
ExecuteSqlRequest	setOffset(long offset)
ExecuteSqlRequest	setOptions(Map<String,String> options)
ExecuteSqlRequest	setRequestSchemaStr(String requestSchemaStr)
ExecuteSqlRequest	setStatement(String statement)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ExecuteSqlRequest

public ExecuteSqlRequest()

Constructs an ExecuteSqlRequest object with default parameters.

ExecuteSqlRequest

public ExecuteSqlRequest(String statement,
                         long offset,
                         long limit,
                         String requestSchemaStr,
                         List<ByteBuffer> data,
                         Map<String,String> options)

Constructs an ExecuteSqlRequest object with the specified parameters.

Parameters:

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

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.

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.

requestSchemaStr - Avro schema of data. The default value is ''.

data - An array of binary-encoded data for the records to be binded to the SQL query. The default value is an empty List.

options - Optional parameters.

• PARALLEL_EXECUTION: If false, disables the parallel step execution of the given query. Supported values:
  • TRUE
  • FALSE
  The default value is TRUE.
• COST_BASED_OPTIMIZATION: If false, disables the cost-based optimization of the given query. Supported values:
  • TRUE
  • FALSE
  The default value is FALSE.
• PLAN_CACHE: If false, disables plan caching for the given query. Supported values:
  • TRUE
  • FALSE
  The default value is TRUE.
• RULE_BASED_OPTIMIZATION: If false, disables rule-based rewrite optimizations for the given query Supported values:
  • TRUE
  • FALSE
  The default value is TRUE.
• RESULTS_CACHING: If false, disables caching of the results of the given query Supported values:
  • TRUE
  • FALSE
  The default value is TRUE.
• PAGING_TABLE: When empty or the specified paging table not exists, the system will create a paging table and return when query output has more records than the user asked. If the paging table exists in the system, the records from the paging table are returned without evaluating the query.
• PAGING_TABLE_TTL: Sets the TTL of the paging table.
• 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:
  • TRUE
  • FALSE
  The default value is FALSE.
• 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:
  • TRUE
  • FALSE
  The default value is FALSE.
• SSQ_OPTIMIZATION: If false, scalar subqueries will be translated into joins Supported values:
  • TRUE
  • FALSE
  The default value is TRUE.
• LATE_MATERIALIZATION: If true, Joins/Filters results will always be materialized ( saved to result tables format) Supported values:
  • TRUE
  • FALSE
  The default value is FALSE.
• TTL: Sets the TTL of the intermediate result tables used in query execution.
• UPDATE_ON_EXISTING_PK: Can be used to customize behavior when the updated primary key value already exists as described in GPUdb.insertRecordsRaw(RawInsertRecordsRequest). Supported values:
  • TRUE
  • FALSE
  The default value is FALSE.
• 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:
  • TRUE
  • FALSE
  The default value is TRUE.
• 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:
  • TRUE: true
  • FALSE: false
  The default value is TRUE.
• 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:
  • TRUE
  • FALSE
  The default value is FALSE.
• VIEW_ID: The default value is ''.
• NO_COUNT: The default value is 'false'.

The default value is an empty Map.

ExecuteSqlRequest

public ExecuteSqlRequest(String statement,
                         long offset,
                         long limit,
                         String encoding,
                         String requestSchemaStr,
                         List<ByteBuffer> data,
                         Map<String,String> options)

Constructs an ExecuteSqlRequest object with the specified parameters.

Parameters:

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

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.

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.

encoding - Specifies the encoding for returned records; either 'binary' or 'json'. Supported values:

• BINARY
• JSON

The default value is BINARY.

requestSchemaStr - Avro schema of data. The default value is ''.

data - An array of binary-encoded data for the records to be binded to the SQL query. The default value is an empty List.

options - Optional parameters.

• PARALLEL_EXECUTION: If false, disables the parallel step execution of the given query. Supported values:
  • TRUE
  • FALSE
  The default value is TRUE.
• COST_BASED_OPTIMIZATION: If false, disables the cost-based optimization of the given query. Supported values:
  • TRUE
  • FALSE
  The default value is FALSE.
• PLAN_CACHE: If false, disables plan caching for the given query. Supported values:
  • TRUE
  • FALSE
  The default value is TRUE.
• RULE_BASED_OPTIMIZATION: If false, disables rule-based rewrite optimizations for the given query Supported values:
  • TRUE
  • FALSE
  The default value is TRUE.
• RESULTS_CACHING: If false, disables caching of the results of the given query Supported values:
  • TRUE
  • FALSE
  The default value is TRUE.
• PAGING_TABLE: When empty or the specified paging table not exists, the system will create a paging table and return when query output has more records than the user asked. If the paging table exists in the system, the records from the paging table are returned without evaluating the query.
• PAGING_TABLE_TTL: Sets the TTL of the paging table.
• 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:
  • TRUE
  • FALSE
  The default value is FALSE.
• 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:
  • TRUE
  • FALSE
  The default value is FALSE.
• SSQ_OPTIMIZATION: If false, scalar subqueries will be translated into joins Supported values:
  • TRUE
  • FALSE
  The default value is TRUE.
• LATE_MATERIALIZATION: If true, Joins/Filters results will always be materialized ( saved to result tables format) Supported values:
  • TRUE
  • FALSE
  The default value is FALSE.
• TTL: Sets the TTL of the intermediate result tables used in query execution.
• UPDATE_ON_EXISTING_PK: Can be used to customize behavior when the updated primary key value already exists as described in GPUdb.insertRecordsRaw(RawInsertRecordsRequest). Supported values:
  • TRUE
  • FALSE
  The default value is FALSE.
• 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:
  • TRUE
  • FALSE
  The default value is TRUE.
• 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:
  • TRUE: true
  • FALSE: false
  The default value is TRUE.
• 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:
  • TRUE
  • FALSE
  The default value is FALSE.
• VIEW_ID: The default value is ''.
• NO_COUNT: The default value is 'false'.

The default value is an empty Map.

Method Detail

getClassSchema

public static org.apache.avro.Schema getClassSchema()

This method supports the Avro framework and is not intended to be called directly by the user.

Returns:

the schema for the class.

getStatement

public String getStatement()

Returns:

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

setStatement

public ExecuteSqlRequest setStatement(String statement)

Parameters:

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

Returns:

this to mimic the builder pattern.

getOffset

public long getOffset()

Returns:

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.

setOffset

public ExecuteSqlRequest setOffset(long offset)

Parameters:

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.

Returns:

this to mimic the builder pattern.

getLimit

public long getLimit()

Returns:

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.

setLimit

public ExecuteSqlRequest setLimit(long limit)

Parameters:

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.

Returns:

this to mimic the builder pattern.

getEncoding

public String getEncoding()

Returns:

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

• BINARY
• JSON

The default value is BINARY.

setEncoding

public ExecuteSqlRequest setEncoding(String encoding)

Parameters:

encoding - Specifies the encoding for returned records; either 'binary' or 'json'. Supported values:

• BINARY
• JSON

The default value is BINARY.

Returns:

this to mimic the builder pattern.

getRequestSchemaStr

public String getRequestSchemaStr()

Returns:

Avro schema of data. The default value is ''.

setRequestSchemaStr

public ExecuteSqlRequest setRequestSchemaStr(String requestSchemaStr)

Parameters:

requestSchemaStr - Avro schema of data. The default value is ''.

Returns:

this to mimic the builder pattern.

getData

public List<ByteBuffer> getData()

Returns:

An array of binary-encoded data for the records to be binded to the SQL query. The default value is an empty List.

setData

public ExecuteSqlRequest setData(List<ByteBuffer> data)

Parameters:

data - An array of binary-encoded data for the records to be binded to the SQL query. The default value is an empty List.

Returns:

this to mimic the builder pattern.

getOptions

public Map<String,String> getOptions()

Returns:

Optional parameters.

• PARALLEL_EXECUTION: If false, disables the parallel step execution of the given query. Supported values:
  • TRUE
  • FALSE
  The default value is TRUE.
• COST_BASED_OPTIMIZATION: If false, disables the cost-based optimization of the given query. Supported values:
  • TRUE
  • FALSE
  The default value is FALSE.
• PLAN_CACHE: If false, disables plan caching for the given query. Supported values:
  • TRUE
  • FALSE
  The default value is TRUE.
• RULE_BASED_OPTIMIZATION: If false, disables rule-based rewrite optimizations for the given query Supported values:
  • TRUE
  • FALSE
  The default value is TRUE.
• RESULTS_CACHING: If false, disables caching of the results of the given query Supported values:
  • TRUE
  • FALSE
  The default value is TRUE.
• PAGING_TABLE: When empty or the specified paging table not exists, the system will create a paging table and return when query output has more records than the user asked. If the paging table exists in the system, the records from the paging table are returned without evaluating the query.
• PAGING_TABLE_TTL: Sets the TTL of the paging table.
• 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:
  • TRUE
  • FALSE
  The default value is FALSE.
• 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:
  • TRUE
  • FALSE
  The default value is FALSE.
• SSQ_OPTIMIZATION: If false, scalar subqueries will be translated into joins Supported values:
  • TRUE
  • FALSE
  The default value is TRUE.
• LATE_MATERIALIZATION: If true, Joins/Filters results will always be materialized ( saved to result tables format) Supported values:
  • TRUE
  • FALSE
  The default value is FALSE.
• TTL: Sets the TTL of the intermediate result tables used in query execution.
• UPDATE_ON_EXISTING_PK: Can be used to customize behavior when the updated primary key value already exists as described in GPUdb.insertRecordsRaw(RawInsertRecordsRequest). Supported values:
  • TRUE
  • FALSE
  The default value is FALSE.
• 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:
  • TRUE
  • FALSE
  The default value is TRUE.
• 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:
  • TRUE: true
  • FALSE: false
  The default value is TRUE.
• 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:
  • TRUE
  • FALSE
  The default value is FALSE.
• VIEW_ID: The default value is ''.
• NO_COUNT: The default value is 'false'.

The default value is an empty Map.

setOptions

public ExecuteSqlRequest setOptions(Map<String,String> options)

Parameters:

options - Optional parameters.

• PARALLEL_EXECUTION: If false, disables the parallel step execution of the given query. Supported values:
  • TRUE
  • FALSE
  The default value is TRUE.
• COST_BASED_OPTIMIZATION: If false, disables the cost-based optimization of the given query. Supported values:
  • TRUE
  • FALSE
  The default value is FALSE.
• PLAN_CACHE: If false, disables plan caching for the given query. Supported values:
  • TRUE
  • FALSE
  The default value is TRUE.
• RULE_BASED_OPTIMIZATION: If false, disables rule-based rewrite optimizations for the given query Supported values:
  • TRUE
  • FALSE
  The default value is TRUE.
• RESULTS_CACHING: If false, disables caching of the results of the given query Supported values:
  • TRUE
  • FALSE
  The default value is TRUE.
• PAGING_TABLE: When empty or the specified paging table not exists, the system will create a paging table and return when query output has more records than the user asked. If the paging table exists in the system, the records from the paging table are returned without evaluating the query.
• PAGING_TABLE_TTL: Sets the TTL of the paging table.
• 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:
  • TRUE
  • FALSE
  The default value is FALSE.
• 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:
  • TRUE
  • FALSE
  The default value is FALSE.
• SSQ_OPTIMIZATION: If false, scalar subqueries will be translated into joins Supported values:
  • TRUE
  • FALSE
  The default value is TRUE.
• LATE_MATERIALIZATION: If true, Joins/Filters results will always be materialized ( saved to result tables format) Supported values:
  • TRUE
  • FALSE
  The default value is FALSE.
• TTL: Sets the TTL of the intermediate result tables used in query execution.
• UPDATE_ON_EXISTING_PK: Can be used to customize behavior when the updated primary key value already exists as described in GPUdb.insertRecordsRaw(RawInsertRecordsRequest). Supported values:
  • TRUE
  • FALSE
  The default value is FALSE.
• 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:
  • TRUE
  • FALSE
  The default value is TRUE.
• 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:
  • TRUE: true
  • FALSE: false
  The default value is TRUE.
• 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:
  • TRUE
  • FALSE
  The default value is FALSE.
• VIEW_ID: The default value is ''.
• NO_COUNT: The default value is 'false'.

The default value is an empty Map.

Returns:

this to mimic the builder pattern.

getSchema

public org.apache.avro.Schema getSchema()

This method supports the Avro framework and is not intended to be called directly by the user.

Specified by:

getSchema in interface org.apache.avro.generic.GenericContainer

Returns:

the schema object describing this class.

get

public Object get(int index)

This method supports the Avro framework and is not intended to be called directly by the user.

Specified by:

get in interface org.apache.avro.generic.IndexedRecord

Parameters:

index - the position of the field to get

Returns:

value of the field with the given index.

Throws:

IndexOutOfBoundsException

put

public void put(int index,
                Object value)

This method supports the Avro framework and is not intended to be called directly by the user.

Specified by:

put in interface org.apache.avro.generic.IndexedRecord

Parameters:

index - the position of the field to set

value - the value to set

Throws:

IndexOutOfBoundsException

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object