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 mode. More...

struct	Options
	A set of string constants for the parameter options. 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 = new List<string>() `[get, set]`
	List of columns on which to apply the filter. More...

IDictionary< string, string >	options = new Dictionary<string, 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.

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/2]

kinetica.FilterByStringRequest.FilterByStringRequest ( )

inline

Constructs a FilterByStringRequest object with default parameters.

Definition at line 237 of file FilterByString.cs.

◆ FilterByStringRequest() [2/2]

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: TRUE FALSE 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: TRUE FALSE The default value is TRUE. The default value is an empty Dictionary.

Definition at line 357 of file FilterByString.cs.

Property Documentation

◆ column_names

IList<string> kinetica.FilterByStringRequest.column_names = new List<string>()

getset

List of columns on which to apply the filter.

Ignored for SEARCH mode.

Definition at line 174 of file FilterByString.cs.

◆ expression

string kinetica.FilterByStringRequest.expression

getset

The expression with which to filter the table.

Definition at line 129 of file FilterByString.cs.

◆ mode

string kinetica.FilterByStringRequest.mode

getset

The string filtering mode to apply.

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.

Definition at line 169 of file FilterByString.cs.

◆ options

IDictionary<string, string> kinetica.FilterByStringRequest.options = new Dictionary<string, 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 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:
- TRUE
- FALSE
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:
- TRUE
- FALSE
The default value is TRUE.

The default value is an empty Dictionary.

Definition at line 233 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 116 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 126 of file FilterByString.cs.

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

Kinetica/Protocol/FilterByString.cs

Classes

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ FilterByStringRequest() [1/2]

◆ FilterByStringRequest() [2/2]

Property Documentation

◆ column_names

◆ expression

◆ mode

◆ options

◆ table_name

◆ view_name