Kinetica C# API  Version 7.1.10.0
 All Classes Namespaces Files Functions Variables Enumerations Enumerator Properties Pages
FilterByString.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 
26  {
27 
70  public struct Mode
71  {
72 
77  public const string SEARCH = "search";
78 
80  public const string EQUALS = "equals";
81 
85  public const string CONTAINS = "contains";
86 
90  public const string STARTS_WITH = "starts_with";
91 
95  public const string REGEX = "regex";
96  } // end struct Mode
97 
98 
157  public struct Options
158  {
159 
178  public const string CREATE_TEMP_TABLE = "create_temp_table";
179  public const string TRUE = "true";
180  public const string FALSE = "false";
181 
188  public const string COLLECTION_NAME = "collection_name";
189 
205  public const string CASE_SENSITIVE = "case_sensitive";
206  } // end struct Options
207 
208 
214  public string table_name { get; set; }
215 
223  public string view_name { get; set; } = "";
224 
226  public string expression { get; set; }
227 
268  public string mode { get; set; }
269 
272  public IList<string> column_names { get; set; } = new List<string>();
273 
330  public IDictionary<string, string> options { get; set; } = new Dictionary<string, string>();
331 
332 
336 
457  string view_name,
458  string expression,
459  string mode,
460  IList<string> column_names,
461  IDictionary<string, string> options = null)
462  {
463  this.table_name = table_name ?? "";
464  this.view_name = view_name ?? "";
465  this.expression = expression ?? "";
466  this.mode = mode ?? "";
467  this.column_names = column_names ?? new List<string>();
468  this.options = options ?? new Dictionary<string, string>();
469  } // end constructor
470 
471  } // end class FilterByStringRequest
472 
473 
474 
479  {
480 
493  public struct Info
494  {
495 
498  public const string QUALIFIED_VIEW_NAME = "qualified_view_name";
499  } // end struct Info
500 
501 
504  public long count { get; set; }
505 
516  public IDictionary<string, string> info { get; set; } = new Dictionary<string, string>();
517 
518  } // end class FilterByStringResponse
519 
520 
521 
522 
523 } // end namespace kinetica
const string EQUALS
Exact whole-string match (accelerated).
string view_name
If provided, then this will be the name of the view containing the results, in [schema_name.
string table_name
Name of the table on which the filter operation will be performed, in [schema_name.
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 ...
const string CASE_SENSITIVE
If false then string filtering will ignore case.
string expression
The expression with which to filter the table.
FilterByStringRequest()
Constructs a FilterByStringRequest object with default parameters.
const string STARTS_WITH
Strings that start with the given expression (not accelerated).
IDictionary< string, string > info
Additional information.
const string REGEX
Full regular expression search (not accelerated).
A set of results returned by Kinetica.filterByString(string,string,string,string,IList{string},IDictionary{string, string}).
IDictionary< string, string > options
Optional parameters.
const string COLLECTION_NAME
[DEPRECATED–please specify the containing schema for the view as part of view_name and use Kinetica...
IList< string > column_names
List of columns on which to apply the filter.
const string QUALIFIED_VIEW_NAME
The fully qualified name of the view (i.e.
FilterByStringRequest(string table_name, string view_name, string expression, string mode, IList< string > column_names, IDictionary< string, string > options=null)
Constructs a FilterByStringRequest object with the specified parameters.
long count
The number of records that passed the string filter.
A set of parameters for Kinetica.filterByString(string,string,string,string,IList{string},IDictionary{string, string}).
The string filtering mode to apply.
const string SEARCH
Full text search query with wildcards and boolean operators.
KineticaData - class to help with Avro Encoding for Kinetica
Definition: KineticaData.cs:14
const string CONTAINS
Partial substring match (not accelerated).
string mode
The string filtering mode to apply.