> ## 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. # filterByString

◆ filterByString() \[1/2]

FilterByStringResponse kinetica.Kinetica.filterByString ( FilterByStringRequest request\_ )
inline

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.

Parameters
request\_ Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

Definition at line 39098 of file KineticaFunctions.cs.

◆ filterByString() \[2/2]

FilterByStringResponse kinetica.Kinetica.filterByString ( string table\_name,
string view\_name,
string expression,
string mode,
IList\< string > column\_names,
IDictionary\< string, string > options = null )
inline

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.

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.
  • SEARCH\_STATS: Cross-shard BM25 corpus statistics for one (column, query) pair. Returns the merged BM25 statistics (max\_doc, doc\_count, sum\_total\_term\_freq, per-term doc\_freq / total\_term\_freq) needed by callers that score documents themselves (e.g. text\_match\_bm25\_global SQL function pre-pass). Requires COLUMN\_NAMES to contain exactly one column with text search enabled. The VIEW\_NAME field is ignored — this mode does not produce a result table.
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 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.
Returns
Response object containing the result of the operation.

Definition at line 39284 of file KineticaFunctions.cs.

◆ FilterByStringAsync() \[1/2]

async System.Threading.Tasks.Task\< FilterByStringResponse > kinetica.Kinetica.FilterByStringAsync ( FilterByStringRequest request\_,
System.Threading.CancellationToken cancellationToken = default )
inline

Calculates which objects from a table or view match a string expression for the given string columns.

(async)

Setting CASE\_SENSITIVE can modify case sensitivity in matching for all modes except SEARCH. For SEARCH mode details and limitations, see Full Text Search.

Parameters
request\_ Request object containing the parameters for the operation.
cancellationToken Cancellation token to cancel the operation.
Returns
Task that returns the response object containing the result of the operation.

Definition at line 39121 of file KineticaFunctions.cs.

◆ FilterByStringAsync() \[2/2]

async System.Threading.Tasks.Task\< FilterByStringResponse > kinetica.Kinetica.FilterByStringAsync ( string table\_name,
string view\_name,
string expression,
string mode,
IList\< string > column\_names,
IDictionary\< string, string > options = null,
System.Threading.CancellationToken cancellationToken = default )
inline

Calculates which objects from a table or view match a string expression for the given string columns.

(async)

Setting CASE\_SENSITIVE can modify case sensitivity in matching for all modes except SEARCH. For SEARCH mode details and limitations, see Full Text Search.

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.
  • SEARCH\_STATS: Cross-shard BM25 corpus statistics for one (column, query) pair. Returns the merged BM25 statistics (max\_doc, doc\_count, sum\_total\_term\_freq, per-term doc\_freq / total\_term\_freq) needed by callers that score documents themselves (e.g. text\_match\_bm25\_global SQL function pre-pass). Requires COLUMN\_NAMES to contain exactly one column with text search enabled. The VIEW\_NAME field is ignored — this mode does not produce a result table.
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 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.
cancellationToken Cancellation token to cancel the operation.
Returns
Task that returns the response object containing the result of the operation.

Definition at line 39453 of file KineticaFunctions.cs.