A set of parameters for GPUdb::filterByRadius. More…
#include <gpudb/protocol/filter_by_radius.h>
Public Member Functions | |
| FilterByRadiusRequest () | |
| Constructs a FilterByRadiusRequest object with default parameters. | |
| FilterByRadiusRequest (const std::string &tableName_, const std::string &viewName_, const std::string &xColumnName_, const double xCenter_, const std::string &yColumnName_, const double yCenter_, const double radius_, const std::map< std::string, std::string > &options_) | |
| Constructs a FilterByRadiusRequest object with the specified parameters. | |
Public Attributes | |
| std::string | tableName |
| Name of the table on which the filter by radius 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 | xColumnName |
| Name of the column to be used for the x-coordinate (the longitude) of the center. | |
| double | xCenter |
| Value of the longitude of the center. | |
| std::string | yColumnName |
| Name of the column to be used for the y-coordinate-the latitude-of the center. | |
| double | yCenter |
| Value of the latitude of the center. | |
| double | radius |
| The radius of the circle within which the search will be performed. | |
| std::map< std::string, std::string > | options |
| Optional parameters. | |
Detailed Description
A set of parameters for GPUdb::filterByRadius.
Calculates which objects from a table lie within a circle with the given radius and center point (i.e. circular NAI). 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 circular NAI restriction specification is also created if a viewName is passed in as part of the request.
For track data, all track points that lie within the circle plus one point on either side of the circle (if the track goes beyond the circle) will be included in the result.
Definition at line 28 of file filter_by_radius.h.
Constructor & Destructor Documentation
◆ FilterByRadiusRequest() [1/2]
| inline |
Constructs a FilterByRadiusRequest object with default parameters.
Definition at line 33 of file filter_by_radius.h.
◆ FilterByRadiusRequest() [2/2]
| inline |
Constructs a FilterByRadiusRequest object with the specified parameters.
| [in] | tableName_ | Name of the table on which the filter by radius 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] | xColumnName_ | Name of the column to be used for the x-coordinate (the longitude) of the center. |
| [in] | xCenter_ | Value of the longitude of the center. Must be within [-180.0, 180.0]. The minimum allowed value is -180. The maximum allowed value is 180. |
| [in] | yColumnName_ | Name of the column to be used for the y-coordinate-the latitude-of the center. |
| [in] | yCenter_ | Value of the latitude of the center. Must be within [-90.0, 90.0]. The minimum allowed value is -90. The maximum allowed value is 90. |
| [in] | radius_ | The radius of the circle within which the search will be performed. Must be a non-zero positive value. It is in meters; so, for example, a value of ‘42000’ means 42 km. The minimum allowed value is 0. The maximum allowed value is MAX_INT. |
| [in] | options_ | Optional parameters.
|
Definition at line 127 of file filter_by_radius.h.
Member Data Documentation
◆ options
| std::map<std::string, std::string> gpudb::FilterByRadiusRequest::options |
Optional parameters.
- filter_by_radius_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_radius_false.
- filter_by_radius_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 which is to contain 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 224 of file filter_by_radius.h.
◆ radius
| double gpudb::FilterByRadiusRequest::radius |
The radius of the circle within which the search will be performed.
Must be a non-zero positive value. It is in meters; so, for example, a value of ‘42000’ means 42 km. The minimum allowed value is 0. The maximum allowed value is MAX_INT.
Definition at line 189 of file filter_by_radius.h.
◆ tableName
| std::string gpudb::FilterByRadiusRequest::tableName |
Name of the table on which the filter by radius operation will be performed, in [ schema_name. ]table_name format, using standard name resolution rules.
Must be an existing table.
Definition at line 145 of file filter_by_radius.h.
◆ viewName
| std::string gpudb::FilterByRadiusRequest::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_radius.h.
◆ xCenter
| double gpudb::FilterByRadiusRequest::xCenter |
Value of the longitude of the center.
Must be within [-180.0, 180.0]. The minimum allowed value is -180. The maximum allowed value is 180.
Definition at line 169 of file filter_by_radius.h.
◆ xColumnName
| std::string gpudb::FilterByRadiusRequest::xColumnName |
Name of the column to be used for the x-coordinate (the longitude) of the center.
Definition at line 162 of file filter_by_radius.h.
◆ yCenter
| double gpudb::FilterByRadiusRequest::yCenter |
Value of the latitude of the center.
Must be within [-90.0, 90.0]. The minimum allowed value is -90. The maximum allowed value is 90.
Definition at line 181 of file filter_by_radius.h.
◆ yColumnName
| std::string gpudb::FilterByRadiusRequest::yColumnName |
Name of the column to be used for the y-coordinate-the latitude-of the center.
Definition at line 175 of file filter_by_radius.h.
The documentation for this struct was generated from the following file:
- gpudb/protocol/filter_by_radius.h