Kinetica C# API  Version 7.1.10.0
 All Classes Namespaces Files Functions Variables Enumerations Enumerator Properties Pages
Filter.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 
30  public class FilterRequest : KineticaData
31  {
32 
84  public struct Options
85  {
86 
105  public const string CREATE_TEMP_TABLE = "create_temp_table";
106  public const string TRUE = "true";
107  public const string FALSE = "false";
108 
115  public const string COLLECTION_NAME = "collection_name";
116 
119  public const string VIEW_ID = "view_id";
120 
124  public const string TTL = "ttl";
125  } // end struct Options
126 
127 
133  public string table_name { get; set; }
134 
142  public string view_name { get; set; } = "";
143 
147  public string expression { get; set; }
148 
198  public IDictionary<string, string> options { get; set; } = new Dictionary<string, string>();
199 
200 
203  public FilterRequest() { }
204 
275  public FilterRequest( string table_name,
276  string view_name,
277  string expression,
278  IDictionary<string, string> options = null)
279  {
280  this.table_name = table_name ?? "";
281  this.view_name = view_name ?? "";
282  this.expression = expression ?? "";
283  this.options = options ?? new Dictionary<string, string>();
284  } // end constructor
285 
286  } // end class FilterRequest
287 
288 
289 
294  {
295 
308  public struct Info
309  {
310 
313  public const string QUALIFIED_VIEW_NAME = "qualified_view_name";
314  } // end struct Info
315 
316 
319  public long count { get; set; }
320 
331  public IDictionary<string, string> info { get; set; } = new Dictionary<string, string>();
332 
333  } // end class FilterResponse
334 
335 
336 
337 
338 } // end namespace kinetica
const string COLLECTION_NAME
[DEPRECATED–please specify the containing schema for the view as part of view_name and use Kinetica...
Definition: Filter.cs:115
FilterRequest()
Constructs a FilterRequest object with default parameters.
Definition: Filter.cs:203
Optional parameters.
Definition: Filter.cs:84
string view_name
If provided, then this will be the name of the view containing the results, in [schema_name.
Definition: Filter.cs:142
const string VIEW_ID
view this filtered-view is part of.
Definition: Filter.cs:119
IDictionary< string, string > options
Optional parameters.
Definition: Filter.cs:198
const string QUALIFIED_VIEW_NAME
The fully qualified name of the view (i.e.
Definition: Filter.cs:313
FilterRequest(string table_name, string view_name, string expression, IDictionary< string, string > options=null)
Constructs a FilterRequest object with the specified parameters.
Definition: Filter.cs:275
const string TTL
Sets the TTL of the view specified in view_name.
Definition: Filter.cs:124
IDictionary< string, string > info
Additional information.
Definition: Filter.cs:331
const string CREATE_TEMP_TABLE
If true, a unique temporary table name will be generated in the sys_temp schema and used in place of ...
Definition: Filter.cs:105
A set of parameters for Kinetica.filter(string,string,string,IDictionary{string, string}).
Definition: Filter.cs:30
A set of results returned by Kinetica.filter(string,string,string,IDictionary{string, string}).
Definition: Filter.cs:293
long count
The number of records that matched the given select expression.
Definition: Filter.cs:319
KineticaData - class to help with Avro Encoding for Kinetica
Definition: KineticaData.cs:14
string expression
The select expression to filter the specified table.
Definition: Filter.cs:147
Additional information.
Definition: Filter.cs:308
string table_name
Name of the table to filter, in [schema_name.
Definition: Filter.cs:133