ExecuteSqlRequest.Options (Kinetica Java API 7.1.10.4 API)

java.lang.Object
- com.gpudb.protocol.ExecuteSqlRequest.Options

Enclosing class:

ExecuteSqlRequest
```
public static final class ExecuteSqlRequest.Options
extends Object
```
Optional parameters.
- COST_BASED_OPTIMIZATION: If false, disables the cost-based optimization of the given query. Supported values:
  - TRUE
  - FALSE
  The default value is FALSE.
- 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.
- 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:
  - TRUE: Ignore inserts/updates that result in primary key collisions with existing records
  - FALSE: Treat as errors any inserts/updates that result in primary key collisions with existing records
  The default value is FALSE.
- 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.
- 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.
- PARALLEL_EXECUTION: If false, disables the parallel step execution of the given query. Supported values:
  - TRUE
  - FALSE
  The default value is TRUE.
- PLAN_CACHE: If false, disables plan caching for the given query. Supported values:
  - TRUE
  - 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.
- 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.
- QUERY_PARAMETERS: Query parameters in JSON array or arrays (for inserting multiple rows). This can be used instead of data and requestSchemaStr.
- RESULTS_CACHING: If false, disables caching of the results of 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.
- SSQ_OPTIMIZATION: If false, scalar subqueries will be translated into joins Supported values:
  - TRUE
  - FALSE
  The default value is TRUE.
- TTL: Sets the TTL of the intermediate result tables used in query execution.
- 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:
  - 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
  - FALSE: Reject the insert or update when it results in a primary key collision with an existing record
  The default value is FALSE.
- 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
  - FALSE
  The default value is TRUE.
- CURRENT_SCHEMA: Use the supplied value as the default schema when processing this SQL command.
The default value is an empty Map. A set of string constants for the parameter options.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`COST_BASED_OPTIMIZATION` If `false`, disables the cost-based optimization of the given query.
`static String`	`CURRENT_SCHEMA` Use the supplied value as the	`static String`	`DISTRIBUTED_JOINS` If `true`, enables the use of distributed joins in servicing the given query.
`static String`	`DISTRIBUTED_OPERATIONS` If `true`, enables the use of distributed operations in servicing the given query.
`static String`	`FALSE`
`static String`	`IGNORE_EXISTING_PK` Specifies the record collision error-suppression policy for inserting into or updating a table with a	`static String`	`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`.
`static String`	`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.
`static String`	`PAGING_TABLE_TTL` Sets the	`static String`	`PARALLEL_EXECUTION` If `false`, disables the parallel step execution of the given query.
`static String`	`PLAN_CACHE` If `false`, disables plan caching for the given query.
`static String`	`PREPARE_MODE` If `true`, compiles a query into an execution plan and saves it in query cache.
`static String`	`PRESERVE_DICT_ENCODING` If `true`, then columns that were dict encoded in the source table will be dict encoded in the projection table.
`static String`	`QUERY_PARAMETERS` Query parameters in JSON array or arrays (for inserting multiple rows).
`static String`	`RESULTS_CACHING` If `false`, disables caching of the results of the given query Supported values: `TRUE` `FALSE` The default value is `TRUE`.
`static String`	`RULE_BASED_OPTIMIZATION` If `false`, disables rule-based rewrite optimizations for the given query Supported values: `TRUE` `FALSE` The default value is `TRUE`.
`static String`	`SSQ_OPTIMIZATION` If `false`, scalar subqueries will be translated into joins Supported values: `TRUE` `FALSE` The default value is `TRUE`.
`static String`	`TRUE`
`static String`	`TTL` Sets the	`static String`	`UPDATE_ON_EXISTING_PK` Specifies the record collision policy for inserting into or updating a table with a	`static String`	`VALIDATE_CHANGE_COLUMN` When changing a column using alter table, validate the change before applying it.

Method Summary
- Methods inherited from class java.lang.Object
  clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - COST_BASED_OPTIMIZATION
```
public static final String COST_BASED_OPTIMIZATION
```
    If false, disables the cost-based optimization of the given query. Supported values:
    - TRUE
    - FALSE
    The default value is FALSE.
    See Also:
    
    Constant Field Values
  - TRUE
```
public static final String TRUE
```
    See Also:
    
    Constant Field Values
  - FALSE
```
public static final String FALSE
```
    See Also:
    
    Constant Field Values
  - DISTRIBUTED_JOINS
```
public static final String 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.
    See Also:
    
    Constant Field Values
  - DISTRIBUTED_OPERATIONS
```
public static final String 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.
    See Also:
    
    Constant Field Values
  - IGNORE_EXISTING_PK
```
public static final String 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:
    - TRUE: Ignore inserts/updates that result in primary key collisions with existing records
    - FALSE: Treat as errors any inserts/updates that result in primary key collisions with existing records
    The default value is FALSE.
    See Also:
    
    Constant Field Values
  - LATE_MATERIALIZATION
```
public static final String 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.
    See Also:
    
    Constant Field Values
  - PAGING_TABLE
```
public static final String 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.
    
    See Also:
    
    Constant Field Values
  - PAGING_TABLE_TTL
```
public static final String PAGING_TABLE_TTL
```
    Sets the TTL of the paging table.
    
    See Also:
    
    Constant Field Values
  - PARALLEL_EXECUTION
```
public static final String PARALLEL_EXECUTION
```
    If false, disables the parallel step execution of the given query. Supported values:
    - TRUE
    - FALSE
    The default value is TRUE.
    See Also:
    
    Constant Field Values
  - PLAN_CACHE
```
public static final String PLAN_CACHE
```
    If false, disables plan caching for the given query. Supported values:
    - TRUE
    - FALSE
    The default value is TRUE.
    See Also:
    
    Constant Field Values
  - PREPARE_MODE
```
public static final String 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.
    See Also:
    
    Constant Field Values
  - PRESERVE_DICT_ENCODING
```
public static final String 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.
    See Also:
    
    Constant Field Values
  - QUERY_PARAMETERS
```
public static final String QUERY_PARAMETERS
```
    Query parameters in JSON array or arrays (for inserting multiple rows). This can be used instead of data and requestSchemaStr.
    
    See Also:
    
    Constant Field Values
  - RESULTS_CACHING
```
public static final String RESULTS_CACHING
```
    If false, disables caching of the results of the given query Supported values:
    - TRUE
    - FALSE
    The default value is TRUE.
    See Also:
    
    Constant Field Values
  - RULE_BASED_OPTIMIZATION
```
public static final String RULE_BASED_OPTIMIZATION
```
    If false, disables rule-based rewrite optimizations for the given query Supported values:
    - TRUE
    - FALSE
    The default value is TRUE.
    See Also:
    
    Constant Field Values
  - SSQ_OPTIMIZATION
```
public static final String SSQ_OPTIMIZATION
```
    If false, scalar subqueries will be translated into joins Supported values:
    - TRUE
    - FALSE
    The default value is TRUE.
    See Also:
    
    Constant Field Values
  - TTL
```
public static final String TTL
```
    Sets the TTL of the intermediate result tables used in query execution.
    
    See Also:
    
    Constant Field Values
  - UPDATE_ON_EXISTING_PK
```
public static final String 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:
    - 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
    - FALSE: Reject the insert or update when it results in a primary key collision with an existing record
    The default value is FALSE.
    See Also:
    
    Constant Field Values
  - VALIDATE_CHANGE_COLUMN
```
public static final String 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
    - FALSE
    The default value is TRUE.
    See Also:
    
    Constant Field Values
  - CURRENT_SCHEMA
```
public static final String CURRENT_SCHEMA
```
    Use the supplied value as the default schema when processing this SQL command.
    
    See Also:
    
    Constant Field Values

Class ExecuteSqlRequest.Options

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

COST_BASED_OPTIMIZATION

TRUE

FALSE

DISTRIBUTED_JOINS

DISTRIBUTED_OPERATIONS

IGNORE_EXISTING_PK

LATE_MATERIALIZATION

PAGING_TABLE

PAGING_TABLE_TTL

PARALLEL_EXECUTION

PLAN_CACHE

PREPARE_MODE

PRESERVE_DICT_ENCODING

QUERY_PARAMETERS

RESULTS_CACHING

RULE_BASED_OPTIMIZATION

SSQ_OPTIMIZATION

TTL

UPDATE_ON_EXISTING_PK

VALIDATE_CHANGE_COLUMN

CURRENT_SCHEMA