Kinetica   C#   API  Version 7.2.3.1
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 
39 {
45  public struct Encoding
46  {
47  public const string BINARY = "binary";
48  public const string JSON = "json";
49  } // end struct Encoding
50 
53  public struct Options
54  {
56  public const string EXPRESSION = "expression";
57 
65  public const string SORT_BY = "sort_by";
66 
82  public const string SORT_ORDER = "sort_order";
83 
84  public const string ASCENDING = "ascending";
85  public const string DESCENDING = "descending";
86 
91  public const string ORDER_BY = "order_by";
92 
106  public const string CONVERT_WKTS_TO_WKBS = "convert_wkts_to_wkbs";
107 
108  public const string TRUE = "true";
109  public const string FALSE = "false";
110 
113  public const string ROUTE_TO_TOM = "route_to_tom";
114  } // end struct Options
115 
123  public string table_name { get; set; }
124 
126  public IList<string> column_names { get; set; } = new List<string>();
127 
132  public long offset { get; set; } = 0;
133 
146  public long limit { get; set; } = -9999;
147 
162  public string encoding { get; set; } = Encoding.BINARY;
163 
234  public IDictionary<string, string> options { get; set; } = new Dictionary<string, string>();
235 
239 
337  IList<string> column_names,
338  long? offset = null,
339  long? limit = null,
340  IDictionary<string, string> options = null)
341  {
342  this.table_name = table_name ?? "";
343  this.column_names = column_names ?? new List<string>();
344  this.offset = offset ?? 0;
345  this.limit = limit ?? -9999;
346  this.encoding = Encoding.BINARY;
347  this.options = options ?? new Dictionary<string, string>();
348  } // end constructor
349 
460  IList<string> column_names,
461  long? offset = null,
462  long? limit = null,
463  string encoding = null,
464  IDictionary<string, string> options = null)
465  {
466  this.table_name = table_name ?? "";
467  this.column_names = column_names ?? new List<string>();
468  this.offset = offset ?? 0;
469  this.limit = limit ?? -9999;
470  this.encoding = encoding ?? Encoding.BINARY;
471  this.options = options ?? new Dictionary<string, string>();
472  } // end full constructor
473 } // end class GetRecordsByColumnRequest
474 
479 {
482  public string table_name { get; set; }
483 
486  public string response_schema_str { get; set; }
487 
489  public byte[] binary_encoded_response { get; set; }
490 
492  public string json_encoded_response { get; set; }
493 
495  public long total_number_of_records { get; set; }
496 
499  public bool has_more_records { get; set; }
500 
502  public IDictionary<string, string> info { get; set; } = new Dictionary<string, string>();
503 } // end class RawGetRecordsByColumnResponse
504 
509 {
512  public string table_name { get; set; }
513 
515  public IList<KineticaRecord> data { get; set; } = new List<KineticaRecord>();
516 
518  public long total_number_of_records { get; set; }
519 
522  public bool has_more_records { get; set; }
523 
525  public IDictionary<string, string> info { get; set; } = new Dictionary<string, string>();
526 } // end class GetRecordsByColumnResponse
const string SORT_ORDER
String indicating how the returned values should be sorted
A set of results returned by Kinetica.getRecordsByColumn.
long total_number_of_records
Total/Filtered number of records.
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.
KineticaData - class to help with Avro Encoding for Kinetica
Definition: KineticaData.cs:14
long total_number_of_records
Total/Filtered number of records.
string encoding
Specifies the encoding for returned records; either BINARY or JSON.
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.
byte [] binary_encoded_response
Avro binary encoded response.
IDictionary< string, string > options
IDictionary< string, string > info
Additional information.
const string ROUTE_TO_TOM
For multihead record retrieval without shard key expression - specifies from which tom to retrieve da...
const string SORT_BY
Column that the data should be sorted by.
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.
const string EXPRESSION
Filter expression to apply to the table.
string table_name
The same table name as was passed in the parameter list.
A set of parameters for Kinetica.getRecordsByColumn.
A set of results returned by Kinetica.getRecordsByColumn.
IDictionary< string, string > info
Additional information.
A set of string constants for the parameter options.
IList< KineticaRecord > data
Avro binary encoded response.
string json_encoded_response
Avro JSON encoded response.
long limit
A positive integer indicating the maximum number of results to be returned, or END_OF_SET (-9999) to ...
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.
long offset
A positive integer indicating the number of initial results to skip (this can be useful for paging th...
bool has_more_records
Too many records.
bool has_more_records
Too many records.
const string ORDER_BY
Comma-separated list of the columns to be sorted by as well as the sort direction,...
const string CONVERT_WKTS_TO_WKBS
If TRUE, then WKT string columns will be returned as WKB bytes.