> ## Documentation Index > Fetch the complete documentation index at: https://docs.kinetica.com/llms.txt > Use this file to discover all available pages before exploring further. # kinetica.FilterByStringRequest > kinetica.FilterByStringRequest — Kinetica C# API

A set of parameters for Kinetica.filterByString. More...

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

Classes
struct   Mode
  A set of string constants for the parameter FilterByStringRequest.mode. More...
 
struct   Options
  A set of string constants for the parameter FilterByStringRequest.options. More...
 

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

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

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.
 
static ? RecordSchema  SchemaFromType (System.Type t, KineticaType? ktype=null)
  Create an Avro Schema from a System.Type and a KineticaType.
 

Detailed Description

A set of parameters for Kinetica.filterByString.

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 22 of file FilterByString.cs.

Constructor & Destructor Documentation

◆ FilterByStringRequest() \[1/4]

kinetica.FilterByStringRequest.FilterByStringRequest ( )
inline

Constructs a FilterByStringRequest object with default parameters.

Definition at line 277 of file FilterByString.cs.

◆ FilterByStringRequest() \[2/4]

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\_name 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.
view\_name 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 ''.
expression The expression with which to filter the table.
mode 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 column\_names ; 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\_names List of columns on which to apply the filter. Ignored for SEARCH mode.
options 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 view\_name . 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 view\_name and use Kinetica.createSchema 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 412 of file FilterByString.cs.

◆ FilterByStringRequest() \[3/4]

kinetica.FilterByStringRequest.FilterByStringRequest ( )
inline

Constructs a FilterByStringRequest object with default parameters.

Definition at line 277 of file FilterByString.cs.

◆ FilterByStringRequest() \[4/4]

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\_name 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.
view\_name 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 ''.
expression The expression with which to filter the table.
mode 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 column\_names ; 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\_names List of columns on which to apply the filter. Ignored for SEARCH mode.
options 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 view\_name . 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 view\_name and use Kinetica.createSchema 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 412 of file FilterByString.cs.

Property Documentation

◆ column\_names

IList\< string > kinetica.FilterByStringRequest.column\_names = new List\()
getset

List of columns on which to apply the filter.

Ignored for SEARCH mode.

Definition at line 201 of file FilterByString.cs.

◆ expression

string kinetica.FilterByStringRequest.expression
getset

The expression with which to filter the table.

Definition at line 149 of file FilterByString.cs.

◆ mode

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 FilterByStringRequest.column\_names; 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 195 of file FilterByString.cs.

◆ options

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

Optional parameters.

The default value is an empty Dictionary.

Definition at line 273 of file FilterByString.cs.

◆ table\_name

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 136 of file FilterByString.cs.

◆ view\_name

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 146 of file FilterByString.cs.

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