Kinetica C# API  Version 6.0.1.0
 All Classes Namespaces Files Functions Variables Enumerations Enumerator Properties Pages
GetRecords.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 
29  {
30 
36  public struct Encoding
37  {
38  public const string BINARY = "binary";
39  public const string JSON = "json";
40  } // end struct Encoding
41 
42 
76  public struct Options
77  {
78 
81  public const string EXPRESSION = "expression";
82 
89  public const string FAST_INDEX_LOOKUP = "fast_index_lookup";
90 
93  public const string SORT_BY = "sort_by";
94 
99  public const string SORT_ORDER = "sort_order";
100  public const string ASCENDING = "ascending";
101  public const string DESCENDING = "descending";
102  } // end struct Options
103 
104 
107  public string table_name { get; set; }
108 
113  public long offset { get; set; } = 0;
114 
118  public long limit { get; set; } = 10000;
119 
123  public string encoding { get; set; } = Encoding.BINARY;
124 
156  public IDictionary<string, string> options { get; set; } = new Dictionary<string, string>();
157 
158 
161  public GetRecordsRequest() { }
162 
209  long offset = 0,
210  long limit = 10000,
211  IDictionary<string, string> options = null)
212  {
213  this.table_name = table_name ?? "";
214  this.offset = offset;
215  this.limit = limit;
216  this.encoding = Encoding.BINARY;
217  this.options = options ?? new Dictionary<string, string>();
218  } // end constructor
219 
220 
270  long offset = 0,
271  long limit = 10000,
272  string encoding = null,
273  IDictionary<string, string> options = null)
274  {
275  this.table_name = table_name ?? "";
276  this.offset = offset;
277  this.limit = limit;
278  this.encoding = encoding ?? Encoding.BINARY;
279  this.options = options ?? new Dictionary<string, string>();
280  } // end full constructor
281 
282  } // end class GetRecordsRequest
283 
284 
285 
288  {
289 
292  public string table_name { get; set; }
293  public string type_name { get; set; }
294 
297  public string type_schema { get; set; }
298 
302  public IList<byte[]> records_binary { get; set; } = new List<byte[]>();
303 
307  public IList<string> records_json { get; set; } = new List<string>();
308 
310  public long total_number_of_records { get; set; }
311 
313  public bool has_more_records { get; set; }
314 
315  } // end class RawGetRecordsResponse
316 
317 
318 
323  public class GetRecordsResponse<T> : KineticaData
324  {
325 
328  public string table_name { get; set; }
329  public string type_name { get; set; }
330 
333  public string type_schema { get; set; }
334 
338  public IList<T> data { get; set; } = new List<T>();
339 
341  public long total_number_of_records { get; set; }
342 
344  public bool has_more_records { get; set; }
345 
346  } // end class GetRecordsResponse
347 
348 
349 
350 
351 } // end namespace kinetica
IList< byte[]> records_binary
If the was &#39;binary&#39;, then this list contains the JSON encoded records retrieved from the set...
Definition: GetRecords.cs:302
const string SORT_ORDER
String indicating how the returned values should be sorted - ascending or descending.
Definition: GetRecords.cs:99
const string FAST_INDEX_LOOKUP
Indicates if indexes should be used to perform the lookup for a given expression if possible...
Definition: GetRecords.cs:89
string table_name
Name of the table from which the records will be fetched.
Definition: GetRecords.cs:107
A set of results returned by /get/records.
Definition: GetRecords.cs:287
const string SORT_BY
Optional column that the data should be sorted by.
Definition: GetRecords.cs:93
const string EXPRESSION
Optional filter expression to apply to the table.
Definition: GetRecords.cs:81
GetRecordsRequest()
Constructs a GetRecordsRequest object with default parameters.
Definition: GetRecords.cs:161
long total_number_of_records
Total/Filtered number of records.
Definition: GetRecords.cs:310
IDictionary< string, string > options
expression Optional filter expression to apply to the table.
Definition: GetRecords.cs:156
GetRecordsRequest(string table_name, long offset=0, long limit=10000, string encoding=null, IDictionary< string, string > options=null)
Constructs a GetRecordsRequest object with the specified parameters.
Definition: GetRecords.cs:269
IList< string > records_json
If the was &#39;json&#39;, then this list contains the JSON encoded records retrieved from the set...
Definition: GetRecords.cs:307
A set of parameters for /get/records.
Definition: GetRecords.cs:28
string type_schema
Avro schema of &lt;member name=&quot;records_binary&quot;&gt; or &lt;member name=&quot;records_json&quot;&gt;
Definition: GetRecords.cs:297
expression Optional filter expression to apply to the table.
Definition: GetRecords.cs:76
bool has_more_records
Too many records. Returned a partial set.
Definition: GetRecords.cs:313
GetRecordsRequest(string table_name, long offset=0, long limit=10000, IDictionary< string, string > options=null)
Constructs a GetRecordsRequest object with the specified parameters.
Definition: GetRecords.cs:208
string table_name
Value of .
Definition: GetRecords.cs:292
string encoding
Specifies the encoding for returned records.
Definition: GetRecords.cs:123
KineticaData - class to help with Avro Encoding for Kinetica
Definition: KineticaData.cs:14
Specifies the encoding for returned records.
Definition: GetRecords.cs:36
long limit
A positive integer indicating the maximum number of results to be returned.
Definition: GetRecords.cs:118
long offset
A positive integer indicating the number of initial results to skip (this can be useful for paging th...
Definition: GetRecords.cs:113