A set of parameters for Kinetica.executeSql. More...

Inheritance diagram for kinetica.ExecuteSqlRequest:

Collaboration diagram for kinetica.ExecuteSqlRequest:

Classes
struct	Encoding
	A set of string constants for the parameter encoding. More...

struct	Options
	A set of string constants for the parameter options. 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...

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

	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 = 0 `[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 = -9999 `[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 = Encoding.BINARY `[get, set]`
	Specifies the encoding for returned records; either 'binary' or 'json'. More...

string	request_schema_str = "" `[get, set]`
	Avro schema of data. More...

IList< byte[]>	data = new List<byte[]>() `[get, set]`
	An array of binary-encoded data for the records to be binded to the SQL query. More...

IDictionary< string, string >	options = new Dictionary<string, string>() `[get, set]`
	Optional parameters. More...

Properties inherited from kinetica.KineticaData
Schema	Schema `[get]`
	Avro Schema for this class More...

Properties inherited from Avro.Specific.ISpecificRecord
Schema	Schema `[get]`

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

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.

Execute a SQL statement (query, DML, or DDL).

See SQL Support for the complete set of supported SQL commands.

Execute a SQL statement (query, DML, or DDL).

See SQL Support for the complete set of supported SQL commands.

When a caller wants all the results from a large query (e.g., more than max_get_records_size records), they can make multiple calls to this endpoint using the offset and limit parameters to page through the results. Normally, this will execute the statement query each time. To avoid re-executing the query each time and to keep the results in the same order, the caller should specify a PAGING_TABLE name to hold the results of the query between calls and specify the PAGING_TABLE on subsequent calls. When this is done, the caller should clear the paging table and any other tables in the RESULT_TABLE_LIST (both returned in the response) when they are done paging through the results. paging_table (and RESULT_TABLE_LIST) will be empty if no paging table was created (e.g., when all the query results were returned in the first call).

Definition at line 17 of file ExecuteSql.cs.

Constructor & Destructor Documentation

◆ ExecuteSqlRequest() [1/6]

kinetica.ExecuteSqlRequest.ExecuteSqlRequest ( )

inline

Constructs an ExecuteSqlRequest object with default parameters.

Definition at line 710 of file ExecuteSql.cs.

◆ ExecuteSqlRequest() [2/6]

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

statement	SQL statement (query, DML, or DDL) to be executed
offset	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.
limit	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 has_more_records to see if more records exist in the result to be fetched, and offset & limit to request subsequent pages of results. The default value is -9999.
request_schema_str	Avro schema of data . The default value is ''.
data	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.
options	Optional parameters. COST_BASED_OPTIMIZATION: If FALSE, disables the cost-based optimization of the given query. Supported values: TRUE FALSE 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: TRUE FALSE 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: TRUE FALSE 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: TRUE FALSE 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: TRUE FALSE The default value is TRUE. PLAN_CACHE: If FALSE, disables plan caching for the given query. Supported values: TRUE FALSE 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: TRUE FALSE 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: TRUE FALSE The default value is TRUE. QUERY_PARAMETERS: Query parameters in JSON array or arrays (for inserting multiple rows). This can be used instead of data and request_schema_str . RESULTS_CACHING: If FALSE, disables caching of the results of the given query. Supported values: TRUE FALSE The default value is TRUE. RULE_BASED_OPTIMIZATION: If FALSE, disables rule-based rewrite optimizations for the given query. Supported values: TRUE FALSE The default value is TRUE. SSQ_OPTIMIZATION: If FALSE, scalar subqueries will be translated into joins. Supported values: TRUE FALSE 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: TRUE FALSE 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 1090 of file ExecuteSql.cs.

◆ ExecuteSqlRequest() [3/6]

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

statement	SQL statement (query, DML, or DDL) to be executed
offset	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.
limit	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 has_more_records to see if more records exist in the result to be fetched, and offset & limit to request subsequent pages of results. The default value is -9999.
encoding	Specifies the encoding for returned records; either 'binary' or 'json'. Supported values: BINARY JSON The default value is BINARY.
request_schema_str	Avro schema of data . The default value is ''.
data	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.
options	Optional parameters. COST_BASED_OPTIMIZATION: If FALSE, disables the cost-based optimization of the given query. Supported values: TRUE FALSE 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: TRUE FALSE 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: TRUE FALSE 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: TRUE FALSE 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: TRUE FALSE The default value is TRUE. PLAN_CACHE: If FALSE, disables plan caching for the given query. Supported values: TRUE FALSE 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: TRUE FALSE 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: TRUE FALSE The default value is TRUE. QUERY_PARAMETERS: Query parameters in JSON array or arrays (for inserting multiple rows). This can be used instead of data and request_schema_str . RESULTS_CACHING: If FALSE, disables caching of the results of the given query. Supported values: TRUE FALSE The default value is TRUE. RULE_BASED_OPTIMIZATION: If FALSE, disables rule-based rewrite optimizations for the given query. Supported values: TRUE FALSE The default value is TRUE. SSQ_OPTIMIZATION: If FALSE, scalar subqueries will be translated into joins. Supported values: TRUE FALSE 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: TRUE FALSE 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 1497 of file ExecuteSql.cs.

◆ ExecuteSqlRequest() [4/6]

kinetica.ExecuteSqlRequest.ExecuteSqlRequest ( )

inline

Constructs an ExecuteSqlRequest object with default parameters.

Definition at line 771 of file ExecuteSql.cs.

◆ ExecuteSqlRequest() [5/6]

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

statement	SQL statement (query, DML, or DDL) to be executed
offset	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.
limit	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 has_more_records to see if more records exist in the result to be fetched, and offset & limit to request subsequent pages of results. The default value is -9999.
request_schema_str	Avro schema of data . The default value is ''.
data	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.
options	Optional parameters. COST_BASED_OPTIMIZATION: If FALSE, disables the cost-based optimization of the given query. Supported values: TRUE FALSE 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: TRUE FALSE 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: TRUE FALSE 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: TRUE FALSE The default value is FALSE. 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). 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. PAGING_TABLE_TTL: 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. PARALLEL_EXECUTION: If FALSE, disables the parallel step execution of the given query. Supported values: TRUE FALSE The default value is TRUE. PLAN_CACHE: If FALSE, disables plan caching for the given query. Supported values: TRUE FALSE 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: TRUE FALSE 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: TRUE FALSE The default value is TRUE. QUERY_PARAMETERS: Query parameters in JSON array or arrays (for inserting multiple rows). This can be used instead of data and request_schema_str . RESULTS_CACHING: If FALSE, disables caching of the results of the given query. Supported values: TRUE FALSE The default value is TRUE. RULE_BASED_OPTIMIZATION: If FALSE, disables rule-based rewrite optimizations for the given query. Supported values: TRUE FALSE The default value is TRUE. SSQ_OPTIMIZATION: If FALSE, scalar subqueries will be translated into joins. Supported values: TRUE FALSE 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: TRUE FALSE 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 1171 of file ExecuteSql.cs.

◆ ExecuteSqlRequest() [6/6]

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

statement	SQL statement (query, DML, or DDL) to be executed
offset	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.
limit	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 has_more_records to see if more records exist in the result to be fetched, and offset & limit to request subsequent pages of results. The default value is -9999.
encoding	Specifies the encoding for returned records; either 'binary' or 'json'. Supported values: BINARY JSON The default value is BINARY.
request_schema_str	Avro schema of data . The default value is ''.
data	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.
options	Optional parameters. COST_BASED_OPTIMIZATION: If FALSE, disables the cost-based optimization of the given query. Supported values: TRUE FALSE 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: TRUE FALSE 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: TRUE FALSE 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: TRUE FALSE The default value is FALSE. 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). 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. PAGING_TABLE_TTL: 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. PARALLEL_EXECUTION: If FALSE, disables the parallel step execution of the given query. Supported values: TRUE FALSE The default value is TRUE. PLAN_CACHE: If FALSE, disables plan caching for the given query. Supported values: TRUE FALSE 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: TRUE FALSE 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: TRUE FALSE The default value is TRUE. QUERY_PARAMETERS: Query parameters in JSON array or arrays (for inserting multiple rows). This can be used instead of data and request_schema_str . RESULTS_CACHING: If FALSE, disables caching of the results of the given query. Supported values: TRUE FALSE The default value is TRUE. RULE_BASED_OPTIMIZATION: If FALSE, disables rule-based rewrite optimizations for the given query. Supported values: TRUE FALSE The default value is TRUE. SSQ_OPTIMIZATION: If FALSE, scalar subqueries will be translated into joins. Supported values: TRUE FALSE 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: TRUE FALSE 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 1598 of file ExecuteSql.cs.

Property Documentation

◆ data

IList< byte[]> kinetica.ExecuteSqlRequest.data = new List<byte[]>()

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

◆ encoding

string kinetica.ExecuteSqlRequest.encoding = Encoding.BINARY

getset

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

Supported values:

BINARY
JSON

The default value is BINARY.

Definition at line 341 of file ExecuteSql.cs.

◆ limit

long kinetica.ExecuteSqlRequest.limit = -9999

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 has_more_records to see if more records exist in the result to be fetched, and offset & limit to request subsequent pages of results. The default value is -9999.

Definition at line 326 of file ExecuteSql.cs.

◆ offset

long kinetica.ExecuteSqlRequest.offset = 0

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

◆ options

IDictionary< string, string > kinetica.ExecuteSqlRequest.options = new Dictionary<string, string>()

getset

Optional parameters.

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

COST_BASED_OPTIMIZATION: If FALSE, disables the cost-based optimization of the given query. Supported values:
- TRUE
- FALSE
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:
- TRUE
- FALSE
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:
- TRUE
- FALSE
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:
- TRUE
- FALSE
The default value is FALSE.
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). 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.
PAGING_TABLE_TTL: 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.
PARALLEL_EXECUTION: If FALSE, disables the parallel step execution of the given query. Supported values:
- TRUE
- FALSE
The default value is TRUE.
PLAN_CACHE: If FALSE, disables plan caching for the given query. Supported values:
- TRUE
- FALSE
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:
- TRUE
- FALSE
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:
- TRUE
- FALSE
The default value is TRUE.
QUERY_PARAMETERS: Query parameters in JSON array or arrays (for inserting multiple rows). This can be used instead of data and request_schema_str.
RESULTS_CACHING: If FALSE, disables caching of the results of the given query. Supported values:
- TRUE
- FALSE
The default value is TRUE.
RULE_BASED_OPTIMIZATION: If FALSE, disables rule-based rewrite optimizations for the given query. Supported values:
- TRUE
- FALSE
The default value is TRUE.
SSQ_OPTIMIZATION: If FALSE, scalar subqueries will be translated into joins. Supported values:
- TRUE
- FALSE
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:
- TRUE
- FALSE
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 706 of file ExecuteSql.cs.

◆ request_schema_str

string kinetica.ExecuteSqlRequest.request_schema_str = ""

getset

Avro schema of data.

The default value is ''.

Definition at line 345 of file ExecuteSql.cs.

◆ statement

string kinetica.ExecuteSqlRequest.statement

getset

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

Definition at line 304 of file ExecuteSql.cs.

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

_build/public-os_ubuntu24.04-arch_amd64-cc_gcc_13.3.0/install/Kinetica/Protocol/ExecuteSql.cs

Classes

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ExecuteSqlRequest() [1/6]

◆ ExecuteSqlRequest() [2/6]

◆ ExecuteSqlRequest() [3/6]

◆ ExecuteSqlRequest() [4/6]

◆ ExecuteSqlRequest() [5/6]

◆ ExecuteSqlRequest() [6/6]

Property Documentation

◆ data

◆ encoding

◆ limit

◆ offset

◆ options

◆ request_schema_str

◆ statement