GPUdb C++ API  Version 7.0.19.0
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
gpudb::FilterByGeometryRequest Struct Reference

A set of input parameters for const. More...

#include <gpudb/protocol/filter_by_geometry.h>

Public Member Functions

 FilterByGeometryRequest ()
 Constructs a FilterByGeometryRequest object with default parameter values. More...
 
 FilterByGeometryRequest (const std::string &tableName_, const std::string &viewName_, const std::string &columnName_, const std::string &inputWkt_, const std::string &operation_, const std::map< std::string, std::string > &options_)
 Constructs a FilterByGeometryRequest object with the specified parameters. More...
 

Public Attributes

std::string tableName
 
std::string viewName
 
std::string columnName
 
std::string inputWkt
 
std::string operation
 
std::map< std::string,
std::string > 
options
 

Detailed Description

A set of input parameters for const.

Applies a geometry filter against a geospatial geometry column in a given table, collection or view. The filtering geometry is provided by inputWkt.

Definition at line 20 of file filter_by_geometry.h.

Constructor & Destructor Documentation

gpudb::FilterByGeometryRequest::FilterByGeometryRequest ( )
inline

Constructs a FilterByGeometryRequest object with default parameter values.

Definition at line 27 of file filter_by_geometry.h.

gpudb::FilterByGeometryRequest::FilterByGeometryRequest ( const std::string &  tableName_,
const std::string &  viewName_,
const std::string &  columnName_,
const std::string &  inputWkt_,
const std::string &  operation_,
const std::map< std::string, std::string > &  options_ 
)
inline

Constructs a FilterByGeometryRequest object with the specified parameters.

Parameters
[in]tableName_Name of the table on which the filter by geometry will be performed. Must be an existing table, collection or view containing a geospatial geometry column.
[in]viewName_If provided, then this will be the name of the view containing the results. Has the same naming restrictions as tables.
[in]columnName_Name of the column to be used in the filter. Must be a geospatial geometry column.
[in]inputWkt_A geometry in WKT format that will be used to filter the objects in tableName.
[in]operation_The geometric filtering operation to perform
[in]options_Optional parameters.
  • gpudb::filter_by_geometry_collection_name: Name of a collection which is to contain the newly created view. If the collection provided is non-existent, the collection will be automatically created. If empty, then the newly created view will be top-level.

Definition at line 95 of file filter_by_geometry.h.

Member Data Documentation

std::string gpudb::FilterByGeometryRequest::columnName

Definition at line 107 of file filter_by_geometry.h.

std::string gpudb::FilterByGeometryRequest::inputWkt

Definition at line 108 of file filter_by_geometry.h.

std::string gpudb::FilterByGeometryRequest::operation

Definition at line 109 of file filter_by_geometry.h.

std::map<std::string, std::string> gpudb::FilterByGeometryRequest::options

Definition at line 110 of file filter_by_geometry.h.

std::string gpudb::FilterByGeometryRequest::tableName

Definition at line 105 of file filter_by_geometry.h.

std::string gpudb::FilterByGeometryRequest::viewName

Definition at line 106 of file filter_by_geometry.h.


The documentation for this struct was generated from the following file: