gpudb::FilterByTableRequest Struct Reference

A set of input parameters for filterByTable(const FilterByTableRequest&) 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 filterByTable(const FilterByTableRequest&) 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 GPUdb will not return 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 GPUdb.
[in]	viewName	If provided, then this will be the name of the view containing the results. Must not be an already existing collection, table or view. Default value is an empty string.
[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 GPUdb.
[in]	sourceTableColumnName	Name of the column in the sourceTableName whose values will be used as the filter for table tableName. Must match the type of the columnName.
[in]	options	Optional parameters. Default value is an empty std::map.

Definition at line 69 of file filter_by_table.h.

Member Data Documentation

std::string gpudb::FilterByTableRequest::columnName

Definition at line 81 of file filter_by_table.h.

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

Definition at line 84 of file filter_by_table.h.

std::string gpudb::FilterByTableRequest::sourceTableColumnName

Definition at line 83 of file filter_by_table.h.

std::string gpudb::FilterByTableRequest::sourceTableName

Definition at line 82 of file filter_by_table.h.

std::string gpudb::FilterByTableRequest::tableName

Definition at line 79 of file filter_by_table.h.

std::string gpudb::FilterByTableRequest::viewName

Definition at line 80 of file filter_by_table.h.

---

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

• gpudb/protocol/filter_by_table.h