Kinetica   C#   API  Version 7.2.3.0
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 namespace kinetica
10 {
22  public class FilterRequest : KineticaData
23  {
27  public struct Options
28  {
43  public const string CREATE_TEMP_TABLE = "create_temp_table";
44 
45  public const string TRUE = "true";
46  public const string FALSE = "false";
47 
55  public const string COLLECTION_NAME = "collection_name";
56 
59  public const string VIEW_ID = "view_id";
60 
64  public const string TTL = "ttl";
65  } // end struct Options
66 
73  public string table_name { get; set; }
74 
83  public string view_name { get; set; } = "";
84 
90  public string expression { get; set; }
91 
142  public IDictionary<string, string> options { get; set; } = new Dictionary<string, string>();
143 
146  public FilterRequest() { }
147 
218  public FilterRequest( string table_name,
219  string view_name,
220  string expression,
221  IDictionary<string, string> options = null)
222  {
223  this.table_name = table_name ?? "";
224  this.view_name = view_name ?? "";
225  this.expression = expression ?? "";
226  this.options = options ?? new Dictionary<string, string>();
227  } // end constructor
228  } // end class FilterRequest
229 
233  {
237  public struct Info
238  {
241  public const string QUALIFIED_VIEW_NAME = "qualified_view_name";
242  } // end struct Info
243 
246  public long count { get; set; }
247 
259  public IDictionary<string, string> info { get; set; } = new Dictionary<string, string>();
260  } // end class FilterResponse
261 } // 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:55
FilterRequest()
Constructs a FilterRequest object with default parameters.
Definition: Filter.cs:146
A set of string constants for the parameter options.
Definition: Filter.cs:27
string view_name
If provided, then this will be the name of the view containing the results, in [schema_name.
Definition: Filter.cs:83
const string VIEW_ID
view this filtered-view is part of.
Definition: Filter.cs:59
IDictionary< string, string > options
Optional parameters.
Definition: Filter.cs:142
const string QUALIFIED_VIEW_NAME
The fully qualified name of the view (i.e.
Definition: Filter.cs:241
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:218
const string TTL
Sets the TTL of the view specified in view_name.
Definition: Filter.cs:64
IDictionary< string, string > info
Additional information.
Definition: Filter.cs:259
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:43
A set of parameters for Kinetica.filter.
Definition: Filter.cs:22
A set of results returned by Kinetica.filter.
Definition: Filter.cs:232
long count
The number of records that matched the given select expression.
Definition: Filter.cs:246
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:90
A set of string constants for the parameter info.
Definition: Filter.cs:237
string table_name
Name of the table to filter, in [schema_name.
Definition: Filter.cs:73