Kinetica C# API  Version 7.0.19.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 PARALLEL_EXECUTION = "parallel_execution"
 If false, disables the parallel step execution of the given query. More...
 
const string TRUE = "true"
 
const string FALSE = "false"
 
const string COST_BASED_OPTIMIZATION = "cost_based_optimization"
 If false, disables the cost-based optimization of the given query. More...
 
const string PLAN_CACHE = "plan_cache"
 If false, disables plan caching for the given query. 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 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 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 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 SSQ_OPTIMIZATION = "ssq_optimization"
 If false, scalar subqueries will be translated into joins Supported values:

The default value is TRUE. 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 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"
 Can be used to customize behavior when the updated primary key value already exists as described in Kinetica.insertRecords{T}(string,IList{T},IDictionary{string, string}). 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 VALIDATE_CHANGE_COLUMN = "validate_change_column"
 When changing a column using alter table, validate the change before applying it. 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 VIEW_ID = "view_id"
 <DEVELOPER> The default value is ''. More...
 
const string NO_COUNT = "no_count"
 <DEVELOPER> The default value is 'false'. More...
 

Detailed Description

Optional parameters.

  • PARALLEL_EXECUTION: If false, disables the parallel step execution of the given query. Supported values: The default value is TRUE.
  • COST_BASED_OPTIMIZATION: If false, disables the cost-based optimization of the given query. Supported values: The default value is FALSE.
  • PLAN_CACHE: If false, disables plan caching for 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.
  • RESULTS_CACHING: If false, disables caching of the results of the given query Supported values: 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: 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.
  • SSQ_OPTIMIZATION: If false, scalar subqueries will be translated into joins Supported values: The default value is TRUE.
  • LATE_MATERIALIZATION: If true, Joins/Filters results will always be materialized ( saved to result tables format) Supported values: 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 /insert/records. 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.
  • 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.
  • 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.
  • VIEW_ID: <DEVELOPER> The default value is ''.
  • NO_COUNT: <DEVELOPER> The default value is 'false'.

The default value is an empty Dictionary. A set of string constants for the parameter options.

Definition at line 347 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 384 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 466 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 486 of file ExecuteSql.cs.

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

Definition at line 367 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.NO_COUNT = "no_count"

<DEVELOPER> The default value is 'false'.

Definition at line 607 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 442 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 446 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 365 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 401 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 601 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 561 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 435 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 418 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 503 of file ExecuteSql.cs.

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

Definition at line 366 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 525 of file ExecuteSql.cs.

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

Can be used to customize behavior when the updated primary key value already exists as described in Kinetica.insertRecords{T}(string,IList{T},IDictionary{string, string}).

Supported values:

The default value is FALSE.

Definition at line 544 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 583 of file ExecuteSql.cs.

const string kinetica.ExecuteSqlRequest.Options.VIEW_ID = "view_id"

<DEVELOPER> The default value is ''.

Definition at line 604 of file ExecuteSql.cs.

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