A set of input parameters for filterByString(const FilterByStringRequest&) const. More...

#include <gpudb/protocol/filter_by_string.h>

Public Member Functions
	FilterByStringRequest ()
	Constructs a FilterByStringRequest object with default parameter values. More...

	FilterByStringRequest (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_)
	Constructs a FilterByStringRequest object with the specified parameters. More...

Public Attributes
std::string	tableName

std::string	viewName

std::string	expression

std::string	mode

std::vector< std::string >	columnNames

std::map< std::string, std::string >	options

Detailed Description

A set of input parameters for filterByString(const FilterByStringRequest&) const.

Calculates which objects from a table, collection, or view match a string expression for the given string columns. The options 'case_sensitive' can be used to modify the behavior for all modes except 'search'. For 'search' mode details and limitations, see Full Text Search.

Definition at line 23 of file filter_by_string.h.

Constructor & Destructor Documentation

◆ FilterByStringRequest() [1/2]

gpudb::FilterByStringRequest::FilterByStringRequest ( )

inline

Constructs a FilterByStringRequest object with default parameter values.

Definition at line 30 of file filter_by_string.h.

◆ FilterByStringRequest() [2/2]

gpudb::FilterByStringRequest::FilterByStringRequest	(	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_
	)

inline

Constructs a FilterByStringRequest object with the specified parameters.

Parameters

[in]	tableName_	Name of the table on which the filter operation will be performed. Must be an existing table, collection or view.
[in]	viewName_	If provided, then this will be the name of the view containing the results. Has the same naming restrictions as tables.
[in]	expression_	The expression with which to filter the table.
[in]	mode_	The string filtering mode to apply. See below for details. gpudb::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. gpudb::filter_by_string_equals: Exact whole-string match (accelerated). gpudb::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. gpudb::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. gpudb::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.
[in]	columnNames_	List of columns on which to apply the filter. Ignored for 'search' mode.
[in]	options_	Optional parameters. gpudb::filter_by_string_collection_name: Name of a collection which is to contain the newly created view. If the collection provided is non-existent, the collection will be automatically created. If empty, then the newly created view will be top-level. gpudb::filter_by_string_case_sensitive: If 'false' then string filtering will ignore case. Does not apply to 'search' mode. gpudb::filter_by_string_true gpudb::filter_by_string_false The default value is gpudb::filter_by_string_true.

Definition at line 103 of file filter_by_string.h.

Member Data Documentation

◆ columnNames

std::vector<std::string> gpudb::FilterByStringRequest::columnNames

Definition at line 117 of file filter_by_string.h.

◆ expression

std::string gpudb::FilterByStringRequest::expression

Definition at line 115 of file filter_by_string.h.

◆ mode

std::string gpudb::FilterByStringRequest::mode

Definition at line 116 of file filter_by_string.h.

◆ options

std::map<std::string, std::string> gpudb::FilterByStringRequest::options

Definition at line 118 of file filter_by_string.h.

◆ tableName

std::string gpudb::FilterByStringRequest::tableName

Definition at line 113 of file filter_by_string.h.

◆ viewName

std::string gpudb::FilterByStringRequest::viewName

Definition at line 114 of file filter_by_string.h.

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

gpudb/protocol/filter_by_string.h

Public Member Functions

Public Attributes