Kinetica   C#   API  Version 7.2.3.0
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 namespace kinetica
10 {
23  {
28  public struct Mode
29  {
36  public const string SEARCH = "search";
37 
39  public const string EQUALS = "equals";
40 
45  public const string CONTAINS = "contains";
46 
52  public const string STARTS_WITH = "starts_with";
53 
59  public const string REGEX = "regex";
60  } // end struct Mode
61 
65  public struct Options
66  {
81  public const string CREATE_TEMP_TABLE = "create_temp_table";
82 
83  public const string TRUE = "true";
84  public const string FALSE = "false";
85 
93  public const string COLLECTION_NAME = "collection_name";
94 
108  public const string CASE_SENSITIVE = "case_sensitive";
109  } // end struct Options
110 
116  public string table_name { get; set; }
117 
126  public string view_name { get; set; } = "";
127 
129  public string expression { get; set; }
130 
169  public string mode { get; set; }
170 
174  public IList<string> column_names { get; set; } = new List<string>();
175 
233  public IDictionary<string, string> options { get; set; } = new Dictionary<string, string>();
234 
238 
358  string view_name,
359  string expression,
360  string mode,
361  IList<string> column_names,
362  IDictionary<string, string> options = null)
363  {
364  this.table_name = table_name ?? "";
365  this.view_name = view_name ?? "";
366  this.expression = expression ?? "";
367  this.mode = mode ?? "";
368  this.column_names = column_names ?? new List<string>();
369  this.options = options ?? new Dictionary<string, string>();
370  } // end constructor
371  } // end class FilterByStringRequest
372 
377  {
381  public struct Info
382  {
385  public const string QUALIFIED_VIEW_NAME = "qualified_view_name";
386  } // end struct Info
387 
390  public long count { get; set; }
391 
403  public IDictionary<string, string> info { get; set; } = new Dictionary<string, string>();
404  } // end class FilterByStringResponse
405 } // 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.
A set of string constants for the parameter options.
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....
A set of string constants for the parameter info.
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.
A set of string constants for the parameter mode.
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.