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 {
37  public class ExecuteSqlRequest : KineticaData
38  {
43  public struct Encoding
44  {
45  public const string BINARY = "binary";
46  public const string JSON = "json";
47  } // end struct Encoding
48 
52  public struct Options
53  {
67  public const string COST_BASED_OPTIMIZATION = "cost_based_optimization";
68 
69  public const string TRUE = "true";
70  public const string FALSE = "false";
71 
86  public const string DISTRIBUTED_JOINS = "distributed_joins";
87 
102  public const string DISTRIBUTED_OPERATIONS = "distributed_operations";
103 
128  public const string IGNORE_EXISTING_PK = "ignore_existing_pk";
129 
144  public const string LATE_MATERIALIZATION = "late_materialization";
145 
164  public const string PAGING_TABLE = "paging_table";
165 
177  public const string PAGING_TABLE_TTL = "paging_table_ttl";
178 
192  public const string PARALLEL_EXECUTION = "parallel_execution";
193 
207  public const string PLAN_CACHE = "plan_cache";
208 
223  public const string PREPARE_MODE = "prepare_mode";
224 
239  public const string PRESERVE_DICT_ENCODING = "preserve_dict_encoding";
240 
245  public const string QUERY_PARAMETERS = "query_parameters";
246 
260  public const string RESULTS_CACHING = "results_caching";
261 
275  public const string RULE_BASED_OPTIMIZATION = "rule_based_optimization";
276 
290  public const string SSQ_OPTIMIZATION = "ssq_optimization";
291 
295  public const string TTL = "ttl";
296 
319  public const string UPDATE_ON_EXISTING_PK = "update_on_existing_pk";
320 
334  public const string VALIDATE_CHANGE_COLUMN = "validate_change_column";
335 
340  public const string CURRENT_SCHEMA = "current_schema";
341  } // end struct Options
342 
345  public string statement { get; set; }
346 
352  public long offset { get; set; } = 0;
353 
367  public long limit { get; set; } = -9999;
368 
382  public string encoding { get; set; } = Encoding.BINARY;
383 
386  public string request_schema_str { get; set; } = "";
387 
394  public IList<byte[]> data { get; set; } = new List<byte[]>();
395 
767  public IDictionary<string, string> options { get; set; } = new Dictionary<string, string>();
768 
771  public ExecuteSqlRequest() { }
772 
1172  long? offset = null,
1173  long? limit = null,
1174  string request_schema_str = null,
1175  IList<byte[]> data = null,
1176  IDictionary<string, string> options = null)
1177  {
1178  this.statement = statement ?? "";
1179  this.offset = offset ?? 0;
1180  this.limit = limit ?? -9999;
1181  this.encoding = Encoding.BINARY;
1183  this.data = data ?? new List<byte[]>();
1184  this.options = options ?? new Dictionary<string, string>();
1185  } // end constructor
1186 
1599  long? offset = null,
1600  long? limit = null,
1601  string encoding = null,
1602  string request_schema_str = null,
1603  IList<byte[]> data = null,
1604  IDictionary<string, string> options = null)
1605  {
1606  this.statement = statement ?? "";
1607  this.offset = offset ?? 0;
1608  this.limit = limit ?? -9999;
1609  this.encoding = encoding ?? Encoding.BINARY;
1611  this.data = data ?? new List<byte[]>();
1612  this.options = options ?? new Dictionary<string, string>();
1613  } // end full constructor
1614  } // end class ExecuteSqlRequest
1615 
1619  public class RawExecuteSqlResponse : KineticaData
1620  {
1625  public struct HasMoreRecords
1626  {
1627  public const string TRUE = "true";
1628  public const string FALSE = "false";
1629  } // end struct HasMoreRecords
1630 
1634  public struct Info
1635  {
1638  public const string COUNT = "count";
1639 
1645  public const string RESULT_TABLE_LIST = "result_table_list";
1646  } // end struct Info
1647 
1649  public long count_affected { get; set; }
1650 
1653  public string response_schema_str { get; set; }
1654 
1656  public byte[] binary_encoded_response { get; set; }
1657 
1659  public string json_encoded_response { get; set; }
1660 
1662  public long total_number_of_records { get; set; }
1663 
1674  public bool has_more_records { get; set; }
1675 
1683  public string paging_table { get; set; }
1684 
1703  public IDictionary<string, string> info { get; set; } = new Dictionary<string, string>();
1704  } // end class RawExecuteSqlResponse
1705 
1709  public class ExecuteSqlResponse : KineticaData
1710  {
1715  public struct HasMoreRecords
1716  {
1717  public const string TRUE = "true";
1718  public const string FALSE = "false";
1719  } // end struct HasMoreRecords
1720 
1724  public struct Info
1725  {
1728  public const string COUNT = "count";
1729 
1735  public const string RESULT_TABLE_LIST = "result_table_list";
1736  } // end struct Info
1737 
1739  public long count_affected { get; set; }
1740 
1742  public IList<KineticaRecord> data { get; set; } = new List<KineticaRecord>();
1743 
1745  public long total_number_of_records { get; set; }
1746 
1757  public bool has_more_records { get; set; }
1758 
1766  public string paging_table { get; set; }
1767 
1786  public IDictionary<string, string> info { get; set; } = new Dictionary<string, string>();
1787  } // end class ExecuteSqlResponse
1788 } // end namespace kinetica
const string RESULT_TABLE_LIST
List of tables, comma-separated, in addition to the paging_table, created as result of the query.
Definition: ExecuteSql.cs:1645
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:1598
IDictionary< string, string > info
Additional information.
Definition: ExecuteSql.cs:1645
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
ExecuteSqlRequest()
Constructs an ExecuteSqlRequest object with default parameters.
Definition: ExecuteSql.cs:771
const string VALIDATE_CHANGE_COLUMN
When changing a column using alter table, validate the change before applying it.
Definition: ExecuteSql.cs:293
long offset
A positive integer indicating the number of initial results to skip (this can be useful for paging th...
Definition: ExecuteSql.cs:311
string request_schema_str
Avro schema of data.
Definition: ExecuteSql.cs:345
IList< byte[]> data
An array of binary-encoded data for the records to be binded to the SQL query.
Definition: ExecuteSql.cs:353
A set of string constants for the parameter encoding.
Definition: ExecuteSql.cs:23
string json_encoded_response
Avro JSON encoded response.
Definition: ExecuteSql.cs:1550
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:1571
IList< KineticaRecord > data
Avro binary encoded response.
Definition: ExecuteSql.cs:1613
bool has_more_records
Too many records.
Definition: ExecuteSql.cs:1628
const string QUERY_PARAMETERS
Query parameters in JSON array or arrays (for inserting multiple rows).
Definition: ExecuteSql.cs:204
const string PLAN_CACHE
If FALSE, disables plan caching for the given query.
Definition: ExecuteSql.cs:166
IDictionary< string, string > options
Optional parameters.
Definition: ExecuteSql.cs:706
const string COUNT
Number of records in the final table
Definition: ExecuteSql.cs:1536
const string PAGING_TABLE_TTL
Sets the TTL of the paging table.
Definition: ExecuteSql.cs:136
const string DISTRIBUTED_JOINS
If TRUE, enables the use of distributed joins in servicing the given query.
Definition: ExecuteSql.cs:66
byte [] binary_encoded_response
Avro binary encoded response.
Definition: ExecuteSql.cs:1547
const string TTL
Sets the TTL of the intermediate result tables used in query execution.
Definition: ExecuteSql.cs:254
long total_number_of_records
Total/Filtered number of records.
Definition: ExecuteSql.cs:1553
const string LATE_MATERIALIZATION
If TRUE, Joins/Filters results will always be materialized ( saved to result tables format).
Definition: ExecuteSql.cs:124
const string RESULTS_CACHING
If FALSE, disables caching of the results of the given query.
Definition: ExecuteSql.cs:219
const string DISTRIBUTED_OPERATIONS
If TRUE, enables the use of distributed operations in servicing the given query.
Definition: ExecuteSql.cs:82
const string RULE_BASED_OPTIMIZATION
If FALSE, disables rule-based rewrite optimizations for the given query.
Definition: ExecuteSql.cs:234
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
string paging_table
Name of the table that has the result records of the query.
Definition: ExecuteSql.cs:1634
const string COUNT
Number of records in the final table
Definition: ExecuteSql.cs:1606
long count_affected
The number of objects/records affected.
Definition: ExecuteSql.cs:1610
string encoding
Specifies the encoding for returned records; either 'binary' or 'json'.
Definition: ExecuteSql.cs:341
IDictionary< string, string > info
Additional information.
Definition: ExecuteSql.cs:1582
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
const string COST_BASED_OPTIMIZATION
If FALSE, disables the cost-based optimization of the given query.
Definition: ExecuteSql.cs:47
string statement
SQL statement (query, DML, or DDL) to be executed
Definition: ExecuteSql.cs:304
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
bool has_more_records
Too many records.
Definition: ExecuteSql.cs:1565
const string PARALLEL_EXECUTION
If FALSE, disables the parallel step execution of the given query.
Definition: ExecuteSql.cs:151
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:1171
const string CURRENT_SCHEMA
Use the supplied value as the default schema when processing this SQL command.
Definition: ExecuteSql.cs:299
const string RESULT_TABLE_LIST
List of tables, comma-separated, in addition to the paging_table, created as result of the query.
Definition: ExecuteSql.cs:1735
const string SSQ_OPTIMIZATION
If FALSE, scalar subqueries will be translated into joins.
Definition: ExecuteSql.cs:249
long count_affected
The number of objects/records affected.
Definition: ExecuteSql.cs:1540
const string PREPARE_MODE
If TRUE, compiles a query into an execution plan and saves it in query cache.
Definition: ExecuteSql.cs:182
long limit
A positive integer indicating the maximum number of results to be returned, or END_OF_SET (-9999) to ...
Definition: ExecuteSql.cs:326