Kinetica   C#   API  Version 7.2.3.0
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 namespace kinetica
10 {
25  {
32  public struct Encoding
33  {
34  public const string BINARY = "binary";
35  public const string JSON = "json";
36  public const string GEOJSON = "geojson";
37  public const string ARROW = "arrow";
38  } // end struct Encoding
39 
42  public struct Options
43  {
46  public const string EXPRESSION = "expression";
47 
61  public const string FAST_INDEX_LOOKUP = "fast_index_lookup";
62 
63  public const string TRUE = "true";
64  public const string FALSE = "false";
65 
70  public const string SORT_BY = "sort_by";
71 
87  public const string SORT_ORDER = "sort_order";
88 
89  public const string ASCENDING = "ascending";
90  public const string DESCENDING = "descending";
91  } // end struct Options
92 
97  public string table_name { get; set; }
98 
104  public long offset { get; set; } = 0;
105 
119  public long limit { get; set; } = -9999;
120 
142  public string encoding { get; set; } = Encoding.BINARY;
143 
201  public IDictionary<string, string> options { get; set; } = new Dictionary<string, string>();
202 
205  public GetRecordsRequest() { }
206 
288  long? offset = null,
289  long? limit = null,
290  IDictionary<string, string> options = null)
291  {
292  this.table_name = table_name ?? "";
293  this.offset = offset ?? 0;
294  this.limit = limit ?? -9999;
295  this.encoding = Encoding.BINARY;
296  this.options = options ?? new Dictionary<string, string>();
297  } // end constructor
298 
401  long? offset = null,
402  long? limit = null,
403  string encoding = null,
404  IDictionary<string, string> options = null)
405  {
406  this.table_name = table_name ?? "";
407  this.offset = offset ?? 0;
408  this.limit = limit ?? -9999;
409  this.encoding = encoding ?? Encoding.BINARY;
410  this.options = options ?? new Dictionary<string, string>();
411  } // end full constructor
412  } // end class GetRecordsRequest
413 
418  {
421  public string table_name { get; set; }
422 
423  public string type_name { get; set; }
424 
427  public string type_schema { get; set; }
428 
433  public IList<byte[]> records_binary { get; set; } = new List<byte[]>();
434 
444  public IList<string> records_json { get; set; } = new List<string>();
445 
447  public long total_number_of_records { get; set; }
448 
451  public bool has_more_records { get; set; }
452 
454  public IDictionary<string, string> info { get; set; } = new Dictionary<string, string>();
455  } // end class RawGetRecordsResponse
456 
463  {
466  public string table_name { get; set; }
467 
468  public string type_name { get; set; }
469 
472  public string type_schema { get; set; }
473 
478  public IList<T> data { get; set; } = new List<T>();
479 
481  public long total_number_of_records { get; set; }
482 
485  public bool has_more_records { get; set; }
486 
488  public IDictionary<string, string> info { get; set; } = new Dictionary<string, string>();
489  } // end class GetRecordsResponse
490 } // end namespace kinetica
IList< byte[]> records_binary
If the encoding was 'binary', then this list contains the binary encoded records retrieved from the t...
Definition: GetRecords.cs:433
const string SORT_ORDER
String indicating how the returned values should be sorted - ascending or descending.
Definition: GetRecords.cs:87
const string FAST_INDEX_LOOKUP
Indicates if indexes should be used to perform the lookup for a given expression if possible.
Definition: GetRecords.cs:61
string table_name
Name of the table or view from which the records will be fetched, in [schema_name.
Definition: GetRecords.cs:97
A set of results returned by Kinetica.getRecords.
Definition: GetRecords.cs:417
bool has_more_records
Too many records.
Definition: GetRecords.cs:485
const string SORT_BY
Optional column that the data should be sorted by.
Definition: GetRecords.cs:70
string table_name
Value of table_name.
Definition: GetRecords.cs:466
const string EXPRESSION
Optional filter expression to apply to the table.
Definition: GetRecords.cs:46
IDictionary< string, string > info
Additional information.
Definition: GetRecords.cs:488
GetRecordsRequest()
Constructs a GetRecordsRequest object with default parameters.
Definition: GetRecords.cs:205
long total_number_of_records
Total/Filtered number of records.
Definition: GetRecords.cs:447
IDictionary< string, string > options
Definition: GetRecords.cs:201
IList< T > data
If the encoding was 'binary', then this list contains the binary encoded records retrieved from the t...
Definition: GetRecords.cs:478
IList< string > records_json
If the encoding was 'json', then this list contains the JSON encoded records retrieved from the table...
Definition: GetRecords.cs:444
A set of parameters for Kinetica.getRecords.
Definition: GetRecords.cs:24
string type_schema
Avro schema of data or records_json
Definition: GetRecords.cs:472
string type_schema
Avro schema of records_binary or records_json
Definition: GetRecords.cs:427
A set of string constants for the parameter options.
Definition: GetRecords.cs:42
bool has_more_records
Too many records.
Definition: GetRecords.cs:451
string table_name
Value of table_name.
Definition: GetRecords.cs:421
long total_number_of_records
Total/Filtered number of records.
Definition: GetRecords.cs:481
GetRecordsRequest(string table_name, long? offset=null, long? limit=null, string encoding=null, IDictionary< string, string > options=null)
Constructs a GetRecordsRequest object with the specified parameters.
Definition: GetRecords.cs:400
string encoding
Specifies the encoding for returned records; one of BINARY, JSON, or GEOJSON.
Definition: GetRecords.cs:142
KineticaData - class to help with Avro Encoding for Kinetica
Definition: KineticaData.cs:14
A set of string constants for the parameter encoding.
Definition: GetRecords.cs:32
long limit
A positive integer indicating the maximum number of results to be returned, or END_OF_SET (-9999) to ...
Definition: GetRecords.cs:119
A set of results returned by Kinetica.getRecords.
Definition: GetRecords.cs:462
long offset
A positive integer indicating the number of initial results to skip (this can be useful for paging th...
Definition: GetRecords.cs:104
IDictionary< string, string > info
Additional information.
Definition: GetRecords.cs:454
GetRecordsRequest(string table_name, long? offset=null, long? limit=null, IDictionary< string, string > options=null)
Constructs a GetRecordsRequest object with the specified parameters.
Definition: GetRecords.cs:287