com.gpudb.protocol

Class FilterRequest

java.lang.Object

com.gpudb.protocol.FilterRequest

All Implemented Interfaces:

org.apache.avro.generic.GenericContainer, org.apache.avro.generic.IndexedRecord

public class FilterRequest
extends Object
implements org.apache.avro.generic.IndexedRecord

A set of parameters for GPUdb.filter(FilterRequest).

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.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FilterRequest.Options Optional parameters.

Constructor Summary

Constructors

Constructor and Description
FilterRequest() Constructs a FilterRequest object with default parameters.
FilterRequest(String tableName, String viewName, String expression, Map<String,String> options) Constructs a FilterRequest object with the specified parameters.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
Object	get(int index) This method supports the Avro framework and is not intended to be called directly by the user.
static org.apache.avro.Schema	getClassSchema() This method supports the Avro framework and is not intended to be called directly by the user.
String	getExpression()
Map<String,String>	getOptions()
org.apache.avro.Schema	getSchema() This method supports the Avro framework and is not intended to be called directly by the user.
String	getTableName()
String	getViewName()
int	hashCode()
void	put(int index, Object value) This method supports the Avro framework and is not intended to be called directly by the user.
FilterRequest	setExpression(String expression)
FilterRequest	setOptions(Map<String,String> options)
FilterRequest	setTableName(String tableName)
FilterRequest	setViewName(String viewName)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

FilterRequest

public FilterRequest()

Constructs a FilterRequest object with default parameters.

FilterRequest

public FilterRequest(String tableName,
                     String viewName,
                     String expression,
                     Map<String,String> options)

Constructs a FilterRequest object with the specified parameters.

Parameters:

tableName - Name 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).

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 ''.

expression - The select expression to filter the specified table. For details see Expressions.

options - Optional parameters.

• 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:
  • TRUE
  • FALSE
  The default value is FALSE.
• COLLECTION_NAME: [DEPRECATED--please specify the containing schema for the view as part of viewName and use GPUdb.createSchema(CreateSchemaRequest) 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.
• VIEW_ID: view this filtered-view is part of. The default value is ''.
• TTL: Sets the TTL of the view specified in viewName.

The default value is an empty Map.

Method Detail

getClassSchema

public static org.apache.avro.Schema getClassSchema()

This method supports the Avro framework and is not intended to be called directly by the user.

Returns:

the schema for the class.

getTableName

public String getTableName()

Returns:

Name 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).

setTableName

public FilterRequest setTableName(String tableName)

Parameters:

tableName - Name 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).

Returns:

this to mimic the builder pattern.

getViewName

public String getViewName()

Returns:

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 ''.

setViewName

public FilterRequest setViewName(String viewName)

Parameters:

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 ''.

Returns:

this to mimic the builder pattern.

getExpression

public String getExpression()

Returns:

The select expression to filter the specified table. For details see Expressions.

setExpression

public FilterRequest setExpression(String expression)

Parameters:

expression - The select expression to filter the specified table. For details see Expressions.

Returns:

this to mimic the builder pattern.

getOptions

public Map<String,String> getOptions()

Returns:

Optional parameters.

• 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:
  • TRUE
  • FALSE
  The default value is FALSE.
• COLLECTION_NAME: [DEPRECATED--please specify the containing schema for the view as part of viewName and use GPUdb.createSchema(CreateSchemaRequest) 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.
• VIEW_ID: view this filtered-view is part of. The default value is ''.
• TTL: Sets the TTL of the view specified in viewName.

The default value is an empty Map.

setOptions

public FilterRequest setOptions(Map<String,String> options)

Parameters:

options - Optional parameters.

• 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:
  • TRUE
  • FALSE
  The default value is FALSE.
• COLLECTION_NAME: [DEPRECATED--please specify the containing schema for the view as part of viewName and use GPUdb.createSchema(CreateSchemaRequest) 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.
• VIEW_ID: view this filtered-view is part of. The default value is ''.
• TTL: Sets the TTL of the view specified in viewName.

The default value is an empty Map.

Returns:

this to mimic the builder pattern.

getSchema

public org.apache.avro.Schema getSchema()

This method supports the Avro framework and is not intended to be called directly by the user.

Specified by:

getSchema in interface org.apache.avro.generic.GenericContainer

Returns:

the schema object describing this class.

get

public Object get(int index)

This method supports the Avro framework and is not intended to be called directly by the user.

Specified by:

get in interface org.apache.avro.generic.IndexedRecord

Parameters:

index - the position of the field to get

Returns:

value of the field with the given index.

Throws:

IndexOutOfBoundsException

put

public void put(int index,
                Object value)

This method supports the Avro framework and is not intended to be called directly by the user.

Specified by:

put in interface org.apache.avro.generic.IndexedRecord

Parameters:

index - the position of the field to set

value - the value to set

Throws:

IndexOutOfBoundsException

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object