Kinetica   C#   API  Version 7.2.3.0
Public Attributes | List of all members
kinetica.ExecuteSqlRequest.Options Struct Reference

A set of string constants for the parameter options. More...

Public Attributes

const string COST_BASED_OPTIMIZATION = "cost_based_optimization"
 If FALSE, disables the cost-based optimization of the given query. More...
 
const string TRUE = "true"
 
const string FALSE = "false"
 
const string DISTRIBUTED_JOINS = "distributed_joins"
 If TRUE, enables the use of distributed joins in servicing the given query. More...
 
const string DISTRIBUTED_OPERATIONS = "distributed_operations"
 If TRUE, enables the use of distributed operations in servicing the given query. More...
 
const string IGNORE_EXISTING_PK = "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). More...
 
const string LATE_MATERIALIZATION = "late_materialization"
 If TRUE, Joins/Filters results will always be materialized ( saved to result tables format). More...
 
const string PAGING_TABLE = "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. More...
 
const string PAGING_TABLE_TTL = "paging_table_ttl"
 Sets the TTL of the paging table. More...
 
const string PARALLEL_EXECUTION = "parallel_execution"
 If FALSE, disables the parallel step execution of the given query. More...
 
const string PLAN_CACHE = "plan_cache"
 If FALSE, disables plan caching for the given query. More...
 
const string PREPARE_MODE = "prepare_mode"
 If TRUE, compiles a query into an execution plan and saves it in query cache. More...
 
const string PRESERVE_DICT_ENCODING = "preserve_dict_encoding"
 If TRUE, then columns that were dict encoded in the source table will be dict encoded in the projection table. More...
 
const string QUERY_PARAMETERS = "query_parameters"
 Query parameters in JSON array or arrays (for inserting multiple rows). More...
 
const string RESULTS_CACHING = "results_caching"
 If FALSE, disables caching of the results of the given query. More...
 
const string RULE_BASED_OPTIMIZATION = "rule_based_optimization"
 If FALSE, disables rule-based rewrite optimizations for the given query. More...
 
const string SSQ_OPTIMIZATION = "ssq_optimization"
 If FALSE, scalar subqueries will be translated into joins. More...
 
const string TTL = "ttl"
 Sets the TTL of the intermediate result tables used in query execution. More...
 
const string UPDATE_ON_EXISTING_PK = "update_on_existing_pk"
 Specifies the record collision policy for inserting into or updating a table with a primary key. More...
 
const string VALIDATE_CHANGE_COLUMN = "validate_change_column"
 When changing a column using alter table, validate the change before applying it. More...
 
const string CURRENT_SCHEMA = "current_schema"
 Use the supplied value as the default schema when processing this SQL command. More...
 

Detailed Description

A set of string constants for the parameter options.

Optional parameters.

Definition at line 32 of file ExecuteSql.cs.

Member Data Documentation

◆ COST_BASED_OPTIMIZATION

const string kinetica.ExecuteSqlRequest.Options.COST_BASED_OPTIMIZATION = "cost_based_optimization"

If FALSE, disables the cost-based optimization of the given query.

Supported values:

The default value is FALSE.

Definition at line 47 of file ExecuteSql.cs.

◆ CURRENT_SCHEMA

const string kinetica.ExecuteSqlRequest.Options.CURRENT_SCHEMA = "current_schema"

Use the supplied value as the default schema when processing this SQL command.

Definition at line 299 of file ExecuteSql.cs.

◆ DISTRIBUTED_JOINS

const string kinetica.ExecuteSqlRequest.Options.DISTRIBUTED_JOINS = "distributed_joins"

If TRUE, enables the use of distributed joins in servicing the given query.

Supported values:

The default value is FALSE.

Definition at line 66 of file ExecuteSql.cs.

◆ DISTRIBUTED_OPERATIONS

const string kinetica.ExecuteSqlRequest.Options.DISTRIBUTED_OPERATIONS = "distributed_operations"

If TRUE, enables the use of distributed operations in servicing the given query.

Supported values:

The default value is FALSE.

Definition at line 82 of file ExecuteSql.cs.

◆ FALSE

const string kinetica.ExecuteSqlRequest.Options.FALSE = "false"

Definition at line 50 of file ExecuteSql.cs.

◆ IGNORE_EXISTING_PK

const string kinetica.ExecuteSqlRequest.Options.IGNORE_EXISTING_PK = "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).

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.

Definition at line 108 of file ExecuteSql.cs.

◆ LATE_MATERIALIZATION

const string kinetica.ExecuteSqlRequest.Options.LATE_MATERIALIZATION = "late_materialization"

If TRUE, Joins/Filters results will always be materialized ( saved to result tables format).

Supported values:

The default value is FALSE.

Definition at line 124 of file ExecuteSql.cs.

◆ PAGING_TABLE

const string kinetica.ExecuteSqlRequest.Options.PAGING_TABLE = "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.

Definition at line 132 of file ExecuteSql.cs.

◆ PAGING_TABLE_TTL

const string kinetica.ExecuteSqlRequest.Options.PAGING_TABLE_TTL = "paging_table_ttl"

Sets the TTL of the paging table.

Definition at line 136 of file ExecuteSql.cs.

◆ PARALLEL_EXECUTION

const string kinetica.ExecuteSqlRequest.Options.PARALLEL_EXECUTION = "parallel_execution"

If FALSE, disables the parallel step execution of the given query.

Supported values:

The default value is TRUE.

Definition at line 151 of file ExecuteSql.cs.

◆ PLAN_CACHE

const string kinetica.ExecuteSqlRequest.Options.PLAN_CACHE = "plan_cache"

If FALSE, disables plan caching for the given query.

Supported values:

The default value is TRUE.

Definition at line 166 of file ExecuteSql.cs.

◆ PREPARE_MODE

const string kinetica.ExecuteSqlRequest.Options.PREPARE_MODE = "prepare_mode"

If TRUE, compiles a query into an execution plan and saves it in query cache.

Supported values:

The default value is FALSE.

Definition at line 182 of file ExecuteSql.cs.

◆ PRESERVE_DICT_ENCODING

const string kinetica.ExecuteSqlRequest.Options.PRESERVE_DICT_ENCODING = "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:

The default value is TRUE.

Definition at line 198 of file ExecuteSql.cs.

◆ QUERY_PARAMETERS

const string kinetica.ExecuteSqlRequest.Options.QUERY_PARAMETERS = "query_parameters"

Query parameters in JSON array or arrays (for inserting multiple rows).

This can be used instead of data and request_schema_str.

Definition at line 204 of file ExecuteSql.cs.

◆ RESULTS_CACHING

const string kinetica.ExecuteSqlRequest.Options.RESULTS_CACHING = "results_caching"

If FALSE, disables caching of the results of the given query.

Supported values:

The default value is TRUE.

Definition at line 219 of file ExecuteSql.cs.

◆ RULE_BASED_OPTIMIZATION

const string kinetica.ExecuteSqlRequest.Options.RULE_BASED_OPTIMIZATION = "rule_based_optimization"

If FALSE, disables rule-based rewrite optimizations for the given query.

Supported values:

The default value is TRUE.

Definition at line 234 of file ExecuteSql.cs.

◆ SSQ_OPTIMIZATION

const string kinetica.ExecuteSqlRequest.Options.SSQ_OPTIMIZATION = "ssq_optimization"

If FALSE, scalar subqueries will be translated into joins.

Supported values:

The default value is TRUE.

Definition at line 249 of file ExecuteSql.cs.

◆ TRUE

const string kinetica.ExecuteSqlRequest.Options.TRUE = "true"

Definition at line 49 of file ExecuteSql.cs.

◆ TTL

const string kinetica.ExecuteSqlRequest.Options.TTL = "ttl"

Sets the TTL of the intermediate result tables used in query execution.

Definition at line 254 of file ExecuteSql.cs.

◆ UPDATE_ON_EXISTING_PK

const string kinetica.ExecuteSqlRequest.Options.UPDATE_ON_EXISTING_PK = "update_on_existing_pk"

Specifies the record collision policy for inserting into or updating a table with a primary key.

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.

Definition at line 278 of file ExecuteSql.cs.

◆ VALIDATE_CHANGE_COLUMN

const string kinetica.ExecuteSqlRequest.Options.VALIDATE_CHANGE_COLUMN = "validate_change_column"

When changing a column using alter table, validate the change before applying it.

Supported values:

The default value is TRUE.

Definition at line 293 of file ExecuteSql.cs.

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