A set of parameters for GPUdb::filterByTable. More…
#include <gpudb/protocol/filter_by_table.h>
Public Member Functions | |
| FilterByTableRequest () | |
| Constructs a FilterByTableRequest object with default parameters. | |
| 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. | |
Public Attributes | |
| std::string | tableName |
| Name of the table whose data will be filtered, in [ schema_name. | |
| 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 | columnName |
| Name of the column by whose value the data will be filtered from the table designated by tableName. | |
| std::string | sourceTableName |
| Name of the table whose data will be compared against in the table called tableName, in [ schema_name. ]table_name format, using standard name resolution rules. | |
| std::string | sourceTableColumnName |
| Name of the column in the sourceTableName whose values will be used as the filter for table tableName. | |
| std::map< std::string, std::string > | options |
| Optional parameters. | |
Detailed Description
A set of parameters for GPUdb::filterByTable.
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
◆ FilterByTableRequest() [1/2]
| inline |
Constructs a FilterByTableRequest object with default parameters.
Definition at line 31 of file filter_by_table.h.
◆ FilterByTableRequest() [2/2]
| inline |
Constructs a FilterByTableRequest object with the specified parameters.
| [in] | tableName_ | Name of the table whose data will be filtered, 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] | 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_, in [schema_name.]table_name format, using standard name resolution rules. 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.
|
Definition at line 217 of file filter_by_table.h.
Member Data Documentation
◆ columnName
| std::string gpudb::FilterByTableRequest::columnName |
Name of the column by whose value the data will be filtered from the table designated by tableName.
Definition at line 250 of file filter_by_table.h.
◆ options
| std::map<std::string, std::string> gpudb::FilterByTableRequest::options |
Optional parameters.
- filter_by_table_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_table_false.
- filter_by_table_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 for the newly created view. If the schema is non-existent, it will be automatically created.
- filter_by_table_filter_mode: String indicating the filter mode, either in_table or not_in_table. Supported values:The default value is filter_by_table_in_table.
- filter_by_table_mode: Mode - should be either spatial or normal. Supported values:The default value is filter_by_table_normal.
- filter_by_table_buffer: Buffer size, in meters. Only relevant for spatial mode. The default value is ‘0’.
- filter_by_table_buffer_method: Method used to buffer polygons. Only relevant for spatial mode. Supported values:
- filter_by_table_normal
- filter_by_table_geos: Use geos 1 edge per corner algorithm.
- filter_by_table_max_partition_size: Maximum number of points in a partition. Only relevant for spatial mode. The default value is ‘0’.
- filter_by_table_max_partition_score: Maximum number of points * edges in a partition. Only relevant for spatial mode. The default value is ‘8000000’.
- filter_by_table_x_column_name: Name of column containing x value of point being filtered in spatial mode. The default value is ‘x’.
- filter_by_table_y_column_name: Name of column containing y value of point being filtered in spatial mode. The default value is ‘y’.
The default value is an empty map.
Definition at line 363 of file filter_by_table.h.
◆ sourceTableColumnName
| std::string gpudb::FilterByTableRequest::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.
Definition at line 266 of file filter_by_table.h.
◆ sourceTableName
| std::string gpudb::FilterByTableRequest::sourceTableName |
Name of the table whose data will be compared against in the table called tableName, in [ schema_name. ]table_name format, using standard name resolution rules.
Must be an existing table.
Definition at line 258 of file filter_by_table.h.
◆ tableName
| std::string gpudb::FilterByTableRequest::tableName |
Name of the table whose data will be filtered, in [ schema_name.
\ ]table_name format, using standard name resolution rules. Must be an existing table.
Definition at line 233 of file filter_by_table.h.
◆ viewName
| std::string gpudb::FilterByTableRequest::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 244 of file filter_by_table.h.
The documentation for this struct was generated from the following file:
- gpudb/protocol/filter_by_table.h