Kinetica C# API  Version 7.1.10.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 
23  {
24 
42  public struct Encoding
43  {
44  public const string BINARY = "binary";
45  public const string JSON = "json";
46  } // end struct Encoding
47 
48 
406  public struct Options
407  {
408 
424  public const string COST_BASED_OPTIMIZATION = "cost_based_optimization";
425  public const string TRUE = "true";
426  public const string FALSE = "false";
427 
446  public const string DISTRIBUTED_JOINS = "distributed_joins";
447 
466  public const string DISTRIBUTED_OPERATIONS = "distributed_operations";
467 
503  public const string IGNORE_EXISTING_PK = "ignore_existing_pk";
504 
520  public const string LATE_MATERIALIZATION = "late_materialization";
521 
527  public const string PAGING_TABLE = "paging_table";
528 
531  public const string PAGING_TABLE_TTL = "paging_table_ttl";
532 
548  public const string PARALLEL_EXECUTION = "parallel_execution";
549 
565  public const string PLAN_CACHE = "plan_cache";
566 
583  public const string PREPARE_MODE = "prepare_mode";
584 
600  public const string PRESERVE_DICT_ENCODING = "preserve_dict_encoding";
601 
605  public const string QUERY_PARAMETERS = "query_parameters";
606 
622  public const string RESULTS_CACHING = "results_caching";
623 
639  public const string RULE_BASED_OPTIMIZATION = "rule_based_optimization";
640 
656  public const string SSQ_OPTIMIZATION = "ssq_optimization";
657 
661  public const string TTL = "ttl";
662 
695  public const string UPDATE_ON_EXISTING_PK = "update_on_existing_pk";
696 
715  public const string VALIDATE_CHANGE_COLUMN = "validate_change_column";
716 
721  public const string CURRENT_SCHEMA = "current_schema";
722  } // end struct Options
723 
724 
727  public string statement { get; set; }
728 
733  public long offset { get; set; } = 0;
734 
749  public long limit { get; set; } = -9999;
750 
766  public string encoding { get; set; } = Encoding.BINARY;
767 
770  public string request_schema_str { get; set; } = "";
771 
776  public IList<byte[]> data { get; set; } = new List<byte[]>();
777 
1133  public IDictionary<string, string> options { get; set; } = new Dictionary<string, string>();
1134 
1135 
1138  public ExecuteSqlRequest() { }
1139 
1526  long? offset = null,
1527  long? limit = null,
1528  string request_schema_str = null,
1529  IList<byte[]> data = null,
1530  IDictionary<string, string> options = null)
1531  {
1532  this.statement = statement ?? "";
1533  this.offset = offset ?? 0;
1534  this.limit = limit ?? -9999;
1535  this.encoding = Encoding.BINARY;
1536  this.request_schema_str = request_schema_str ?? "";
1537  this.data = data ?? new List<byte[]>();
1538  this.options = options ?? new Dictionary<string, string>();
1539  } // end constructor
1540 
1541 
1943  long? offset = null,
1944  long? limit = null,
1945  string encoding = null,
1946  string request_schema_str = null,
1947  IList<byte[]> data = null,
1948  IDictionary<string, string> options = null)
1949  {
1950  this.statement = statement ?? "";
1951  this.offset = offset ?? 0;
1952  this.limit = limit ?? -9999;
1953  this.encoding = encoding ?? Encoding.BINARY;
1954  this.request_schema_str = request_schema_str ?? "";
1955  this.data = data ?? new List<byte[]>();
1956  this.options = options ?? new Dictionary<string, string>();
1957  } // end full constructor
1958 
1959  } // end class ExecuteSqlRequest
1960 
1961 
1962 
1967  {
1968 
1983  public struct HasMoreRecords
1984  {
1985  public const string TRUE = "true";
1986  public const string FALSE = "false";
1987  } // end struct HasMoreRecords
1988 
1989 
2002  public struct Info
2003  {
2004 
2006  public const string COUNT = "count";
2007  } // end struct Info
2008 
2009 
2011  public long count_affected { get; set; }
2012 
2015  public string response_schema_str { get; set; }
2016 
2018  public byte[] binary_encoded_response { get; set; }
2019 
2021  public string json_encoded_response { get; set; }
2022 
2024  public long total_number_of_records { get; set; }
2025 
2038  public bool has_more_records { get; set; }
2039 
2043  public string paging_table { get; set; }
2044 
2055  public IDictionary<string, string> info { get; set; } = new Dictionary<string, string>();
2056 
2057  } // end class RawExecuteSqlResponse
2058 
2059 
2060 
2065  {
2066 
2081  public struct HasMoreRecords
2082  {
2083  public const string TRUE = "true";
2084  public const string FALSE = "false";
2085  } // end struct HasMoreRecords
2086 
2087 
2100  public struct Info
2101  {
2102 
2104  public const string COUNT = "count";
2105  } // end struct Info
2106 
2107 
2109  public long count_affected { get; set; }
2110 
2112  public IList<KineticaRecord> data { get; set; } = new List<KineticaRecord>();
2113 
2115  public long total_number_of_records { get; set; }
2116 
2129  public bool has_more_records { get; set; }
2130 
2134  public string paging_table { get; set; }
2135 
2146  public IDictionary<string, string> info { get; set; } = new Dictionary<string, string>();
2147 
2148  } // end class ExecuteSqlResponse
2149 
2150 
2151 
2152 
2153 } // end namespace kinetica
const string COST_BASED_OPTIMIZATION
If false, disables the cost-based optimization of the given query.
Definition: ExecuteSql.cs:424
ExecuteSqlRequest()
Constructs an ExecuteSqlRequest object with default parameters.
Definition: ExecuteSql.cs:1138
string json_encoded_response
Avro JSON encoded response.
Definition: ExecuteSql.cs:2021
string statement
SQL statement (query, DML, or DDL) to be executed
Definition: ExecuteSql.cs:727
string encoding
Specifies the encoding for returned records; either &#39;binary&#39; or &#39;json&#39;.
Definition: ExecuteSql.cs:766
long offset
A positive integer indicating the number of initial results to skip (this can be useful for paging th...
Definition: ExecuteSql.cs:733
Specifies the encoding for returned records; either &#39;binary&#39; or &#39;json&#39;.
Definition: ExecuteSql.cs:42
const string SSQ_OPTIMIZATION
If false, scalar subqueries will be translated into joins Supported values: TRUE FALSE The default ...
Definition: ExecuteSql.cs:656
const string RULE_BASED_OPTIMIZATION
If false, disables rule-based rewrite optimizations for the given query Supported values: TRUE FALSE...
Definition: ExecuteSql.cs:639
const string VALIDATE_CHANGE_COLUMN
When changing a column using alter table, validate the change before applying it. ...
Definition: ExecuteSql.cs:715
long count_affected
The number of objects/records affected.
Definition: ExecuteSql.cs:2011
const string CURRENT_SCHEMA
Use the supplied value as the default schema when processing this SQL command.
Definition: ExecuteSql.cs:721
string paging_table
Name of the table that has the result records of the query.
Definition: ExecuteSql.cs:2043
long total_number_of_records
Total/Filtered number of records.
Definition: ExecuteSql.cs:2115
string paging_table
Name of the table that has the result records of the query.
Definition: ExecuteSql.cs:2134
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:1525
const string PARALLEL_EXECUTION
If false, disables the parallel step execution of the given query.
Definition: ExecuteSql.cs:548
long count_affected
The number of objects/records affected.
Definition: ExecuteSql.cs:2109
const string PREPARE_MODE
If true, compiles a query into an execution plan and saves it in query cache.
Definition: ExecuteSql.cs:583
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:600
byte[] binary_encoded_response
Avro binary encoded response.
Definition: ExecuteSql.cs:2018
IList< KineticaRecord > data
Avro binary encoded response.
Definition: ExecuteSql.cs:2112
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:2146
A set of results returned by Kinetica.executeSql(string,long,long,string,IList{byte[]},IDictionary{string, string}).
Definition: ExecuteSql.cs:1966
const string DISTRIBUTED_OPERATIONS
If true, enables the use of distributed operations in servicing the given query.
Definition: ExecuteSql.cs:466
Additional information.
Definition: ExecuteSql.cs:2100
A set of parameters for Kinetica.executeSql(string,long,long,string,IList{byte[]},IDictionary{string, string}).
Definition: ExecuteSql.cs:22
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:527
const string PAGING_TABLE_TTL
Sets the TTL of the paging table.
Definition: ExecuteSql.cs:531
string request_schema_str
Avro schema of .
Definition: ExecuteSql.cs:770
long limit
A positive integer indicating the maximum number of results to be returned, or END_OF_SET (-9999) to ...
Definition: ExecuteSql.cs:749
IList< byte[]> data
An array of binary-encoded data for the records to be binded to the SQL query.
Definition: ExecuteSql.cs:776
IDictionary< string, string > options
Optional parameters.
Definition: ExecuteSql.cs:1133
const string TTL
Sets the TTL of the intermediate result tables used in query execution.
Definition: ExecuteSql.cs:661
IDictionary< string, string > info
Additional information.
Definition: ExecuteSql.cs:2055
const string COUNT
Number of records in the final table
Definition: ExecuteSql.cs:2006
Additional information.
Definition: ExecuteSql.cs:2002
bool has_more_records
Too many records.
Definition: ExecuteSql.cs:2038
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:1942
const string COUNT
Number of records in the final table
Definition: ExecuteSql.cs:2104
const string DISTRIBUTED_JOINS
If true, enables the use of distributed joins in servicing the given query.
Definition: ExecuteSql.cs:446
bool has_more_records
Too many records.
Definition: ExecuteSql.cs:2129
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:2015
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:695
const string RESULTS_CACHING
If false, disables caching of the results of the given query Supported values: TRUE FALSE The defau...
Definition: ExecuteSql.cs:622
const string PLAN_CACHE
If false, disables plan caching for the given query.
Definition: ExecuteSql.cs:565
const string QUERY_PARAMETERS
Query parameters in JSON array or arrays (for inserting multiple rows).
Definition: ExecuteSql.cs:605
A set of results returned by Kinetica.executeSql(string,long,long,string,IList{byte[]},IDictionary{string, string}).
Definition: ExecuteSql.cs:2064
long total_number_of_records
Total/Filtered number of records.
Definition: ExecuteSql.cs:2024
const string IGNORE_EXISTING_PK
Specifies the record collision error-suppression policy for inserting into or updating a table with a...
Definition: ExecuteSql.cs:503