gpudb::FilterByTableRequest Struct Reference

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

#include <gpudb/protocol/filter_by_table.h>

Public Member Functions
	FilterByTableRequest ()
	Constructs a FilterByTableRequest object with default parameter values. More...
	FilterByTableRequest (const std::string &tableName_, const std::string &viewName_, const std::string &columnName_, const std::string &sourceTableName_, const std::string &sourceTableColumnName_, const std::map< std::string, std::string > &options_)
	Constructs a FilterByTableRequest object with the specified parameters. More...

Public Attributes
std::string	tableName
std::string	viewName
std::string	columnName
std::string	sourceTableName
std::string	sourceTableColumnName
std::map< std::string, std::string >	options

Detailed Description

A set of input parameters for const.

Filters objects in one table based on objects in another table. The user must specify matching column types from the two tables (i.e. the target table from which objects will be filtered and the source table based on which the filter will be created); the column names need not be the same. If a viewName is specified, then the filtered objects will then be put in a newly created view. The operation is synchronous, meaning that a response will not be returned until all objects are fully available in the result view. The return value contains the count (i.e. the size) of the resulting view.

Definition at line 26 of file filter_by_table.h.

Constructor & Destructor Documentation

gpudb::FilterByTableRequest::FilterByTableRequest ( )

inline

Constructs a FilterByTableRequest object with default parameter values.

Definition at line 33 of file filter_by_table.h.

gpudb::FilterByTableRequest::FilterByTableRequest ( const std::string &  tableName_, const std::string &  viewName_, const std::string &  columnName_, const std::string &  sourceTableName_, const std::string &  sourceTableColumnName_, const std::map< std::string, std::string > &  options_  )

inline

Constructs a FilterByTableRequest object with the specified parameters.

Parameters

[in]	tableName_	Name of the table whose data will be filtered. Must be an existing table.
[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 by whose value the data will be filtered from the table designated by tableName.
[in]	sourceTableName_	Name of the table whose data will be compared against in the table called tableName. Must be an existing table.
[in]	sourceTableColumnName_	Name of the column in the sourceTableName whose values will be used as the filter for table tableName. Must be a geospatial geometry column if in 'spatial' mode; otherwise, Must match the type of the columnName.
[in]	options_	Optional parameters. gpudb::filter_by_table_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. gpudb::filter_by_table_filter_mode: String indicating the filter mode, either in_table or not_in_table. gpudb::filter_by_table_in_table gpudb::filter_by_table_not_in_table The default value is gpudb::filter_by_table_in_table. gpudb::filter_by_table_mode: Mode should be either spatial or normal. gpudb::filter_by_table_normal gpudb::filter_by_table_spatial The default value is gpudb::filter_by_table_normal. gpudb::filter_by_table_buffer: Buffer size, in meters. Only relevant for spatial mode. The default value is '0'. gpudb::filter_by_table_buffer_method: Method used to buffer polygons. Only relevant for spatial mode. gpudb::filter_by_table_normal gpudb::filter_by_table_geos: Use geos 1 edge per corner algorithm The default value is gpudb::filter_by_table_normal. gpudb::filter_by_table_max_partition_size: Maximum number of points in a partition. Only relevant for spatial mode. The default value is '0'. gpudb::filter_by_table_max_partition_score: Maximum number of points * edges in a partition. Only relevant for spatial mode. The default value is '8000000'. gpudb::filter_by_table_x_column_name: Name of column containing x value of point being filtered in spatial mode. The default value is 'x'. gpudb::filter_by_table_y_column_name: Name of column containing y value of point being filtered in spatial mode. The default value is 'y'.

Definition at line 133 of file filter_by_table.h.

Member Data Documentation

std::string gpudb::FilterByTableRequest::columnName

Definition at line 145 of file filter_by_table.h.

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

Definition at line 148 of file filter_by_table.h.

std::string gpudb::FilterByTableRequest::sourceTableColumnName

Definition at line 147 of file filter_by_table.h.

std::string gpudb::FilterByTableRequest::sourceTableName

Definition at line 146 of file filter_by_table.h.

std::string gpudb::FilterByTableRequest::tableName

Definition at line 143 of file filter_by_table.h.

std::string gpudb::FilterByTableRequest::viewName

Definition at line 144 of file filter_by_table.h.

---

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

• gpudb/protocol/filter_by_table.h