A set of parameters for GPUdb::filterByArea. More…
#include <gpudb/protocol/filter_by_area.h>
Public Member Functions | |
| FilterByAreaRequest () | |
| Constructs a FilterByAreaRequest object with default parameters. | |
| FilterByAreaRequest (const std::string &tableName_, const std::string &viewName_, const std::string &xColumnName_, const std::vector< double > &xVector_, const std::string &yColumnName_, const std::vector< double > &yVector_, const std::map< std::string, std::string > &options_) | |
| Constructs a FilterByAreaRequest 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 | xColumnName |
| Name of the column containing the x values to be filtered. | |
| std::vector< double > | xVector |
| List of x coordinates of the vertices of the polygon representing the area to be filtered. | |
| std::string | yColumnName |
| Name of the column containing the y values to be filtered. | |
| std::vector< double > | yVector |
| List of y coordinates of the vertices of the polygon representing the area to be filtered. | |
| std::map< std::string, std::string > | options |
| Optional parameters. | |
Detailed Description
A set of parameters for GPUdb::filterByArea.
Calculates which objects from a table are within a named area of interest (NAI/polygon). The operation is synchronous, meaning that a response will not be returned until all the matching objects are fully available. The response payload provides the count of the resulting set. A new resultant set (view) which satisfies the input NAI restriction specification is created with the name viewName passed in as part of the input.
Definition at line 24 of file filter_by_area.h.
Constructor & Destructor Documentation
◆ FilterByAreaRequest() [1/2]
| inline |
Constructs a FilterByAreaRequest object with default parameters.
Definition at line 29 of file filter_by_area.h.
◆ FilterByAreaRequest() [2/2]
| inline |
Constructs a FilterByAreaRequest 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] | xColumnName_ | Name of the column containing the x values to be filtered. |
| [in] | xVector_ | List of x coordinates of the vertices of the polygon representing the area to be filtered. |
| [in] | yColumnName_ | Name of the column containing the y values to be filtered. |
| [in] | yVector_ | List of y coordinates of the vertices of the polygon representing the area to be filtered. |
| [in] | options_ | Optional parameters.
|
Definition at line 110 of file filter_by_area.h.
Member Data Documentation
◆ options
| std::map<std::string, std::string> gpudb::FilterByAreaRequest::options |
Optional parameters.
- filter_by_area_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_area_false.
- filter_by_area_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.
The default value is an empty map.
Definition at line 195 of file filter_by_area.h.
◆ tableName
| std::string gpudb::FilterByAreaRequest::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 128 of file filter_by_area.h.
◆ viewName
| std::string gpudb::FilterByAreaRequest::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 139 of file filter_by_area.h.
◆ xColumnName
| std::string gpudb::FilterByAreaRequest::xColumnName |
Name of the column containing the x values to be filtered.
Definition at line 144 of file filter_by_area.h.
◆ xVector
| std::vector<double> gpudb::FilterByAreaRequest::xVector |
List of x coordinates of the vertices of the polygon representing the area to be filtered.
Definition at line 150 of file filter_by_area.h.
◆ yColumnName
| std::string gpudb::FilterByAreaRequest::yColumnName |
Name of the column containing the y values to be filtered.
Definition at line 155 of file filter_by_area.h.
◆ yVector
| std::vector<double> gpudb::FilterByAreaRequest::yVector |
List of y coordinates of the vertices of the polygon representing the area to be filtered.
Definition at line 161 of file filter_by_area.h.
The documentation for this struct was generated from the following file:
- gpudb/protocol/filter_by_area.h