A set of parameters for GPUdb::filter. More…
#include <gpudb/protocol/filter.h>
Public Member Functions | |
| FilterRequest () | |
| Constructs a FilterRequest object with default parameters. | |
| FilterRequest (const std::string &tableName_, const std::string &viewName_, const std::string &expression_, const std::map< std::string, std::string > &options_) | |
| Constructs a FilterRequest 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::string | expression |
| The select expression to filter the specified table. | |
| std::map< std::string, std::string > | options |
| Optional parameters. | |
Detailed Description
A set of parameters for GPUdb::filter.
Filters data based on the specified expression. The results are stored in a result set with the given viewName.
For details see Expressions.
The response message contains the number of points for which the expression evaluated to be true, which is equivalent to the size of the result view.
Constructor & Destructor Documentation
◆ FilterRequest() [1/2]
| inline |
Constructs a FilterRequest object with default parameters.
◆ FilterRequest() [2/2]
| inline |
Constructs a FilterRequest 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] | expression_ | The select expression to filter the specified table. For details see Expressions. |
| [in] | options_ | Optional parameters.
|
Member Data Documentation
◆ expression
| std::string gpudb::FilterRequest::expression |
The select expression to filter the specified table.
For details see Expressions.
◆ options
| std::map<std::string, std::string> gpudb::FilterRequest::options |
Optional parameters.
- filter_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_false.
- filter_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_view_id: View this filtered-view is part of. The default value is ”.
- filter_ttl: Sets the TTL of the view specified in viewName.
The default value is an empty map.
◆ tableName
| std::string gpudb::FilterRequest::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).
◆ viewName
| std::string gpudb::FilterRequest::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 ”.
The documentation for this struct was generated from the following file:
- gpudb/protocol/filter.h