Kinetica C# API  Version 7.1.10.0
 All Classes Namespaces Files Functions Variables Enumerations Enumerator Properties Pages
AggregateGroupBy.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 
87  {
88 
109  public struct Encoding
110  {
111 
114  public const string BINARY = "binary";
115 
118  public const string JSON = "json";
119  } // end struct Encoding
120 
121 
369  public struct Options
370  {
371 
392  public const string CREATE_TEMP_TABLE = "create_temp_table";
393  public const string TRUE = "true";
394  public const string FALSE = "false";
395 
403  public const string COLLECTION_NAME = "collection_name";
404 
407  public const string EXPRESSION = "expression";
408 
411  public const string HAVING = "having";
412 
432  public const string SORT_ORDER = "sort_order";
433 
436  public const string ASCENDING = "ascending";
437 
440  public const string DESCENDING = "descending";
441 
466  public const string SORT_BY = "sort_by";
467 
473  public const string KEY = "key";
474 
480  public const string VALUE = "value";
481 
485  public const string STRATEGY_DEFINITION = "strategy_definition";
486 
498  public const string RESULT_TABLE = "result_table";
499 
518  public const string RESULT_TABLE_PERSIST = "result_table_persist";
519 
536  public const string RESULT_TABLE_FORCE_REPLICATED = "result_table_force_replicated";
537 
554  public const string RESULT_TABLE_GENERATE_PK = "result_table_generate_pk";
555 
559  public const string TTL = "ttl";
560 
564  public const string CHUNK_SIZE = "chunk_size";
565 
569  public const string CREATE_INDEXES = "create_indexes";
570 
573  public const string VIEW_ID = "view_id";
574 
576  public const string PIVOT = "pivot";
577 
581  public const string PIVOT_VALUES = "pivot_values";
582 
588  public const string GROUPING_SETS = "grouping_sets";
589 
592  public const string ROLLUP = "rollup";
593 
596  public const string CUBE = "cube";
597  } // end struct Options
598 
599 
604  public string table_name { get; set; }
605 
608  public IList<string> column_names { get; set; } = new List<string>();
609 
614  public long offset { get; set; } = 0;
615 
630  public long limit { get; set; } = -9999;
631 
651  public string encoding { get; set; } = Encoding.BINARY;
652 
898  public IDictionary<string, string> options { get; set; } = new Dictionary<string, string>();
899 
900 
904 
1180  IList<string> column_names,
1181  long? offset = null,
1182  long? limit = null,
1183  IDictionary<string, string> options = null)
1184  {
1185  this.table_name = table_name ?? "";
1186  this.column_names = column_names ?? new List<string>();
1187  this.offset = offset ?? 0;
1188  this.limit = limit ?? -9999;
1189  this.encoding = Encoding.BINARY;
1190  this.options = options ?? new Dictionary<string, string>();
1191  } // end constructor
1192 
1193 
1488  IList<string> column_names,
1489  long? offset = null,
1490  long? limit = null,
1491  string encoding = null,
1492  IDictionary<string, string> options = null)
1493  {
1494  this.table_name = table_name ?? "";
1495  this.column_names = column_names ?? new List<string>();
1496  this.offset = offset ?? 0;
1497  this.limit = limit ?? -9999;
1498  this.encoding = encoding ?? Encoding.BINARY;
1499  this.options = options ?? new Dictionary<string, string>();
1500  } // end full constructor
1501 
1502  } // end class AggregateGroupByRequest
1503 
1504 
1505 
1510  {
1511 
1524  public struct Info
1525  {
1526 
1529  public const string QUALIFIED_RESULT_TABLE_NAME = "qualified_result_table_name";
1530  } // end struct Info
1531 
1532 
1535  public string response_schema_str { get; set; }
1536 
1538  public byte[] binary_encoded_response { get; set; }
1539 
1541  public string json_encoded_response { get; set; }
1542 
1544  public long total_number_of_records { get; set; }
1545 
1547  public bool has_more_records { get; set; }
1548 
1559  public IDictionary<string, string> info { get; set; } = new Dictionary<string, string>();
1560 
1561  } // end class RawAggregateGroupByResponse
1562 
1563 
1564 
1569  {
1570 
1583  public struct Info
1584  {
1585 
1588  public const string QUALIFIED_RESULT_TABLE_NAME = "qualified_result_table_name";
1589  } // end struct Info
1590 
1591 
1593  public IList<KineticaRecord> data { get; set; } = new List<KineticaRecord>();
1594 
1596  public long total_number_of_records { get; set; }
1597 
1599  public bool has_more_records { get; set; }
1600 
1611  public IDictionary<string, string> info { get; set; } = new Dictionary<string, string>();
1612 
1613  } // end class AggregateGroupByResponse
1614 
1615 
1616 
1617 
1618 } // end namespace kinetica
AggregateGroupByRequest(string table_name, IList< string > column_names, long?offset=null, long?limit=null, string encoding=null, IDictionary< string, string > options=null)
Constructs an AggregateGroupByRequest object with the specified parameters.
Specifies the encoding for returned records.
long total_number_of_records
Total/Filtered number of records.
const string TTL
Sets the TTL of the table specified in result_table.
A set of results returned by Kinetica.aggregateGroupBy(string,IList{string},long,long,IDictionary{string, string}).
bool has_more_records
Too many records. Returned a partial set.
const string RESULT_TABLE_FORCE_REPLICATED
Force the result table to be replicated (ignores any sharding).
const string CUBE
This option is used to specify the multidimensional aggregates.
AggregateGroupByRequest()
Constructs an AggregateGroupByRequest object with default parameters.
AggregateGroupByRequest(string table_name, IList< string > column_names, long?offset=null, long?limit=null, IDictionary< string, string > options=null)
Constructs an AggregateGroupByRequest object with the specified parameters.
const string QUALIFIED_RESULT_TABLE_NAME
The fully qualified name of the table (i.e.
const string BINARY
Indicates that the returned records should be binary encoded.
const string KEY
Indicates that the returned values should be sorted by key, which corresponds to the grouping columns...
long offset
A positive integer indicating the number of initial results to skip (this can be useful for paging th...
IList< KineticaRecord > data
Avro binary encoded response.
const string QUALIFIED_RESULT_TABLE_NAME
The fully qualified name of the table (i.e.
const string VALUE
Indicates that the returned values should be sorted by value, which corresponds to the aggregates...
IDictionary< string, string > options
Optional parameters.
const string DESCENDING
Indicates that the returned values should be sorted in descending order.
IDictionary< string, string > info
Additional information.
long total_number_of_records
Total/Filtered number of records.
const string SORT_ORDER
String indicating how the returned values should be sorted - ascending or descending.
bool has_more_records
Too many records. Returned a partial set.
const string EXPRESSION
Filter expression to apply to the table prior to computing the aggregate group by.
string json_encoded_response
Avro JSON encoded response.
IList< string > column_names
List of one or more column names, expressions, and aggregate expressions.
const string ASCENDING
Indicates that the returned values should be sorted in ascending order.
const string STRATEGY_DEFINITION
The tier strategy for the table and its columns.
byte[] binary_encoded_response
Avro binary encoded response.
const string CHUNK_SIZE
Indicates the number of records per chunk to be used for the result table.
A set of results returned by Kinetica.aggregateGroupBy(string,IList{string},long,long,IDictionary{string, string}).
const string JSON
Indicates that the returned records should be json encoded.
const string HAVING
Filter expression to apply to the aggregated results.
const string SORT_BY
String determining how the results are sorted.
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 ...
const string VIEW_ID
ID of view of which the result table will be a member.
string encoding
Specifies the encoding for returned records.
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 RESULT_TABLE_GENERATE_PK
If true then set a primary key for the result table.
string table_name
Name of an existing table or view on which the operation will be performed, in [schema_name.
KineticaData - class to help with Avro Encoding for Kinetica
Definition: KineticaData.cs:14
IDictionary< string, string > info
Additional information.
long limit
A positive integer indicating the maximum number of results to be returned, or END_OF_SET (-9999) to ...
const string ROLLUP
This option is used to specify the multilevel aggregates.
const string RESULT_TABLE
The name of a table used to store the results, in [schema_name.
const string GROUPING_SETS
Customize the grouping attribute sets to compute the aggregates.
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;.
const string PIVOT_VALUES
The value list provided will become the column headers in the output.
const string CREATE_INDEXES
Comma-separated list of columns on which to create indexes on the result table.
A set of parameters for Kinetica.aggregateGroupBy(string,IList{string},long,long,IDictionary{string, string}).
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.