A set of parameters for GPUdb::filterByRange. More…
#include <gpudb/protocol/filter_by_range.h>
Public Member Functions | |
| FilterByRangeRequest () | |
| Constructs a FilterByRangeRequest object with default parameters. | |
| FilterByRangeRequest (const std::string &tableName_, const std::string &viewName_, const std::string &columnName_, const double lowerBound_, const double upperBound_, const std::map< std::string, std::string > &options_) | |
| Constructs a FilterByRangeRequest object with the specified parameters. | |
Public Attributes | |
| std::string | tableName |
| Name of the table on which the filter by range 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 | columnName |
| Name of a column on which the operation would be applied. | |
| double | lowerBound |
| Value of the lower bound (inclusive). | |
| double | upperBound |
| Value of the upper bound (inclusive). | |
| std::map< std::string, std::string > | options |
| Optional parameters. | |
Detailed Description
A set of parameters for GPUdb::filterByRange.
Calculates which objects from a table have a column that is within the given bounds. An object from the table identified by tableName is added to the view viewName if its column is within [lowerBound, upperBound] (inclusive). The operation is synchronous. The response provides a count of the number of objects which passed the bound filter. Although this functionality can also be accomplished with the standard filter function, it is more efficient.
For track objects, the count reflects how many points fall within the given bounds (which may not include all the track points of any given track).
Definition at line 28 of file filter_by_range.h.
Constructor & Destructor Documentation
◆ FilterByRangeRequest() [1/2]
| inline |
Constructs a FilterByRangeRequest object with default parameters.
Definition at line 33 of file filter_by_range.h.
◆ FilterByRangeRequest() [2/2]
| inline |
Constructs a FilterByRangeRequest object with the specified parameters.
| [in] | tableName_ | Name of the table on which the filter by range operation will be performed, in [schema_name.]table_name format, using standard name resolution rules. Must be an existing table. |
| [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] | columnName_ | Name of a column on which the operation would be applied. |
| [in] | lowerBound_ | Value of the lower bound (inclusive). |
| [in] | upperBound_ | Value of the upper bound (inclusive). |
| [in] | options_ | Optional parameters.
|
Definition at line 111 of file filter_by_range.h.
Member Data Documentation
◆ columnName
| std::string gpudb::FilterByRangeRequest::columnName |
Name of a column on which the operation would be applied.
Definition at line 143 of file filter_by_range.h.
◆ lowerBound
| double gpudb::FilterByRangeRequest::lowerBound |
Value of the lower bound (inclusive).
Definition at line 148 of file filter_by_range.h.
◆ options
| std::map<std::string, std::string> gpudb::FilterByRangeRequest::options |
Optional parameters.
- filter_by_range_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_range_false.
- filter_by_range_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.
The default value is an empty map.
Definition at line 187 of file filter_by_range.h.
◆ tableName
| std::string gpudb::FilterByRangeRequest::tableName |
Name of the table on which the filter by range operation will be performed, in [ schema_name. ]table_name format, using standard name resolution rules.
Must be an existing table.
Definition at line 127 of file filter_by_range.h.
◆ upperBound
| double gpudb::FilterByRangeRequest::upperBound |
Value of the upper bound (inclusive).
Definition at line 153 of file filter_by_range.h.
◆ viewName
| std::string gpudb::FilterByRangeRequest::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 138 of file filter_by_range.h.
The documentation for this struct was generated from the following file:
- gpudb/protocol/filter_by_range.h