Kinetica C# API  Version 7.1.10.0
 All Classes Namespaces Files Functions Variables Enumerations Enumerator Properties Pages
Public Attributes | List of all members
kinetica.ExecuteSqlRequest.Options Struct Reference

Optional parameters. 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) Supported values:

The default value is FALSE. 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 Supported values:

The default value is TRUE. More...

 
const string RULE_BASED_OPTIMIZATION = "rule_based_optimization"
 If false, disables rule-based rewrite optimizations for the given query Supported values:

The default value is TRUE. More...

 
const string SSQ_OPTIMIZATION = "ssq_optimization"
 If false, scalar subqueries will be translated into joins Supported values:

The default value is TRUE. 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

Optional parameters.

  • COST_BASED_OPTIMIZATION: If false, disables the cost-based optimization of the given query. Supported values: 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: 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: 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: 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: The default value is TRUE.
  • PLAN_CACHE: If false, disables plan caching for the given query. Supported values: 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: 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: The default value is TRUE.
  • QUERY_PARAMETERS: Query parameters in JSON array or arrays (for inserting multiple rows). This can be used instead of and .
  • RESULTS_CACHING: If false, disables caching of the results of the given query Supported values: The default value is TRUE.
  • RULE_BASED_OPTIMIZATION: If false, disables rule-based rewrite optimizations for the given query Supported values: The default value is TRUE.
  • SSQ_OPTIMIZATION: If false, scalar subqueries will be translated into joins Supported values: 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: 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 Dictionary. A set of string constants for the parameter options.

Definition at line 406 of file ExecuteSql.cs.

Member Data Documentation

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 424 of file ExecuteSql.cs.

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 721 of file ExecuteSql.cs.

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

The default value is FALSE.

Definition at line 446 of file ExecuteSql.cs.

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

The default value is FALSE.

Definition at line 466 of file ExecuteSql.cs.

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

Definition at line 426 of file ExecuteSql.cs.

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).

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.

Definition at line 503 of file ExecuteSql.cs.

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 520 of file ExecuteSql.cs.

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 527 of file ExecuteSql.cs.

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

Sets the TTL of the paging table.

Definition at line 531 of file ExecuteSql.cs.

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 548 of file ExecuteSql.cs.

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 565 of file ExecuteSql.cs.

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

The default value is FALSE.

Definition at line 583 of file ExecuteSql.cs.

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 600 of file ExecuteSql.cs.

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 605 of file ExecuteSql.cs.

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 622 of file ExecuteSql.cs.

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 639 of file ExecuteSql.cs.

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 656 of file ExecuteSql.cs.

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

Definition at line 425 of file ExecuteSql.cs.

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

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

Definition at line 661 of file ExecuteSql.cs.

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.

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.

Definition at line 695 of file ExecuteSql.cs.

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

The default value is TRUE.

Definition at line 715 of file ExecuteSql.cs.

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