A set of parameters for GPUdb::filterByValue. More…
#include <gpudb/protocol/filter_by_value.h>
Public Member Functions | |
| FilterByValueRequest () | |
| Constructs a FilterByValueRequest object with default parameters. | |
| FilterByValueRequest (const std::string &tableName_, const std::string &viewName_, const bool isString_, const double value_, const std::string &valueStr_, const std::string &columnName_, const std::map< std::string, std::string > &options_) | |
| Constructs a FilterByValueRequest object with the specified parameters. | |
Public Attributes | |
| std::string | tableName |
| Name of an existing table on which to perform the calculation, in [ schema_name. ]table_name format, using standard name resolution rules. | |
| 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. | |
| bool | isString |
| Indicates whether the value being searched for is string or numeric. | |
| double | value |
| The value to search for. | |
| std::string | valueStr |
| The string value to search for. | |
| std::string | columnName |
| Name of a column on which the filter by value would be applied. | |
| std::map< std::string, std::string > | options |
| Optional parameters. | |
Detailed Description
A set of parameters for GPUdb::filterByValue.
Calculates which objects from a table has a particular value for a particular column. The input parameters provide a way to specify either a String or a Double valued column and a desired value for the column on which the filter is performed. The operation is synchronous, meaning that a response will not be returned until all the objects are fully available. The response payload provides the count of the resulting set. A new result view which satisfies the input filter restriction specification is also created with a view name passed in as part of the input payload. Although this functionality can also be accomplished with the standard filter function, it is more efficient.
Definition at line 27 of file filter_by_value.h.
Constructor & Destructor Documentation
◆ FilterByValueRequest() [1/2]
| inline |
Constructs a FilterByValueRequest object with default parameters.
Definition at line 32 of file filter_by_value.h.
◆ FilterByValueRequest() [2/2]
| inline |
Constructs a FilterByValueRequest object with the specified parameters.
| [in] | tableName_ | Name of an existing table on which to perform the calculation, in [schema_name.]table_name format, using standard name resolution rules. |
| [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] | isString_ | Indicates whether the value being searched for is string or numeric. |
| [in] | value_ | The value to search for. The default value is 0. |
| [in] | valueStr_ | The string value to search for. The default value is ”. |
| [in] | columnName_ | Name of a column on which the filter by value would be applied. |
| [in] | options_ | Optional parameters.
|
Definition at line 112 of file filter_by_value.h.
Member Data Documentation
◆ columnName
| std::string gpudb::FilterByValueRequest::columnName |
Name of a column on which the filter by value would be applied.
Definition at line 160 of file filter_by_value.h.
◆ isString
| bool gpudb::FilterByValueRequest::isString |
Indicates whether the value being searched for is string or numeric.
Definition at line 145 of file filter_by_value.h.
◆ options
| std::map<std::string, std::string> gpudb::FilterByValueRequest::options |
Optional parameters.
- filter_by_value_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_value_false.
- filter_by_value_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.
The default value is an empty map.
Definition at line 194 of file filter_by_value.h.
◆ tableName
| std::string gpudb::FilterByValueRequest::tableName |
Name of an existing table on which to perform the calculation, in [ schema_name. ]table_name format, using standard name resolution rules.
Definition at line 129 of file filter_by_value.h.
◆ value
| double gpudb::FilterByValueRequest::value |
◆ valueStr
| std::string gpudb::FilterByValueRequest::valueStr |
The string value to search for.
The default value is ”.
Definition at line 155 of file filter_by_value.h.
◆ viewName
| std::string gpudb::FilterByValueRequest::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 140 of file filter_by_value.h.
The documentation for this struct was generated from the following file:
- gpudb/protocol/filter_by_value.h