Kinetica   C#   API  Version 7.2.3.0
GetRecordsByColumn.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 {
40  {
46  public struct Encoding
47  {
48  public const string BINARY = "binary";
49  public const string JSON = "json";
50  } // end struct Encoding
51 
54  public struct Options
55  {
58  public const string EXPRESSION = "expression";
59 
68  public const string SORT_BY = "sort_by";
69 
86  public const string SORT_ORDER = "sort_order";
87 
88  public const string ASCENDING = "ascending";
89  public const string DESCENDING = "descending";
90 
95  public const string ORDER_BY = "order_by";
96 
110  public const string CONVERT_WKTS_TO_WKBS = "convert_wkts_to_wkbs";
111 
112  public const string TRUE = "true";
113  public const string FALSE = "false";
114 
118  public const string ROUTE_TO_TOM = "route_to_tom";
119  } // end struct Options
120 
128  public string table_name { get; set; }
129 
131  public IList<string> column_names { get; set; } = new List<string>();
132 
138  public long offset { get; set; } = 0;
139 
153  public long limit { get; set; } = -9999;
154 
169  public string encoding { get; set; } = Encoding.BINARY;
170 
245  public IDictionary<string, string> options { get; set; } = new Dictionary<string, string>();
246 
250 
354  IList<string> column_names,
355  long? offset = null,
356  long? limit = null,
357  IDictionary<string, string> options = null)
358  {
359  this.table_name = table_name ?? "";
360  this.column_names = column_names ?? new List<string>();
361  this.offset = offset ?? 0;
362  this.limit = limit ?? -9999;
363  this.encoding = Encoding.BINARY;
364  this.options = options ?? new Dictionary<string, string>();
365  } // end constructor
366 
484  IList<string> column_names,
485  long? offset = null,
486  long? limit = null,
487  string encoding = null,
488  IDictionary<string, string> options = null)
489  {
490  this.table_name = table_name ?? "";
491  this.column_names = column_names ?? new List<string>();
492  this.offset = offset ?? 0;
493  this.limit = limit ?? -9999;
494  this.encoding = encoding ?? Encoding.BINARY;
495  this.options = options ?? new Dictionary<string, string>();
496  } // end full constructor
497  } // end class GetRecordsByColumnRequest
498 
503  {
506  public string table_name { get; set; }
507 
510  public string response_schema_str { get; set; }
511 
513  public byte[] binary_encoded_response { get; set; }
514 
516  public string json_encoded_response { get; set; }
517 
519  public long total_number_of_records { get; set; }
520 
523  public bool has_more_records { get; set; }
524 
526  public IDictionary<string, string> info { get; set; } = new Dictionary<string, string>();
527  } // end class RawGetRecordsByColumnResponse
528 
533  {
536  public string table_name { get; set; }
537 
539  public IList<KineticaRecord> data { get; set; } = new List<KineticaRecord>();
540 
542  public long total_number_of_records { get; set; }
543 
546  public bool has_more_records { get; set; }
547 
549  public IDictionary<string, string> info { get; set; } = new Dictionary<string, string>();
550  } // end class GetRecordsByColumnResponse
551 } // end namespace kinetica
A set of results returned by Kinetica.getRecordsByColumn.
A set of string constants for the parameter options.
IDictionary< string, string > info
Additional information.
const string ORDER_BY
Comma-separated list of the columns to be sorted by as well as the sort direction,...
long total_number_of_records
Total/Filtered number of records.
IList< KineticaRecord > data
Avro binary encoded response.
GetRecordsByColumnRequest(string table_name, IList< string > column_names, long? offset=null, long? limit=null, IDictionary< string, string > options=null)
Constructs a GetRecordsByColumnRequest object with the specified parameters.
GetRecordsByColumnRequest()
Constructs a GetRecordsByColumnRequest object with default parameters.
string table_name
Name of the table or view on which this operation will be performed, in [schema_name.
A set of parameters for Kinetica.getRecordsByColumn.
byte [] binary_encoded_response
Avro binary encoded response.
const string SORT_ORDER
String indicating how the returned values should be sorted - ASCENDING or DESCENDING.
A set of results returned by Kinetica.getRecordsByColumn.
long limit
A positive integer indicating the maximum number of results to be returned, or END_OF_SET (-9999) to ...
long offset
A positive integer indicating the number of initial results to skip (this can be useful for paging th...
long total_number_of_records
Total/Filtered number of records.
string encoding
Specifies the encoding for returned records; either BINARY or JSON.
GetRecordsByColumnRequest(string table_name, IList< string > column_names, long? offset=null, long? limit=null, string encoding=null, IDictionary< string, string > options=null)
Constructs a GetRecordsByColumnRequest object with the specified parameters.
string json_encoded_response
Avro JSON encoded response.
IList< string > column_names
The list of column values to retrieve.
string response_schema_str
Avro schema of binary_encoded_response or json_encoded_response.
string table_name
The same table name as was passed in the parameter list.
A set of string constants for the parameter encoding.
const string CONVERT_WKTS_TO_WKBS
If TRUE, then WKT string columns will be returned as WKB bytes.
const string EXPRESSION
Optional filter expression to apply to the table.
KineticaData - class to help with Avro Encoding for Kinetica
Definition: KineticaData.cs:14
const string ROUTE_TO_TOM
For multihead record retrieval without shard key expression - specifies from which tom to retrieve da...
IDictionary< string, string > info
Additional information.
string table_name
The same table name as was passed in the parameter list.
const string SORT_BY
Optional column that the data should be sorted by.
IDictionary< string, string > options