Kinetica C# API  Version 7.1.10.0
 All Classes Namespaces Files Functions Variables Enumerations Enumerator Properties Pages
Classes | Public Member Functions | Properties | List of all members
kinetica.FilterByStringRequest Class Reference

A set of parameters for Kinetica.filterByString(string,string,string,string,IList{string},IDictionary{string, string}). More...

+ Inheritance diagram for kinetica.FilterByStringRequest:
+ Collaboration diagram for kinetica.FilterByStringRequest:

Classes

struct  Mode
 The string filtering mode to apply. More...
 
struct  Options
 Optional parameters. More...
 

Public Member Functions

 FilterByStringRequest ()
 Constructs a FilterByStringRequest object with default parameters. More...
 
 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. More...
 
- Public Member Functions inherited from kinetica.KineticaData
 KineticaData (KineticaType type)
 Constructor from Kinetica Type More...
 
 KineticaData (System.Type type=null)
 Default constructor, with optional System.Type More...
 
object Get (int fieldPos)
 Retrieve a specific property from this object More...
 
void Put (int fieldPos, object fieldValue)
 Write a specific property to this object More...
 

Properties

string table_name [get, set]
 Name of the table on which the filter operation will be performed, in [schema_name. More...
 
string view_name [get, set]
 If provided, then this will be the name of the view containing the results, in [schema_name. More...
 
string expression = "" [get, set]
 The expression with which to filter the table. More...
 
string mode [get, set]
 The string filtering mode to apply. More...
 
IList< string > column_names [get, set]
 List of columns on which to apply the filter. More...
 
IDictionary< string, string > options = new List<string>() [get, set]
 Optional parameters. More...
 
- Properties inherited from kinetica.KineticaData
Schema Schema [get]
 Avro Schema for this class More...
 

Additional Inherited Members

- Static Public Member Functions inherited from kinetica.KineticaData
static RecordSchema SchemaFromType (System.Type t, KineticaType ktype=null)
 Create an Avro Schema from a System.Type and a KineticaType. More...
 

Detailed Description

A set of parameters for Kinetica.filterByString(string,string,string,string,IList{string},IDictionary{string, string}).


Calculates which objects from a table or view match a string expression for the given string columns. Setting case_sensitive can modify case sensitivity in matching for all modes except search. For search mode details and limitations, see Full Text Search.

Definition at line 25 of file FilterByString.cs.

Constructor & Destructor Documentation

kinetica.FilterByStringRequest.FilterByStringRequest ( )
inline

Constructs a FilterByStringRequest object with default parameters.

Definition at line 335 of file FilterByString.cs.

kinetica.FilterByStringRequest.FilterByStringRequest ( string  table_name,
string  view_name,
string  expression,
string  mode,
IList< string >  column_names,
IDictionary< string, string >  options = null 
)
inline

Constructs a FilterByStringRequest object with the specified parameters.

Parameters
table_nameName of the table on which the filter operation will be performed, in [schema_name.]table_name format, using standard name resolution rules. Must be an existing table or view.
view_nameIf provided, then this will be the name of the view containing the results, in [schema_name.]view_name format, using standard name resolution rules and meeting table naming criteria. Must not be an already existing table or view. The default value is ''.
expressionThe expression with which to filter the table.
modeThe string filtering mode to apply. See below for details. Supported values:
  • SEARCH: Full text search query with wildcards and boolean operators. Note that for this mode, no column can be specified in ; all string columns of the table that have text search enabled will be searched.
  • EQUALS: Exact whole-string match (accelerated).
  • CONTAINS: Partial substring match (not accelerated). If the column is a string type (non-charN) and the number of records is too large, it will return 0.
  • STARTS_WITH: Strings that start with the given expression (not accelerated). If the column is a string type (non-charN) and the number of records is too large, it will return 0.
  • REGEX: Full regular expression search (not accelerated). If the column is a string type (non-charN) and the number of records is too large, it will return 0.
column_namesList of columns on which to apply the filter. Ignored for search mode.
optionsOptional parameters.
  • CREATE_TEMP_TABLE: If true, a unique temporary table name will be generated in the sys_temp schema and used in place of . This is always allowed even if the caller does not have permission to create tables. The generated name is returned in qualified_view_name. Supported values: The default value is FALSE.
  • COLLECTION_NAME: [DEPRECATED–please specify the containing schema for the view as part of and use /create/schema to create the schema if non-existent] Name of a schema for the newly created view. If the schema is non-existent, it will be automatically created.
  • CASE_SENSITIVE: If false then string filtering will ignore case. Does not apply to search mode. Supported values: The default value is TRUE.
The default value is an empty Dictionary.

Definition at line 456 of file FilterByString.cs.

Property Documentation

IList<string> kinetica.FilterByStringRequest.column_names
getset

List of columns on which to apply the filter.

Ignored for search mode.

Definition at line 272 of file FilterByString.cs.

string kinetica.FilterByStringRequest.expression = ""
getset

The expression with which to filter the table.

Definition at line 226 of file FilterByString.cs.

string kinetica.FilterByStringRequest.mode
getset

The string filtering mode to apply.

See below for details. Supported values:

  • SEARCH: Full text search query with wildcards and boolean operators. Note that for this mode, no column can be specified in ; all string columns of the table that have text search enabled will be searched.
  • EQUALS: Exact whole-string match (accelerated).
  • CONTAINS: Partial substring match (not accelerated). If the column is a string type (non-charN) and the number of records is too large, it will return 0.
  • STARTS_WITH: Strings that start with the given expression (not accelerated). If the column is a string type (non-charN) and the number of records is too large, it will return 0.
  • REGEX: Full regular expression search (not accelerated). If the column is a string type (non-charN) and the number of records is too large, it will return 0.

Definition at line 268 of file FilterByString.cs.

IDictionary<string, string> kinetica.FilterByStringRequest.options = new List<string>()
getset

Optional parameters.

  • CREATE_TEMP_TABLE: If true, a unique temporary table name will be generated in the sys_temp schema and used in place of . This is always allowed even if the caller does not have permission to create tables. The generated name is returned in qualified_view_name. Supported values: The default value is FALSE.
  • COLLECTION_NAME: [DEPRECATED–please specify the containing schema for the view as part of and use /create/schema to create the schema if non-existent] Name of a schema for the newly created view. If the schema is non-existent, it will be automatically created.
  • CASE_SENSITIVE: If false then string filtering will ignore case. Does not apply to search mode. Supported values: The default value is TRUE.

The default value is an empty Dictionary.

Definition at line 330 of file FilterByString.cs.

string kinetica.FilterByStringRequest.table_name
getset

Name of the table on which the filter operation will be performed, in [schema_name.

]table_name format, using standard name resolution rules. Must be an existing table or view.

Definition at line 214 of file FilterByString.cs.

string kinetica.FilterByStringRequest.view_name
getset

If provided, then this will be the name of the view containing the results, in [schema_name.

]view_name format, using standard name resolution rules and meeting table naming criteria. Must not be an already existing table or view. The default value is ''.

Definition at line 223 of file FilterByString.cs.

The documentation for this class was generated from the following file: