Kinetica C# API  Version 6.2.0.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 
10 
11 namespace kinetica
12 {
13 
31  {
32 
53  public struct Encoding
54  {
55  public const string BINARY = "binary";
56  public const string JSON = "json";
57  public const string GEOJSON = "geojson";
58  } // end struct Encoding
59 
60 
121  public struct Options
122  {
123 
126  public const string EXPRESSION = "expression";
127 
146  public const string FAST_INDEX_LOOKUP = "fast_index_lookup";
147  public const string TRUE = "true";
148  public const string FALSE = "false";
149 
152  public const string SORT_BY = "sort_by";
153 
170  public const string SORT_ORDER = "sort_order";
171  public const string ASCENDING = "ascending";
172  public const string DESCENDING = "descending";
173  } // end struct Options
174 
175 
178  public string table_name { get; set; }
179 
184  public long offset { get; set; } = 0;
185 
190  public long limit { get; set; } = 10000;
191 
210  public string encoding { get; set; } = Encoding.BINARY;
211 
270  public IDictionary<string, string> options { get; set; } = new Dictionary<string, string>();
271 
272 
275  public GetRecordsRequest() { }
276 
351  long? offset = null,
352  long? limit = null,
353  IDictionary<string, string> options = null)
354  {
355  this.table_name = table_name ?? "";
356  this.offset = offset ?? 0;
357  this.limit = limit ?? 10000;
358  this.encoding = Encoding.BINARY;
359  this.options = options ?? new Dictionary<string, string>();
360  } // end constructor
361 
362 
455  long? offset = null,
456  long? limit = null,
457  string encoding = null,
458  IDictionary<string, string> options = null)
459  {
460  this.table_name = table_name ?? "";
461  this.offset = offset ?? 0;
462  this.limit = limit ?? 10000;
463  this.encoding = encoding ?? Encoding.BINARY;
464  this.options = options ?? new Dictionary<string, string>();
465  } // end full constructor
466 
467  } // end class GetRecordsRequest
468 
469 
470 
475  {
476 
479  public string table_name { get; set; }
480  public string type_name { get; set; }
481 
484  public string type_schema { get; set; }
485 
489  public IList<byte[]> records_binary { get; set; } = new List<byte[]>();
490 
497  public IList<string> records_json { get; set; } = new List<string>();
498 
500  public long total_number_of_records { get; set; }
501 
503  public bool has_more_records { get; set; }
504 
505  } // end class RawGetRecordsResponse
506 
507 
508 
516  {
517 
520  public string table_name { get; set; }
521  public string type_name { get; set; }
522 
525  public string type_schema { get; set; }
526 
530  public IList<T> data { get; set; } = new List<T>();
531 
533  public long total_number_of_records { get; set; }
534 
536  public bool has_more_records { get; set; }
537 
538  } // end class GetRecordsResponse
539 
540 
541 
542 
543 } // end namespace kinetica
string table_name
Name of the table from which the records will be fetched.
Definition: GetRecords.cs:178
A set of results returned by Kinetica.getRecords<T>(string,long,long,IDictionary<string, string>).
Definition: GetRecords.cs:474
GetRecordsRequest()
Constructs a GetRecordsRequest object with default parameters.
Definition: GetRecords.cs:275
IDictionary< string, string > options
EXPRESSION: Optional filter expression to apply to the table.
Definition: GetRecords.cs:270
A set of parameters for Kinetica.getRecords<T>(string,long,long,IDictionary<string, string>).
Definition: GetRecords.cs:30
EXPRESSION: Optional filter expression to apply to the table.
Definition: GetRecords.cs:121
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:454
string encoding
Specifies the encoding for returned records.
Definition: GetRecords.cs:210
KineticaData - class to help with Avro Encoding for Kinetica
Definition: KineticaData.cs:14
Specifies the encoding for returned records.
Definition: GetRecords.cs:53
long limit
A positive integer indicating the maximum number of results to be returned.
Definition: GetRecords.cs:190
A set of results returned by Kinetica.getRecords<T>(string,long,long,IDictionary<string, string>).
Definition: GetRecords.cs:515
long offset
A positive integer indicating the number of initial results to skip (this can be useful for paging th...
Definition: GetRecords.cs:184
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:350