Kinetica   C#   API  Version 7.2.3.0
ExecuteSql.cs
Go to the documentation of this file.
1 /*
2  * This file was autogenerated by the Kinetica schema processor.
3  *
4  * DO NOT EDIT DIRECTLY.
5  */
6 
7 using System.Collections.Generic;
8 
9 namespace kinetica
10 {
18  {
23  public struct Encoding
24  {
25  public const string BINARY = "binary";
26  public const string JSON = "json";
27  } // end struct Encoding
28 
32  public struct Options
33  {
47  public const string COST_BASED_OPTIMIZATION = "cost_based_optimization";
48 
49  public const string TRUE = "true";
50  public const string FALSE = "false";
51 
66  public const string DISTRIBUTED_JOINS = "distributed_joins";
67 
82  public const string DISTRIBUTED_OPERATIONS = "distributed_operations";
83 
108  public const string IGNORE_EXISTING_PK = "ignore_existing_pk";
109 
124  public const string LATE_MATERIALIZATION = "late_materialization";
125 
132  public const string PAGING_TABLE = "paging_table";
133 
136  public const string PAGING_TABLE_TTL = "paging_table_ttl";
137 
151  public const string PARALLEL_EXECUTION = "parallel_execution";
152 
166  public const string PLAN_CACHE = "plan_cache";
167 
182  public const string PREPARE_MODE = "prepare_mode";
183 
198  public const string PRESERVE_DICT_ENCODING = "preserve_dict_encoding";
199 
204  public const string QUERY_PARAMETERS = "query_parameters";
205 
219  public const string RESULTS_CACHING = "results_caching";
220 
234  public const string RULE_BASED_OPTIMIZATION = "rule_based_optimization";
235 
249  public const string SSQ_OPTIMIZATION = "ssq_optimization";
250 
254  public const string TTL = "ttl";
255 
278  public const string UPDATE_ON_EXISTING_PK = "update_on_existing_pk";
279 
293  public const string VALIDATE_CHANGE_COLUMN = "validate_change_column";
294 
299  public const string CURRENT_SCHEMA = "current_schema";
300  } // end struct Options
301 
304  public string statement { get; set; }
305 
311  public long offset { get; set; } = 0;
312 
326  public long limit { get; set; } = -9999;
327 
341  public string encoding { get; set; } = Encoding.BINARY;
342 
345  public string request_schema_str { get; set; } = "";
346 
353  public IList<byte[]> data { get; set; } = new List<byte[]>();
354 
706  public IDictionary<string, string> options { get; set; } = new Dictionary<string, string>();
707 
710  public ExecuteSqlRequest() { }
711 
1091  long? offset = null,
1092  long? limit = null,
1093  string request_schema_str = null,
1094  IList<byte[]> data = null,
1095  IDictionary<string, string> options = null)
1096  {
1097  this.statement = statement ?? "";
1098  this.offset = offset ?? 0;
1099  this.limit = limit ?? -9999;
1100  this.encoding = Encoding.BINARY;
1102  this.data = data ?? new List<byte[]>();
1103  this.options = options ?? new Dictionary<string, string>();
1104  } // end constructor
1105 
1498  long? offset = null,
1499  long? limit = null,
1500  string encoding = null,
1501  string request_schema_str = null,
1502  IList<byte[]> data = null,
1503  IDictionary<string, string> options = null)
1504  {
1505  this.statement = statement ?? "";
1506  this.offset = offset ?? 0;
1507  this.limit = limit ?? -9999;
1508  this.encoding = encoding ?? Encoding.BINARY;
1510  this.data = data ?? new List<byte[]>();
1511  this.options = options ?? new Dictionary<string, string>();
1512  } // end full constructor
1513  } // end class ExecuteSqlRequest
1514 
1519  {
1524  public struct HasMoreRecords
1525  {
1526  public const string TRUE = "true";
1527  public const string FALSE = "false";
1528  } // end struct HasMoreRecords
1529 
1533  public struct Info
1534  {
1536  public const string COUNT = "count";
1537  } // end struct Info
1538 
1540  public long count_affected { get; set; }
1541 
1544  public string response_schema_str { get; set; }
1545 
1547  public byte[] binary_encoded_response { get; set; }
1548 
1550  public string json_encoded_response { get; set; }
1551 
1553  public long total_number_of_records { get; set; }
1554 
1565  public bool has_more_records { get; set; }
1566 
1571  public string paging_table { get; set; }
1572 
1582  public IDictionary<string, string> info { get; set; } = new Dictionary<string, string>();
1583  } // end class RawExecuteSqlResponse
1584 
1589  {
1594  public struct HasMoreRecords
1595  {
1596  public const string TRUE = "true";
1597  public const string FALSE = "false";
1598  } // end struct HasMoreRecords
1599 
1603  public struct Info
1604  {
1606  public const string COUNT = "count";
1607  } // end struct Info
1608 
1610  public long count_affected { get; set; }
1611 
1613  public IList<KineticaRecord> data { get; set; } = new List<KineticaRecord>();
1614 
1616  public long total_number_of_records { get; set; }
1617 
1628  public bool has_more_records { get; set; }
1629 
1634  public string paging_table { get; set; }
1635 
1645  public IDictionary<string, string> info { get; set; } = new Dictionary<string, string>();
1646  } // end class ExecuteSqlResponse
1647 } // end namespace kinetica
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.
Definition: ExecuteSql.cs:1497
const string COST_BASED_OPTIMIZATION
If FALSE, disables the cost-based optimization of the given query.
Definition: ExecuteSql.cs:47
ExecuteSqlRequest()
Constructs an ExecuteSqlRequest object with default parameters.
Definition: ExecuteSql.cs:710
string json_encoded_response
Avro JSON encoded response.
Definition: ExecuteSql.cs:1550
A set of string constants for the parameter has_more_records.
Definition: ExecuteSql.cs:1524
string statement
SQL statement (query, DML, or DDL) to be executed
Definition: ExecuteSql.cs:304
string encoding
Specifies the encoding for returned records; either 'binary' or 'json'.
Definition: ExecuteSql.cs:341
long offset
A positive integer indicating the number of initial results to skip (this can be useful for paging th...
Definition: ExecuteSql.cs:311
A set of string constants for the parameter encoding.
Definition: ExecuteSql.cs:23
const string SSQ_OPTIMIZATION
If FALSE, scalar subqueries will be translated into joins.
Definition: ExecuteSql.cs:249
A set of string constants for the parameter has_more_records.
Definition: ExecuteSql.cs:1594
const string RULE_BASED_OPTIMIZATION
If FALSE, disables rule-based rewrite optimizations for the given query.
Definition: ExecuteSql.cs:234
A set of string constants for the parameter options.
Definition: ExecuteSql.cs:32
const string VALIDATE_CHANGE_COLUMN
When changing a column using alter table, validate the change before applying it.
Definition: ExecuteSql.cs:293
long count_affected
The number of objects/records affected.
Definition: ExecuteSql.cs:1540
const string CURRENT_SCHEMA
Use the supplied value as the default schema when processing this SQL command.
Definition: ExecuteSql.cs:299
string paging_table
Name of the table that has the result records of the query.
Definition: ExecuteSql.cs:1571
long total_number_of_records
Total/Filtered number of records.
Definition: ExecuteSql.cs:1616
string paging_table
Name of the table that has the result records of the query.
Definition: ExecuteSql.cs:1634
const string PARALLEL_EXECUTION
If FALSE, disables the parallel step execution of the given query.
Definition: ExecuteSql.cs:151
long count_affected
The number of objects/records affected.
Definition: ExecuteSql.cs:1610
const string PREPARE_MODE
If TRUE, compiles a query into an execution plan and saves it in query cache.
Definition: ExecuteSql.cs:182
const string PRESERVE_DICT_ENCODING
If TRUE, then columns that were dict encoded in the source table will be dict encoded in the projecti...
Definition: ExecuteSql.cs:198
byte [] binary_encoded_response
Avro binary encoded response.
Definition: ExecuteSql.cs:1547
IList< KineticaRecord > data
Avro binary encoded response.
Definition: ExecuteSql.cs:1613
const string LATE_MATERIALIZATION
If TRUE, Joins/Filters results will always be materialized ( saved to result tables format).
Definition: ExecuteSql.cs:124
IDictionary< string, string > info
Additional information.
Definition: ExecuteSql.cs:1645
A set of results returned by Kinetica.executeSql.
Definition: ExecuteSql.cs:1518
const string DISTRIBUTED_OPERATIONS
If TRUE, enables the use of distributed operations in servicing the given query.
Definition: ExecuteSql.cs:82
A set of string constants for the parameter info.
Definition: ExecuteSql.cs:1603
A set of parameters for Kinetica.executeSql.
Definition: ExecuteSql.cs:17
const string PAGING_TABLE
When empty or the specified paging table not exists, the system will create a paging table and return...
Definition: ExecuteSql.cs:132
const string PAGING_TABLE_TTL
Sets the TTL of the paging table.
Definition: ExecuteSql.cs:136
string request_schema_str
Avro schema of data.
Definition: ExecuteSql.cs:345
long limit
A positive integer indicating the maximum number of results to be returned, or END_OF_SET (-9999) to ...
Definition: ExecuteSql.cs:326
IList< byte[]> data
An array of binary-encoded data for the records to be binded to the SQL query.
Definition: ExecuteSql.cs:353
IDictionary< string, string > options
Optional parameters.
Definition: ExecuteSql.cs:706
const string TTL
Sets the TTL of the intermediate result tables used in query execution.
Definition: ExecuteSql.cs:254
IDictionary< string, string > info
Additional information.
Definition: ExecuteSql.cs:1582
const string COUNT
Number of records in the final table
Definition: ExecuteSql.cs:1536
A set of string constants for the parameter info.
Definition: ExecuteSql.cs:1533
bool has_more_records
Too many records.
Definition: ExecuteSql.cs:1565
const string COUNT
Number of records in the final table
Definition: ExecuteSql.cs:1606
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.
Definition: ExecuteSql.cs:1090
const string DISTRIBUTED_JOINS
If TRUE, enables the use of distributed joins in servicing the given query.
Definition: ExecuteSql.cs:66
bool has_more_records
Too many records.
Definition: ExecuteSql.cs:1628
KineticaData - class to help with Avro Encoding for Kinetica
Definition: KineticaData.cs:14
string response_schema_str
Avro schema of binary_encoded_response or json_encoded_response.
Definition: ExecuteSql.cs:1544
const string UPDATE_ON_EXISTING_PK
Specifies the record collision policy for inserting into or updating a table with a primary key.
Definition: ExecuteSql.cs:278
const string RESULTS_CACHING
If FALSE, disables caching of the results of the given query.
Definition: ExecuteSql.cs:219
const string PLAN_CACHE
If FALSE, disables plan caching for the given query.
Definition: ExecuteSql.cs:166
const string QUERY_PARAMETERS
Query parameters in JSON array or arrays (for inserting multiple rows).
Definition: ExecuteSql.cs:204
A set of results returned by Kinetica.executeSql.
Definition: ExecuteSql.cs:1588
long total_number_of_records
Total/Filtered number of records.
Definition: ExecuteSql.cs:1553
const string IGNORE_EXISTING_PK
Specifies the record collision error-suppression policy for inserting into or updating a table with a...
Definition: ExecuteSql.cs:108