A set of parameters for GPUdb::filterByString. More…
#include <gpudb/protocol/filter_by_string.h>
Public Member Functions | |
| FilterByStringRequest () | |
| Constructs a FilterByStringRequest object with default parameters. | |
| 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. | |
Public Attributes | |
| std::string | tableName |
| Name of the table on which the filter operation will be performed, in [ schema_name. ]table_name format, using standard name resolution rules. | |
| std::string | 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. | |
| std::string | expression |
| The expression with which to filter the table. | |
| std::string | mode |
| The string filtering mode to apply. | |
| std::vector< std::string > | columnNames |
| List of columns on which to apply the filter. | |
| std::map< std::string, std::string > | options |
| Optional parameters. | |
Detailed Description
A set of parameters for GPUdb::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 25 of file filter_by_string.h.
Constructor & Destructor Documentation
◆ FilterByStringRequest() [1/2]
| inline |
Constructs a FilterByStringRequest object with default parameters.
Definition at line 30 of file filter_by_string.h.
◆ FilterByStringRequest() [2/2]
| inline |
Constructs a FilterByStringRequest object with the specified 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:
|
| [in] | columnNames_ | List of columns on which to apply the filter. Ignored for search mode. |
| [in] | options_ | Optional parameters.
|
Definition at line 164 of file filter_by_string.h.
Member Data Documentation
◆ columnNames
| std::vector<std::string> gpudb::FilterByStringRequest::columnNames |
List of columns on which to apply the filter.
Ignored for search mode.
Definition at line 233 of file filter_by_string.h.
◆ expression
| std::string gpudb::FilterByStringRequest::expression |
The expression with which to filter the table.
Definition at line 197 of file filter_by_string.h.
◆ mode
| std::string gpudb::FilterByStringRequest::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.
Definition at line 227 of file filter_by_string.h.
◆ options
| std::map<std::string, std::string> gpudb::FilterByStringRequest::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: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 GPUdb::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:The default value is filter_by_string_true.
The default value is an empty map.
Definition at line 281 of file filter_by_string.h.
◆ tableName
| std::string gpudb::FilterByStringRequest::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.
Definition at line 181 of file filter_by_string.h.
◆ viewName
| std::string gpudb::FilterByStringRequest::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 ”.
Definition at line 192 of file filter_by_string.h.
The documentation for this struct was generated from the following file:
- gpudb/protocol/filter_by_string.h