A set of string constants for the parameter ExecuteSqlRequest.options. More…
Static Public Attributes | |
| const string | COST_BASED_OPTIMIZATION = “cost_based_optimization” |
| If FALSE, disables the cost-based optimization of the given query. | |
| const string | TRUE = “true” |
| A boolean constant for the ExecuteSqlRequest.Options options. | |
| const string | FALSE = “false” |
| A boolean constant for the ExecuteSqlRequest.Options options. | |
| const string | DISTRIBUTED_JOINS = “distributed_joins” |
| If TRUE, enables the use of distributed joins in servicing the given query. | |
| const string | DISTRIBUTED_OPERATIONS = “distributed_operations” |
| If TRUE, enables the use of distributed operations in servicing the given query. | |
| 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). | |
| const string | LATE_MATERIALIZATION = “late_materialization” |
| If TRUE, Joins/Filters results will always be materialized ( saved to result tables format). | |
| const string | PAGING_TABLE = “paging_table” |
| When specified (or PAGING_TABLE_TTL is set), the system will create a paging table to hold the results of the query, when the output has more records than are in the response (i.e., when has_more_records is TRUE). | |
| const string | PAGING_TABLE_TTL = “paging_table_ttl” |
| Sets the TTL of the paging table. | |
| const string | PARALLEL_EXECUTION = “parallel_execution” |
| If FALSE, disables the parallel step execution of the given query. | |
| const string | PLAN_CACHE = “plan_cache” |
| If FALSE, disables plan caching for the given query. | |
| const string | PREPARE_MODE = “prepare_mode” |
| If TRUE, compiles a query into an execution plan and saves it in query cache. | |
| 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. | |
| const string | QUERY_PARAMETERS = “query_parameters” |
| Query parameters in JSON array or arrays (for inserting multiple rows). | |
| const string | RESULTS_CACHING = “results_caching” |
| If FALSE, disables caching of the results of the given query. | |
| const string | RULE_BASED_OPTIMIZATION = “rule_based_optimization” |
| If FALSE, disables rule-based rewrite optimizations for the given query. | |
| const string | SSQ_OPTIMIZATION = “ssq_optimization” |
| If FALSE, scalar subqueries will be translated into joins. | |
| const string | TTL = “ttl” |
| Sets the TTL of the intermediate result tables used in query execution. | |
| 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. | |
| const string | VALIDATE_CHANGE_COLUMN = “validate_change_column” |
| When changing a column using alter table, validate the change before applying it. | |
| const string | CURRENT_SCHEMA = “current_schema” |
| Use the supplied value as the default schema when processing this SQL command. | |
Detailed Description
A set of string constants for the parameter ExecuteSqlRequest.options.
Optional parameters.
Definition at line 63 of file ExecuteSql.cs.
Member Data Documentation
◆ COST_BASED_OPTIMIZATION
| static |
◆ CURRENT_SCHEMA
| static |
Use the supplied value as the default schema when processing this SQL command.
Definition at line 432 of file ExecuteSql.cs.
◆ DISTRIBUTED_JOINS
| static |
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 112 of file ExecuteSql.cs.
◆ DISTRIBUTED_OPERATIONS
| static |
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 134 of file ExecuteSql.cs.
◆ FALSE
| static |
A boolean constant for the ExecuteSqlRequest.Options options.
Definition at line 90 of file ExecuteSql.cs.
◆ IGNORE_EXISTING_PK
| static |
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 175 of file ExecuteSql.cs.
◆ LATE_MATERIALIZATION
| static |
◆ PAGING_TABLE
| static |
When specified (or PAGING_TABLE_TTL is set), the system will create a paging table to hold the results of the query, when the output has more records than are in the response (i.e., when has_more_records is TRUE).
If the specified paging table exists, the records from the paging table are returned without re-evaluating the query. It is the caller’s responsibility to clear the paging_table and other tables in the RESULT_TABLE_LIST (both returned in the response) when they are done with this query.
Definition at line 212 of file ExecuteSql.cs.
◆ PAGING_TABLE_TTL
| static |
Sets the TTL of the paging table.
-1 indicates no timeout. Setting this option will cause a paging table to be generated when needed. The paging_table and other tables in the RESULT_TABLE_LIST (both returned in the response) will be automatically cleared after the TTL expires, if set to a positive number. However, it is still recommended that the caller clear these tables when they are done with this query.
Definition at line 225 of file ExecuteSql.cs.
◆ PARALLEL_EXECUTION
| static |
◆ PLAN_CACHE
| static |
◆ PREPARE_MODE
| static |
◆ PRESERVE_DICT_ENCODING
| static |
◆ QUERY_PARAMETERS
| static |
Query parameters in JSON array or arrays (for inserting multiple rows).
This can be used instead of ExecuteSqlRequest.data and ExecuteSqlRequest.request_schema_str.
Definition at line 307 of file ExecuteSql.cs.
◆ RESULTS_CACHING
| static |
◆ RULE_BASED_OPTIMIZATION
| static |
◆ SSQ_OPTIMIZATION
| static |
◆ TRUE
| static |
A boolean constant for the ExecuteSqlRequest.Options options.
Definition at line 86 of file ExecuteSql.cs.
◆ TTL
| static |
Sets the TTL of the intermediate result tables used in query execution.
Definition at line 366 of file ExecuteSql.cs.
◆ UPDATE_ON_EXISTING_PK
| static |
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 403 of file ExecuteSql.cs.
◆ VALIDATE_CHANGE_COLUMN
| static |
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 426 of file ExecuteSql.cs.
The documentation for this struct was generated from the following file:
- Kinetica/Protocol/ExecuteSql.cs