Kinetica C# API  Version 7.0.19.0
 All Classes Namespaces Files Functions Variables Enumerations Enumerator Properties Pages
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 
10 
11 namespace kinetica
12 {
13 
20  {
21 
39  public struct Encoding
40  {
41  public const string BINARY = "binary";
42  public const string JSON = "json";
43  } // end struct Encoding
44 
45 
347  public struct Options
348  {
349 
365  public const string PARALLEL_EXECUTION = "parallel_execution";
366  public const string TRUE = "true";
367  public const string FALSE = "false";
368 
384  public const string COST_BASED_OPTIMIZATION = "cost_based_optimization";
385 
401  public const string PLAN_CACHE = "plan_cache";
402 
418  public const string RULE_BASED_OPTIMIZATION = "rule_based_optimization";
419 
435  public const string RESULTS_CACHING = "results_caching";
436 
442  public const string PAGING_TABLE = "paging_table";
443 
446  public const string PAGING_TABLE_TTL = "paging_table_ttl";
447 
466  public const string DISTRIBUTED_JOINS = "distributed_joins";
467 
486  public const string DISTRIBUTED_OPERATIONS = "distributed_operations";
487 
503  public const string SSQ_OPTIMIZATION = "ssq_optimization";
504 
520  public const string LATE_MATERIALIZATION = "late_materialization";
521 
525  public const string TTL = "ttl";
526 
544  public const string UPDATE_ON_EXISTING_PK = "update_on_existing_pk";
545 
561  public const string PRESERVE_DICT_ENCODING = "preserve_dict_encoding";
562 
583  public const string VALIDATE_CHANGE_COLUMN = "validate_change_column";
584 
601  public const string PREPARE_MODE = "prepare_mode";
602 
604  public const string VIEW_ID = "view_id";
605 
607  public const string NO_COUNT = "no_count";
608  } // end struct Options
609 
610 
613  public string statement { get; set; }
614 
619  public long offset { get; set; } = 0;
620 
632  public long limit { get; set; } = -9999;
633 
649  public string encoding { get; set; } = Encoding.BINARY;
650 
653  public string request_schema_str { get; set; } = "";
654 
658  public IList<byte[]> data { get; set; } = new List<byte[]>();
659 
959  public IDictionary<string, string> options { get; set; } = new Dictionary<string, string>();
960 
961 
964  public ExecuteSqlRequest() { }
965 
1293  long? offset = null,
1294  long? limit = null,
1295  string request_schema_str = null,
1296  IList<byte[]> data = null,
1297  IDictionary<string, string> options = null)
1298  {
1299  this.statement = statement ?? "";
1300  this.offset = offset ?? 0;
1301  this.limit = limit ?? -9999;
1302  this.encoding = Encoding.BINARY;
1303  this.request_schema_str = request_schema_str ?? "";
1304  this.data = data ?? new List<byte[]>();
1305  this.options = options ?? new Dictionary<string, string>();
1306  } // end constructor
1307 
1308 
1651  long? offset = null,
1652  long? limit = null,
1653  string encoding = null,
1654  string request_schema_str = null,
1655  IList<byte[]> data = null,
1656  IDictionary<string, string> options = null)
1657  {
1658  this.statement = statement ?? "";
1659  this.offset = offset ?? 0;
1660  this.limit = limit ?? -9999;
1661  this.encoding = encoding ?? Encoding.BINARY;
1662  this.request_schema_str = request_schema_str ?? "";
1663  this.data = data ?? new List<byte[]>();
1664  this.options = options ?? new Dictionary<string, string>();
1665  } // end full constructor
1666 
1667  } // end class ExecuteSqlRequest
1668 
1669 
1670 
1675  {
1676 
1691  public struct HasMoreRecords
1692  {
1693  public const string TRUE = "true";
1694  public const string FALSE = "false";
1695  } // end struct HasMoreRecords
1696 
1697 
1710  public struct Info
1711  {
1712 
1714  public const string COUNT = "count";
1715  } // end struct Info
1716 
1717 
1719  public long count_affected { get; set; }
1720 
1723  public string response_schema_str { get; set; }
1724 
1726  public byte[] binary_encoded_response { get; set; }
1727 
1729  public string json_encoded_response { get; set; }
1730 
1732  public long total_number_of_records { get; set; }
1733 
1746  public bool has_more_records { get; set; }
1747 
1751  public string paging_table { get; set; }
1752 
1763  public IDictionary<string, string> info { get; set; } = new Dictionary<string, string>();
1764 
1765  } // end class RawExecuteSqlResponse
1766 
1767 
1768 
1773  {
1774 
1789  public struct HasMoreRecords
1790  {
1791  public const string TRUE = "true";
1792  public const string FALSE = "false";
1793  } // end struct HasMoreRecords
1794 
1795 
1808  public struct Info
1809  {
1810 
1812  public const string COUNT = "count";
1813  } // end struct Info
1814 
1815 
1817  public long count_affected { get; set; }
1818 
1820  public IList<KineticaRecord> data { get; set; } = new List<KineticaRecord>();
1821 
1823  public long total_number_of_records { get; set; }
1824 
1837  public bool has_more_records { get; set; }
1838 
1842  public string paging_table { get; set; }
1843 
1854  public IDictionary<string, string> info { get; set; } = new Dictionary<string, string>();
1855 
1856  } // end class ExecuteSqlResponse
1857 
1858 
1859 
1860 
1861 } // end namespace kinetica
const string COST_BASED_OPTIMIZATION
If false, disables the cost-based optimization of the given query.
Definition: ExecuteSql.cs:384
ExecuteSqlRequest()
Constructs an ExecuteSqlRequest object with default parameters.
Definition: ExecuteSql.cs:964
string json_encoded_response
Avro JSON encoded response.
Definition: ExecuteSql.cs:1729
string statement
SQL statement (query, DML, or DDL) to be executed
Definition: ExecuteSql.cs:613
string encoding
Specifies the encoding for returned records; either &#39;binary&#39; or &#39;json&#39;.
Definition: ExecuteSql.cs:649
long offset
A positive integer indicating the number of initial results to skip (this can be useful for paging th...
Definition: ExecuteSql.cs:619
Specifies the encoding for returned records; either &#39;binary&#39; or &#39;json&#39;.
Definition: ExecuteSql.cs:39
const string SSQ_OPTIMIZATION
If false, scalar subqueries will be translated into joins Supported values: TRUE FALSE The default ...
Definition: ExecuteSql.cs:503
const string RULE_BASED_OPTIMIZATION
If false, disables rule-based rewrite optimizations for the given query Supported values: TRUE FALSE...
Definition: ExecuteSql.cs:418
const string VALIDATE_CHANGE_COLUMN
When changing a column using alter table, validate the change before applying it. ...
Definition: ExecuteSql.cs:583
long count_affected
The number of objects/records affected.
Definition: ExecuteSql.cs:1719
string paging_table
Name of the table that has the result records of the query.
Definition: ExecuteSql.cs:1751
long total_number_of_records
Total/Filtered number of records.
Definition: ExecuteSql.cs:1823
string paging_table
Name of the table that has the result records of the query.
Definition: ExecuteSql.cs:1842
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:1292
const string PARALLEL_EXECUTION
If false, disables the parallel step execution of the given query.
Definition: ExecuteSql.cs:365
long count_affected
The number of objects/records affected.
Definition: ExecuteSql.cs:1817
const string PREPARE_MODE
If true, compiles a query into an execution plan and saves it in query cache.
Definition: ExecuteSql.cs:601
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:561
byte[] binary_encoded_response
Avro binary encoded response.
Definition: ExecuteSql.cs:1726
IList< KineticaRecord > data
Avro binary encoded response.
Definition: ExecuteSql.cs:1820
const string LATE_MATERIALIZATION
If true, Joins/Filters results will always be materialized ( saved to result tables format) Supported...
Definition: ExecuteSql.cs:520
IDictionary< string, string > info
Additional information.
Definition: ExecuteSql.cs:1854
A set of results returned by Kinetica.executeSql(string,long,long,string,IList{byte[]},IDictionary{string, string}).
Definition: ExecuteSql.cs:1674
const string DISTRIBUTED_OPERATIONS
If true, enables the use of distributed operations in servicing the given query.
Definition: ExecuteSql.cs:486
Additional information.
Definition: ExecuteSql.cs:1808
A set of parameters for Kinetica.executeSql(string,long,long,string,IList{byte[]},IDictionary{string, string}).
Definition: ExecuteSql.cs:19
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:442
const string PAGING_TABLE_TTL
Sets the TTL of the paging table.
Definition: ExecuteSql.cs:446
string request_schema_str
Avro schema of .
Definition: ExecuteSql.cs:653
long limit
A positive integer indicating the maximum number of results to be returned, or END_OF_SET (-9999) to ...
Definition: ExecuteSql.cs:632
IList< byte[]> data
An array of binary-encoded data for the records to be binded to the SQL query.
Definition: ExecuteSql.cs:658
IDictionary< string, string > options
Optional parameters.
Definition: ExecuteSql.cs:959
const string TTL
Sets the TTL of the intermediate result tables used in query execution.
Definition: ExecuteSql.cs:525
IDictionary< string, string > info
Additional information.
Definition: ExecuteSql.cs:1763
const string NO_COUNT
&lt;DEVELOPER&gt; The default value is &#39;false&#39;.
Definition: ExecuteSql.cs:607
const string COUNT
Number of records in the final table
Definition: ExecuteSql.cs:1714
const string VIEW_ID
&lt;DEVELOPER&gt; The default value is &#39;&#39;.
Definition: ExecuteSql.cs:604
Additional information.
Definition: ExecuteSql.cs:1710
bool has_more_records
Too many records.
Definition: ExecuteSql.cs:1746
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:1650
const string COUNT
Number of records in the final table
Definition: ExecuteSql.cs:1812
const string DISTRIBUTED_JOINS
If true, enables the use of distributed joins in servicing the given query.
Definition: ExecuteSql.cs:466
bool has_more_records
Too many records.
Definition: ExecuteSql.cs:1837
KineticaData - class to help with Avro Encoding for Kinetica
Definition: KineticaData.cs:14
string response_schema_str
Avro schema of &lt;member name=&quot;binary_encoded_response&quot;&gt; or &lt;member name=&quot;json_encoded_response&quot;&gt;.
Definition: ExecuteSql.cs:1723
const string UPDATE_ON_EXISTING_PK
Can be used to customize behavior when the updated primary key value already exists as described in K...
Definition: ExecuteSql.cs:544
const string RESULTS_CACHING
If false, disables caching of the results of the given query Supported values: TRUE FALSE The defau...
Definition: ExecuteSql.cs:435
const string PLAN_CACHE
If false, disables plan caching for the given query.
Definition: ExecuteSql.cs:401
A set of results returned by Kinetica.executeSql(string,long,long,string,IList{byte[]},IDictionary{string, string}).
Definition: ExecuteSql.cs:1772
long total_number_of_records
Total/Filtered number of records.
Definition: ExecuteSql.cs:1732