Kinetica C# API  Version 7.1.10.0
 All Classes Namespaces Files Functions Variables Enumerations Enumerator Properties Pages
AggregateUnpivot.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 
42  {
43 
64  public struct Encoding
65  {
66 
69  public const string BINARY = "binary";
70 
73  public const string JSON = "json";
74  } // end struct Encoding
75 
76 
218  public struct Options
219  {
220 
241  public const string CREATE_TEMP_TABLE = "create_temp_table";
242  public const string TRUE = "true";
243  public const string FALSE = "false";
244 
252  public const string COLLECTION_NAME = "collection_name";
253 
261  public const string RESULT_TABLE = "result_table";
262 
281  public const string RESULT_TABLE_PERSIST = "result_table_persist";
282 
285  public const string EXPRESSION = "expression";
286 
292  public const string ORDER_BY = "order_by";
293 
297  public const string CHUNK_SIZE = "chunk_size";
298 
301  public const string LIMIT = "limit";
302 
306  public const string TTL = "ttl";
307 
310  public const string VIEW_ID = "view_id";
311 
317  public const string CREATE_INDEXES = "create_indexes";
318 
335  public const string RESULT_TABLE_FORCE_REPLICATED = "result_table_force_replicated";
336  } // end struct Options
337 
338 
344  public string table_name { get; set; }
345 
349  public IList<string> column_names { get; set; } = new List<string>();
350 
353  public string variable_column_name { get; set; } = "";
354 
357  public string value_column_name { get; set; } = "";
358 
362  public IList<string> pivoted_columns { get; set; } = new List<string>();
363 
383  public string encoding { get; set; } = Encoding.BINARY;
384 
524  public IDictionary<string, string> options { get; set; } = new Dictionary<string, string>();
525 
526 
530 
690  IList<string> column_names,
691  string variable_column_name,
692  string value_column_name,
693  IList<string> pivoted_columns,
694  IDictionary<string, string> options = null)
695  {
696  this.table_name = table_name ?? "";
697  this.column_names = column_names ?? new List<string>();
698  this.variable_column_name = variable_column_name ?? "";
699  this.value_column_name = value_column_name ?? "";
700  this.pivoted_columns = pivoted_columns ?? new List<string>();
701  this.encoding = Encoding.BINARY;
702  this.options = options ?? new Dictionary<string, string>();
703  } // end constructor
704 
705 
884  IList<string> column_names,
885  string variable_column_name,
886  string value_column_name,
887  IList<string> pivoted_columns,
888  string encoding = null,
889  IDictionary<string, string> options = null)
890  {
891  this.table_name = table_name ?? "";
892  this.column_names = column_names ?? new List<string>();
893  this.variable_column_name = variable_column_name ?? "";
894  this.value_column_name = value_column_name ?? "";
895  this.pivoted_columns = pivoted_columns ?? new List<string>();
896  this.encoding = encoding ?? Encoding.BINARY;
897  this.options = options ?? new Dictionary<string, string>();
898  } // end full constructor
899 
900  } // end class AggregateUnpivotRequest
901 
902 
903 
908  {
909 
922  public struct Info
923  {
924 
927  public const string QUALIFIED_RESULT_TABLE_NAME = "qualified_result_table_name";
928  } // end struct Info
929 
930 
933  public string table_name { get; set; }
934 
937  public string response_schema_str { get; set; }
938 
940  public byte[] binary_encoded_response { get; set; }
941 
943  public string json_encoded_response { get; set; }
944 
946  public long total_number_of_records { get; set; }
947 
949  public bool has_more_records { get; set; }
950 
961  public IDictionary<string, string> info { get; set; } = new Dictionary<string, string>();
962 
963  } // end class RawAggregateUnpivotResponse
964 
965 
966 
971  {
972 
985  public struct Info
986  {
987 
990  public const string QUALIFIED_RESULT_TABLE_NAME = "qualified_result_table_name";
991  } // end struct Info
992 
993 
996  public string table_name { get; set; }
997 
999  public IList<KineticaRecord> data { get; set; } = new List<KineticaRecord>();
1000 
1002  public long total_number_of_records { get; set; }
1003 
1005  public bool has_more_records { get; set; }
1006 
1017  public IDictionary<string, string> info { get; set; } = new Dictionary<string, string>();
1018 
1019  } // end class AggregateUnpivotResponse
1020 
1021 
1022 
1023 
1024 } // end namespace kinetica
byte[] binary_encoded_response
Avro binary encoded response.
const string RESULT_TABLE_PERSIST
If true, then the result table specified in result_table will be persisted and will not expire unless...
const string ORDER_BY
Comma-separated list of the columns to be sorted by; e.g.
IDictionary< string, string > info
Additional information.
bool has_more_records
Too many records. Returned a partial set.
string variable_column_name
Specifies the variable/parameter column name.
long total_number_of_records
Total/Filtered number of records.
A set of results returned by Kinetica.aggregateUnpivot(string,IList{string},string,string,IList{string},IDictionary{string, string}).
string encoding
Specifies the encoding for returned records.
AggregateUnpivotRequest(string table_name, IList< string > column_names, string variable_column_name, string value_column_name, IList< string > pivoted_columns, string encoding=null, IDictionary< string, string > options=null)
Constructs an AggregateUnpivotRequest object with the specified parameters.
A set of results returned by Kinetica.aggregateUnpivot(string,IList{string},string,string,IList{string},IDictionary{string, string}).
const string RESULT_TABLE_FORCE_REPLICATED
Force the result table to be replicated (ignores any sharding).
string value_column_name
Specifies the value column name.
const string CHUNK_SIZE
Indicates the number of records per chunk to be used for the result table.
IDictionary< string, string > options
Optional parameters.
IList< KineticaRecord > data
Avro binary encoded response.
const string QUALIFIED_RESULT_TABLE_NAME
The fully qualified name of the table (i.e.
const string TTL
Sets the TTL of the table specified in result_table.
const string COLLECTION_NAME
[DEPRECATED–please specify the containing schema as part of result_table and use Kinetica.createSchema(string,IDictionary{string, string}) to create the schema if non-existent] Name of a schema which is to contain the table specified in result_table.
AggregateUnpivotRequest()
Constructs an AggregateUnpivotRequest object with default parameters.
string table_name
Name of the table on which the operation will be performed.
const string VIEW_ID
view this result table is part of.
A set of parameters for Kinetica.aggregateUnpivot(string,IList{string},string,string,IList{string},IDictionary{string, string}).
string table_name
Typically shows the result-table name if provided in the request (Ignore otherwise).
const string BINARY
Indicates that the returned records should be binary encoded.
IDictionary< string, string > info
Additional information.
long total_number_of_records
Total/Filtered number of records.
bool has_more_records
Too many records. Returned a partial set.
const string EXPRESSION
Filter expression to apply to the table prior to unpivot processing.
string table_name
Typically shows the result-table name if provided in the request (Ignore otherwise).
AggregateUnpivotRequest(string table_name, IList< string > column_names, string variable_column_name, string value_column_name, IList< string > pivoted_columns, IDictionary< string, string > options=null)
Constructs an AggregateUnpivotRequest object with the specified parameters.
IList< string > pivoted_columns
List of one or more values typically the column names of the input table.
string json_encoded_response
Avro JSON encoded response.
const string CREATE_INDEXES
Comma-separated list of columns on which to create indexes on the table specified in result_table...
Specifies the encoding for returned records.
const string RESULT_TABLE
The name of a table used to store the results, in [schema_name.
const string LIMIT
The number of records to keep.
KineticaData - class to help with Avro Encoding for Kinetica
Definition: KineticaData.cs:14
const string JSON
Indicates that the returned records should be json encoded.
const string QUALIFIED_RESULT_TABLE_NAME
The fully qualified name of the table (i.e.
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;.
IList< string > column_names
List of column names or expressions.
const string CREATE_TEMP_TABLE
If true, a unique temporary table name will be generated in the sys_temp schema and used in place of ...