◆ filterByString() \[1/4]

FilterByStringResponse gpudb::GPUdb::filterByString

(

request\_

)

const

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

\[in]

request\_

Request object containing the parameters for the operation.

Returns

Response object containing the result of the operation.

◆ filterByString() \[2/4]

FilterByStringResponse & gpudb::GPUdb::filterByString	(	const FilterByStringRequest &	request\_,
		FilterByStringResponse &	response\_ ) const

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

\[in]	request\_	Request object containing the parameters for the operation.
\[out]	response\_	Response object containing the results of the operation.

Returns

Response object containing the result of the operation (initially passed in by reference).

◆ filterByString() \[3/4]

FilterByStringResponse gpudb::GPUdb::filterByString	(	const std::string &	tableName,
		const std::string &	viewName,
		const std::string &	expression,
		const std::string &	mode,
		const std::vector\< std::string > &	columnNames,
		const std::map\< std::string, std::string > &	options ) const

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

\[in]	tableName	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.
\[in]	viewName	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 ''.
\[in]	expression	The expression with which to filter the table.
\[in]	mode	The string filtering mode to apply. See below for details. Supported values: filter\_by\_string\_search: Full text search query with wildcards and boolean operators. Note that for this mode, no column can be specified in columnNames; all string columns of the table that have text search enabled will be searched. filter\_by\_string\_equals: Exact whole-string match (accelerated). filter\_by\_string\_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. filter\_by\_string\_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. filter\_by\_string\_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. filter\_by\_string\_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.
\[in]	columnNames	List of columns on which to apply the filter. Ignored for search mode.
\[in]	options	Optional parameters. filter\_by\_string\_create\_temp\_table: If true, a unique temporary table name will be generated in the sys\_temp schema and used in place of viewName. 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: filter\_by\_string\_true filter\_by\_string\_false The default value is filter\_by\_string\_false. filter\_by\_string\_collection\_name: \[DEPRECATED–please specify the containing schema for the view as part of viewName 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. filter\_by\_string\_case\_sensitive: If false then string filtering will ignore case. Does not apply to search mode. Supported values: filter\_by\_string\_true filter\_by\_string\_false The default value is filter\_by\_string\_true. The default value is an empty map.

Returns

Response object containing the result of the operation.

◆ filterByString() \[4/4]

FilterByStringResponse & gpudb::GPUdb::filterByString	(	const std::string &	tableName,
		const std::string &	viewName,
		const std::string &	expression,
		const std::string &	mode,
		const std::vector\< std::string > &	columnNames,
		const std::map\< std::string, std::string > &	options,
		FilterByStringResponse &	response\_ ) const

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

\[in]	tableName	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.
\[in]	viewName	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 ''.
\[in]	expression	The expression with which to filter the table.
\[in]	mode	The string filtering mode to apply. See below for details. Supported values: filter\_by\_string\_search: Full text search query with wildcards and boolean operators. Note that for this mode, no column can be specified in columnNames; all string columns of the table that have text search enabled will be searched. filter\_by\_string\_equals: Exact whole-string match (accelerated). filter\_by\_string\_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. filter\_by\_string\_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. filter\_by\_string\_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. filter\_by\_string\_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.
\[in]	columnNames	List of columns on which to apply the filter. Ignored for search mode.
\[in]	options	Optional parameters. filter\_by\_string\_create\_temp\_table: If true, a unique temporary table name will be generated in the sys\_temp schema and used in place of viewName. 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: filter\_by\_string\_true filter\_by\_string\_false The default value is filter\_by\_string\_false. filter\_by\_string\_collection\_name: \[DEPRECATED–please specify the containing schema for the view as part of viewName 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. filter\_by\_string\_case\_sensitive: If false then string filtering will ignore case. Does not apply to search mode. Supported values: filter\_by\_string\_true filter\_by\_string\_false The default value is filter\_by\_string\_true. The default value is an empty map.
\[out]	response\_	Response object containing the results of the operation.

Returns

Response object containing the result of the operation (initially passed in by reference).