Kinetica C# API  Version 7.1.10.0
 All Classes Namespaces Files Functions Variables Enumerations Enumerator Properties Pages
kinetica.ExecuteSqlRequest Class Reference

A set of parameters for Kinetica.executeSql(string,long,long,string,IList{byte[]},IDictionary{string, string}). More...

+ Inheritance diagram for kinetica.ExecuteSqlRequest:
+ Collaboration diagram for kinetica.ExecuteSqlRequest:

Classes

struct  Encoding
 Specifies the encoding for returned records; either 'binary' or 'json'. More...
 
struct  Options
 Optional parameters. More...
 

Public Member Functions

 ExecuteSqlRequest ()
 Constructs an ExecuteSqlRequest object with default parameters. More...
 
 ExecuteSqlRequest (string statement, long?offset=null, long?limit=null, string request_schema_str=null, IList< byte[]> data=null, IDictionary< string, string > options=null)
 Constructs an ExecuteSqlRequest object with the specified parameters. More...
 
 ExecuteSqlRequest (string statement, long?offset=null, long?limit=null, string encoding=null, string request_schema_str=null, IList< byte[]> data=null, IDictionary< string, string > options=null)
 Constructs an ExecuteSqlRequest object with the specified parameters. More...
 
- Public Member Functions inherited from kinetica.KineticaData
 KineticaData (KineticaType type)
 Constructor from Kinetica Type More...
 
 KineticaData (System.Type type=null)
 Default constructor, with optional System.Type More...
 
object Get (int fieldPos)
 Retrieve a specific property from this object More...
 
void Put (int fieldPos, object fieldValue)
 Write a specific property to this object More...
 

Properties

string statement [get, set]
 SQL statement (query, DML, or DDL) to be executed More...
 
long offset [get, set]
 A positive integer indicating the number of initial results to skip (this can be useful for paging through the results). More...
 
long limit = 0 [get, set]
 A positive integer indicating the maximum number of results to be returned, or END_OF_SET (-9999) to indicate that the maximum number of results allowed by the server should be returned. More...
 
string encoding = -9999 [get, set]
 Specifies the encoding for returned records; either 'binary' or 'json'. More...
 
string request_schema_str = Encoding.BINARY [get, set]
 Avro schema of . More...
 
IList< byte[]> data = "" [get, set]
 An array of binary-encoded data for the records to be binded to the SQL query. More...
 
IDictionary< string, string > options = new List<byte[]>() [get, set]
 Optional parameters. More...
 
- Properties inherited from kinetica.KineticaData
Schema Schema [get]
 Avro Schema for this class More...
 

Additional Inherited Members

- Static Public Member Functions inherited from kinetica.KineticaData
static RecordSchema SchemaFromType (System.Type t, KineticaType ktype=null)
 Create an Avro Schema from a System.Type and a KineticaType. More...
 

Detailed Description

A set of parameters for Kinetica.executeSql(string,long,long,string,IList{byte[]},IDictionary{string, string}).


Execute a SQL statement (query, DML, or DDL).
See SQL Support for the complete set of supported SQL commands.

Definition at line 22 of file ExecuteSql.cs.

Constructor & Destructor Documentation

kinetica.ExecuteSqlRequest.ExecuteSqlRequest ( )
inline

Constructs an ExecuteSqlRequest object with default parameters.

Definition at line 1138 of file ExecuteSql.cs.

kinetica.ExecuteSqlRequest.ExecuteSqlRequest ( string  statement,
long?  offset = null,
long?  limit = null,
string  request_schema_str = null,
IList< byte[]>  data = null,
IDictionary< string, string >  options = null 
)
inline

Constructs an ExecuteSqlRequest object with the specified parameters.

Parameters
statementSQL statement (query, DML, or DDL) to be executed
offsetA positive integer indicating the number of initial results to skip (this can be useful for paging through the results). The default value is 0.The minimum allowed value is 0. The maximum allowed value is MAX_INT.
limitA positive integer indicating the maximum number of results to be returned, or END_OF_SET (-9999) to indicate that the maximum number of results allowed by the server should be returned. The number of records returned will never exceed the server's own limit, defined by the max_get_records_size parameter in the server configuration. Use <member name="has_more_records"> to see if more records exist in the result to be fetched, and & to request subsequent pages of results. The default value is -9999.
request_schema_strAvro schema of . The default value is ''.
dataAn array of binary-encoded data for the records to be binded to the SQL query. Or use query_parameters to pass the data in JSON format. The default value is an empty List.
optionsOptional 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.

Definition at line 1525 of file ExecuteSql.cs.

kinetica.ExecuteSqlRequest.ExecuteSqlRequest ( string  statement,
long?  offset = null,
long?  limit = null,
string  encoding = null,
string  request_schema_str = null,
IList< byte[]>  data = null,
IDictionary< string, string >  options = null 
)
inline

Constructs an ExecuteSqlRequest object with the specified parameters.

Parameters
statementSQL statement (query, DML, or DDL) to be executed
offsetA positive integer indicating the number of initial results to skip (this can be useful for paging through the results). The default value is 0.The minimum allowed value is 0. The maximum allowed value is MAX_INT.
limitA positive integer indicating the maximum number of results to be returned, or END_OF_SET (-9999) to indicate that the maximum number of results allowed by the server should be returned. The number of records returned will never exceed the server's own limit, defined by the max_get_records_size parameter in the server configuration. Use <member name="has_more_records"> to see if more records exist in the result to be fetched, and & to request subsequent pages of results. The default value is -9999.
encodingSpecifies the encoding for returned records; either 'binary' or 'json'. Supported values: The default value is BINARY.
request_schema_strAvro schema of . The default value is ''.
dataAn array of binary-encoded data for the records to be binded to the SQL query. Or use query_parameters to pass the data in JSON format. The default value is an empty List.
optionsOptional 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.

Definition at line 1942 of file ExecuteSql.cs.

Property Documentation

IList<byte[]> kinetica.ExecuteSqlRequest.data = ""
getset

An array of binary-encoded data for the records to be binded to the SQL query.

Or use query_parameters to pass the data in JSON format. The default value is an empty List.

Definition at line 776 of file ExecuteSql.cs.

string kinetica.ExecuteSqlRequest.encoding = -9999
getset

Specifies the encoding for returned records; either 'binary' or 'json'.

Supported values:

The default value is BINARY.

Definition at line 766 of file ExecuteSql.cs.

long kinetica.ExecuteSqlRequest.limit = 0
getset

A positive integer indicating the maximum number of results to be returned, or END_OF_SET (-9999) to indicate that the maximum number of results allowed by the server should be returned.

The number of records returned will never exceed the server's own limit, defined by the max_get_records_size parameter in the server configuration. Use <member name="has_more_records"> to see if more records exist in the result to be fetched, and & to request subsequent pages of results. The default value is -9999.

Definition at line 749 of file ExecuteSql.cs.

long kinetica.ExecuteSqlRequest.offset
getset

A positive integer indicating the number of initial results to skip (this can be useful for paging through the results).

The default value is 0.The minimum allowed value is 0. The maximum allowed value is MAX_INT.

Definition at line 733 of file ExecuteSql.cs.

IDictionary<string, string> kinetica.ExecuteSqlRequest.options = new List<byte[]>()
getset

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.

Definition at line 1133 of file ExecuteSql.cs.

string kinetica.ExecuteSqlRequest.request_schema_str = Encoding.BINARY
getset

Avro schema of .

The default value is ''.

Definition at line 770 of file ExecuteSql.cs.

string kinetica.ExecuteSqlRequest.statement
getset

SQL statement (query, DML, or DDL) to be executed

Definition at line 727 of file ExecuteSql.cs.


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