GPUdb C++ API  Version 6.0.1.0
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends
gpudb::FilterByAreaResponse Struct Reference

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

#include <gpudb/protocol/filter_by_area.h>

Public Member Functions

 FilterByAreaResponse ()
 Constructs a FilterByAreaResponse object with default parameter values. More...
 

Public Attributes

int64_t count
 

Detailed Description

A set of output parameters for const.

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.

Note that if you call this endpoint using a table that has WKT data, the x_column_name and y_column_name settings are no longer required because the geospatial filter works automatically.

Definition at line 183 of file filter_by_area.h.

Constructor & Destructor Documentation

gpudb::FilterByAreaResponse::FilterByAreaResponse ( )
inline

Constructs a FilterByAreaResponse object with default parameter values.

Definition at line 190 of file filter_by_area.h.

Member Data Documentation

int64_t gpudb::FilterByAreaResponse::count

Definition at line 195 of file filter_by_area.h.


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