Kinetica   C#   API  Version 7.2.3.1
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  {
45  public const string EXPRESSION = "expression";
46 
60  public const string FAST_INDEX_LOOKUP = "fast_index_lookup";
61 
62  public const string TRUE = "true";
63  public const string FALSE = "false";
64 
68  public const string SORT_BY = "sort_by";
69 
84  public const string SORT_ORDER = "sort_order";
85 
86  public const string ASCENDING = "ascending";
87  public const string DESCENDING = "descending";
88  } // end struct Options
89 
94  public string table_name { get; set; }
95 
100  public long offset { get; set; } = 0;
101 
114  public long limit { get; set; } = -9999;
115 
137  public string encoding { get; set; } = Encoding.BINARY;
138 
192  public IDictionary<string, string> options { get; set; } = new Dictionary<string, string>();
193 
196  public GetRecordsRequest() { }
197 
274  long? offset = null,
275  long? limit = null,
276  IDictionary<string, string> options = null)
277  {
278  this.table_name = table_name ?? "";
279  this.offset = offset ?? 0;
280  this.limit = limit ?? -9999;
281  this.encoding = Encoding.BINARY;
282  this.options = options ?? new Dictionary<string, string>();
283  } // end constructor
284 
381  long? offset = null,
382  long? limit = null,
383  string encoding = null,
384  IDictionary<string, string> options = null)
385  {
386  this.table_name = table_name ?? "";
387  this.offset = offset ?? 0;
388  this.limit = limit ?? -9999;
389  this.encoding = encoding ?? Encoding.BINARY;
390  this.options = options ?? new Dictionary<string, string>();
391  } // end full constructor
392 } // end class GetRecordsRequest
393 
398 {
401  public string table_name { get; set; }
402 
403  public string type_name { get; set; }
404 
407  public string type_schema { get; set; }
408 
412  public IList<byte[]> records_binary { get; set; } = new List<byte[]>();
413 
422  public IList<string> records_json { get; set; } = new List<string>();
423 
425  public long total_number_of_records { get; set; }
426 
429  public bool has_more_records { get; set; }
430 
432  public IDictionary<string, string> info { get; set; } = new Dictionary<string, string>();
433 } // end class RawGetRecordsResponse
434 
441 {
444  public string table_name { get; set; }
445 
446  public string type_name { get; set; }
447 
450  public string type_schema { get; set; }
451 
455  public IList<T> data { get; set; } = new List<T>();
456 
458  public long total_number_of_records { get; set; }
459 
462  public bool has_more_records { get; set; }
463 
465  public IDictionary<string, string> info { get; set; } = new Dictionary<string, string>();
466 } // end class GetRecordsResponse
const string FAST_INDEX_LOOKUP
Indicates if indexes should be used to perform the lookup for a given expression if possible.
Definition: GetRecords.cs:60
long total_number_of_records
Total/Filtered number of records.
Definition: GetRecords.cs:458
bool has_more_records
Too many records.
Definition: GetRecords.cs:429
long offset
A positive integer indicating the number of initial results to skip (this can be useful for paging th...
Definition: GetRecords.cs:100
GetRecordsRequest()
Constructs a GetRecordsRequest object with default parameters.
Definition: GetRecords.cs:196
IDictionary< string, string > info
Additional information.
Definition: GetRecords.cs:432
KineticaData - class to help with Avro Encoding for Kinetica
Definition: KineticaData.cs:14
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:380
const string SORT_BY
Column that the data should be sorted by.
Definition: GetRecords.cs:68
string table_name
Value of table_name.
Definition: GetRecords.cs:401
IList< T > data
If the encoding was 'binary', then this list contains the binary encoded records retrieved from the t...
Definition: GetRecords.cs:455
long total_number_of_records
Total/Filtered number of records.
Definition: GetRecords.cs:425
A set of string constants for the parameter options.
Definition: GetRecords.cs:42
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:273
IList< byte[]> records_binary
If the encoding was 'binary', then this list contains the binary encoded records retrieved from the t...
Definition: GetRecords.cs:412
string encoding
Specifies the encoding for returned records; one of BINARY, JSON, or GEOJSON.
Definition: GetRecords.cs:137
string type_schema
Avro schema of records_binary or records_json.
Definition: GetRecords.cs:407
bool has_more_records
Too many records.
Definition: GetRecords.cs:462
A set of results returned by Kinetica.getRecords.
Definition: GetRecords.cs:397
string table_name
Name of the table or view from which the records will be fetched, in [schema_name.
Definition: GetRecords.cs:94
const string EXPRESSION
Filter expression to apply to the table.
Definition: GetRecords.cs:45
long limit
A positive integer indicating the maximum number of results to be returned, or END_OF_SET (-9999) to ...
Definition: GetRecords.cs:114
string table_name
Value of table_name.
Definition: GetRecords.cs:444
A set of parameters for Kinetica.getRecords.
Definition: GetRecords.cs:24
const string ASCENDING
Definition: GetRecords.cs:86
A set of results returned by Kinetica.getRecords.
Definition: GetRecords.cs:440
IDictionary< string, string > options
Definition: GetRecords.cs:192
const string DESCENDING
Definition: GetRecords.cs:87
IList< string > records_json
If the encoding was 'json', then this list contains the JSON encoded records retrieved from the table...
Definition: GetRecords.cs:422
A set of string constants for the parameter encoding.
Definition: GetRecords.cs:32
string type_schema
Avro schema of data or records_json.
Definition: GetRecords.cs:450
IDictionary< string, string > info
Additional information.
Definition: GetRecords.cs:465
const string SORT_ORDER
String indicating how the returned values should be sorted
Definition: GetRecords.cs:84