Kinetica C# API  Version 7.1.10.0
 All Classes Namespaces Files Functions Variables Enumerations Enumerator Properties Pages
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 
10 
11 namespace kinetica
12 {
13 
57  {
58 
76  public struct Encoding
77  {
78  public const string BINARY = "binary";
79  public const string JSON = "json";
80  } // end struct Encoding
81 
82 
149  public struct Options
150  {
151 
154  public const string EXPRESSION = "expression";
155 
160  public const string SORT_BY = "sort_by";
161 
179  public const string SORT_ORDER = "sort_order";
180  public const string ASCENDING = "ascending";
181  public const string DESCENDING = "descending";
182 
186  public const string ORDER_BY = "order_by";
187 
203  public const string CONVERT_WKTS_TO_WKBS = "convert_wkts_to_wkbs";
204  public const string TRUE = "true";
205  public const string FALSE = "false";
206  } // end struct Options
207 
208 
215  public string table_name { get; set; }
216 
218  public IList<string> column_names { get; set; } = new List<string>();
219 
224  public long offset { get; set; } = 0;
225 
240  public long limit { get; set; } = -9999;
241 
258  public string encoding { get; set; } = Encoding.BINARY;
259 
324  public IDictionary<string, string> options { get; set; } = new Dictionary<string, string>();
325 
326 
330 
427  IList<string> column_names,
428  long? offset = null,
429  long? limit = null,
430  IDictionary<string, string> options = null)
431  {
432  this.table_name = table_name ?? "";
433  this.column_names = column_names ?? new List<string>();
434  this.offset = offset ?? 0;
435  this.limit = limit ?? -9999;
436  this.encoding = Encoding.BINARY;
437  this.options = options ?? new Dictionary<string, string>();
438  } // end constructor
439 
440 
553  IList<string> column_names,
554  long? offset = null,
555  long? limit = null,
556  string encoding = null,
557  IDictionary<string, string> options = null)
558  {
559  this.table_name = table_name ?? "";
560  this.column_names = column_names ?? new List<string>();
561  this.offset = offset ?? 0;
562  this.limit = limit ?? -9999;
563  this.encoding = encoding ?? Encoding.BINARY;
564  this.options = options ?? new Dictionary<string, string>();
565  } // end full constructor
566 
567  } // end class GetRecordsByColumnRequest
568 
569 
570 
575  {
576 
579  public string table_name { get; set; }
580 
583  public string response_schema_str { get; set; }
584 
586  public byte[] binary_encoded_response { get; set; }
587 
589  public string json_encoded_response { get; set; }
590 
592  public long total_number_of_records { get; set; }
593 
595  public bool has_more_records { get; set; }
596 
598  public IDictionary<string, string> info { get; set; } = new Dictionary<string, string>();
599 
600  } // end class RawGetRecordsByColumnResponse
601 
602 
603 
608  {
609 
612  public string table_name { get; set; }
613 
615  public IList<KineticaRecord> data { get; set; } = new List<KineticaRecord>();
616 
618  public long total_number_of_records { get; set; }
619 
621  public bool has_more_records { get; set; }
622 
624  public IDictionary<string, string> info { get; set; } = new Dictionary<string, string>();
625 
626  } // end class GetRecordsByColumnResponse
627 
628 
629 
630 
631 } // end namespace kinetica
A set of results returned by Kinetica.getRecordsByColumn(string,IList{string},long,long,IDictionary{string, string}).
EXPRESSION: Optional filter expression to apply to the table.
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, e.g., &#39;timestamp asc, x desc&#39;.
long total_number_of_records
Total/Filtered number of records.
bool has_more_records
Too many records. Returned a partial set.
IList< KineticaRecord > data
Avro binary encoded response.
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(string,IList{string},long,long,IDictionary{string, string}).
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(string,IList{string},long,long,IDictionary{string, string}).
long limit
A positive integer indicating the maximum number of results to be returned, or END_OF_SET (-9999) to ...
bool has_more_records
Too many records. Returned a partial set.
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 &lt;member name=&quot;binary_encoded_response&quot;&gt; or &lt;member name=&quot;json_encoded_response&quot;&gt;.
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.
string table_name
The same table name as was passed in the parameter list.
Specifies the encoding for returned records; either binary or json.
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
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
EXPRESSION: Optional filter expression to apply to the table.