A set of parameters for GPUdb::filterByList. More…
#include <gpudb/protocol/filter_by_list.h>
Public Member Functions | |
| FilterByListRequest () | |
| Constructs a FilterByListRequest object with default parameters. | |
| FilterByListRequest (const std::string &tableName_, const std::string &viewName_, const std::map< std::string, std::vector< std::string > > &columnValuesMap_, const std::map< std::string, std::string > &options_) | |
| Constructs a FilterByListRequest object with the specified parameters. | |
Public Attributes | |
| std::string | tableName |
| Name of the table to filter, 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::map< std::string, std::vector< std::string > > | columnValuesMap |
| List of values for the corresponding column in the table. | |
| std::map< std::string, std::string > | options |
| Optional parameters. | |
Detailed Description
A set of parameters for GPUdb::filterByList.
Calculates which records from a table have values in the given list for the corresponding column. The operation is synchronous, meaning that a response will not be returned until all the objects are fully available. The response payload provides the count of the resulting set. A new resultant set (view) which satisfies the input filter specification is also created if a viewName is passed in as part of the request.
For example, if a type definition has the columns ‘x’ and ‘y’, then a filter by list query with the column map “x”:[“10.1”, “2.3”], “y”:[“0.0”, “-31.5”, “42.0”] will return the count of all data points whose x and y values match both in the respective x- and y-lists, e.g., “x = 10.1 and y = 0.0”, “x = 2.3 and y = -31.5”, etc. However, a record with “x = 10.1 and y = -31.5” or “x = 2.3 and y = 0.0” would not be returned because the values in the given lists do not correspond.
Definition at line 31 of file filter_by_list.h.
Constructor & Destructor Documentation
◆ FilterByListRequest() [1/2]
| inline |
Constructs a FilterByListRequest object with default parameters.
Definition at line 36 of file filter_by_list.h.
◆ FilterByListRequest() [2/2]
| inline |
Constructs a FilterByListRequest object with the specified parameters.
| [in] | tableName_ | Name of the table to filter, in [schema_name.]table_name format, using standard name resolution rules. This may be the name of a table or a view (when chaining queries). |
| [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] | columnValuesMap_ | List of values for the corresponding column in the table. |
| [in] | options_ | Optional parameters.
|
Definition at line 130 of file filter_by_list.h.
Member Data Documentation
◆ columnValuesMap
| std::map<std::string, std::vector<std::string> > gpudb::FilterByListRequest::columnValuesMap |
List of values for the corresponding column in the table.
Definition at line 161 of file filter_by_list.h.
◆ options
| std::map<std::string, std::string> gpudb::FilterByListRequest::options |
Optional parameters.
- filter_by_list_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_list_false.
- filter_by_list_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 provided is non-existent, it will be automatically created.
- filter_by_list_filter_mode: String indicating the filter mode, either ‘in_list’ or ‘not_in_list’. Supported values:
- filter_by_list_in_list: The filter will match all items that are in the provided list(s).
- filter_by_list_not_in_list: The filter will match all items that are not in the provided list(s).
The default value is an empty map.
Definition at line 209 of file filter_by_list.h.
◆ tableName
| std::string gpudb::FilterByListRequest::tableName |
Name of the table to filter, in [ schema_name. ]table_name format, using standard name resolution rules.
This may be the name of a table or a view (when chaining queries).
Definition at line 145 of file filter_by_list.h.
◆ viewName
| std::string gpudb::FilterByListRequest::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 156 of file filter_by_list.h.
The documentation for this struct was generated from the following file:
- gpudb/protocol/filter_by_list.h