ExecuteSqlRequest.Options (Kinetica Java API 7.0.19.0 API)

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

Enclosing class:

ExecuteSqlRequest
```
public static final class ExecuteSqlRequest.Options
extends Object
```
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. 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`	`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`	`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`	`NO_COUNT` 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 TTL of the paging table.
`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`	`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 TTL of the intermediate result tables used in query execution.
`static String`	`UPDATE_ON_EXISTING_PK` Can be used to customize behavior when the updated primary key value already exists as described in `GPUdb.insertRecordsRaw(RawInsertRecordsRequest)`.
`static String`	`VALIDATE_CHANGE_COLUMN` When changing a column using alter table, validate the change before applying it.
`static String`	`VIEW_ID` The default value is ''.

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

- Field Detail
  - 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
  - TRUE
```
public static final String TRUE
```
    See Also:
    
    Constant Field Values
  - FALSE
```
public static final String FALSE
```
    See Also:
    
    Constant Field Values
  - 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
  - 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
  - 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
  - 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
  - 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
  - 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
  - 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
  - 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
  - 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
```
    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.
    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
  - 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: true
    - FALSE: 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
  - VIEW_ID
```
public static final String VIEW_ID
```
    The default value is ''.
    
    See Also:
    
    Constant Field Values
  - NO_COUNT
```
public static final String NO_COUNT
```
    The default value is 'false'.
    
    See Also:
    
    Constant Field Values

Class ExecuteSqlRequest.Options

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

PARALLEL_EXECUTION

TRUE

FALSE

COST_BASED_OPTIMIZATION

PLAN_CACHE

RULE_BASED_OPTIMIZATION

RESULTS_CACHING

PAGING_TABLE

PAGING_TABLE_TTL

DISTRIBUTED_JOINS

DISTRIBUTED_OPERATIONS

SSQ_OPTIMIZATION

LATE_MATERIALIZATION

TTL

UPDATE_ON_EXISTING_PK

PRESERVE_DICT_ENCODING

VALIDATE_CHANGE_COLUMN

PREPARE_MODE

VIEW_ID

NO_COUNT