Skip to main content

◆ filter() [1/4]

FilterResponse gpudb::GPUdb::filter (const FilterRequest &request_) const

Filters data based on the specified expression.

The results are stored in a result set with the given viewName.

For details see Expressions.

The response message contains the number of points for which the expression evaluated to be true, which is equivalent to the size of the result view.

Parameters
[in]request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

◆ filter() [2/4]

FilterResponse & gpudb::GPUdb::filter (const FilterRequest &request_,
FilterResponse &response_ ) const

Filters data based on the specified expression.

The results are stored in a result set with the given viewName.

For details see Expressions.

The response message contains the number of points for which the expression evaluated to be true, which is equivalent to the size of the result view.

Parameters
[in]request_Request object containing the parameters for the operation.
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

◆ filter() [3/4]

FilterResponse gpudb::GPUdb::filter (const std::string &tableName,
const std::string &viewName,
const std::string &expression,
const std::map< std::string, std::string > &options ) const

Filters data based on the specified expression.

The results are stored in a result set with the given viewName.

For details see Expressions.

The response message contains the number of points for which the expression evaluated to be true, which is equivalent to the size of the result view.

Parameters
[in]tableNameName of the table to filter, in [schema_name.]table_name format, using standard name resolution rules. This may be the name of a table or a view (when chaining queries).
[in]viewNameIf 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]expressionThe select expression to filter the specified table. For details see Expressions.
[in]optionsOptional parameters.
  • filter_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_false.
  • filter_collection_name: [DEPRECATED–please specify the containing schema for the view as part of viewName and use 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_view_id: View this filtered-view is part of. The default value is ”.
  • filter_ttl: Sets the TTL of the view specified in viewName.
The default value is an empty map.
Returns
Response object containing the result of the operation.

◆ filter() [4/4]

FilterResponse & gpudb::GPUdb::filter (const std::string &tableName,
const std::string &viewName,
const std::string &expression,
const std::map< std::string, std::string > &options,
FilterResponse &response_ ) const

Filters data based on the specified expression.

The results are stored in a result set with the given viewName.

For details see Expressions.

The response message contains the number of points for which the expression evaluated to be true, which is equivalent to the size of the result view.

Parameters
[in]tableNameName of the table to filter, in [schema_name.]table_name format, using standard name resolution rules. This may be the name of a table or a view (when chaining queries).
[in]viewNameIf 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]expressionThe select expression to filter the specified table. For details see Expressions.
[in]optionsOptional parameters.
  • filter_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_false.
  • filter_collection_name: [DEPRECATED–please specify the containing schema for the view as part of viewName and use 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_view_id: View this filtered-view is part of. The default value is ”.
  • filter_ttl: Sets the TTL of the view specified in viewName.
The default value is an empty map.
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).