com.gpudb.protocol

Class FilterByTableRequest

java.lang.Object

com.gpudb.protocol.FilterByTableRequest

All Implemented Interfaces:

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

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

A set of parameters for GPUdb.filterByTable(FilterByTableRequest).

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.

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
FilterByTableRequest() Constructs a FilterByTableRequest object with default parameters.
FilterByTableRequest(String tableName, String viewName, String columnName, String sourceTableName, String sourceTableColumnName, Map<String,String> options) Constructs a FilterByTableRequest 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	getColumnName()
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	getSourceTableColumnName()
String	getSourceTableName()
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.
FilterByTableRequest	setColumnName(String columnName)
FilterByTableRequest	setOptions(Map<String,String> options)
FilterByTableRequest	setSourceTableColumnName(String sourceTableColumnName)
FilterByTableRequest	setSourceTableName(String sourceTableName)
FilterByTableRequest	setTableName(String tableName)
FilterByTableRequest	setViewName(String viewName)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

FilterByTableRequest

public FilterByTableRequest()

Constructs a FilterByTableRequest object with default parameters.

FilterByTableRequest

public FilterByTableRequest(String tableName,
                            String viewName,
                            String columnName,
                            String sourceTableName,
                            String sourceTableColumnName,
                            Map<String,String> options)

Constructs a FilterByTableRequest object with the specified parameters.

Parameters:

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.

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

columnName - Name of the column by whose value the data will be filtered from the table designated by tableName.

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.

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.

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.
• FILTER_MODE: String indicating the filter mode, either in_table or not_in_table. Supported values:
  • IN_TABLE
  • NOT_IN_TABLE
  The default value is IN_TABLE.
• MODE: Mode - should be either spatial or normal. Supported values:
  • NORMAL
  • SPATIAL
  The default value is NORMAL.
• BUFFER: Buffer size, in meters. Only relevant for spatial mode. The default value is '0'.
• BUFFER_METHOD: Method used to buffer polygons. Only relevant for spatial mode. Supported values:
  • NORMAL
  • GEOS: Use geos 1 edge per corner algorithm
  The default value is NORMAL.
• MAX_PARTITION_SIZE: Maximum number of points in a partition. Only relevant for spatial mode. The default value is '0'.
• MAX_PARTITION_SCORE: Maximum number of points * edges in a partition. Only relevant for spatial mode. The default value is '8000000'.
• X_COLUMN_NAME: Name of column containing x value of point being filtered in spatial mode. The default value is 'x'.
• 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.

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 whose data will be filtered, in [schema_name.]table_name format, using standard name resolution rules. Must be an existing table.

setTableName

public FilterByTableRequest setTableName(String tableName)

Parameters:

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.

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

getColumnName

public String getColumnName()

Returns:

Name of the column by whose value the data will be filtered from the table designated by tableName.

setColumnName

public FilterByTableRequest setColumnName(String columnName)

Parameters:

columnName - Name of the column by whose value the data will be filtered from the table designated by tableName.

Returns:

this to mimic the builder pattern.

getSourceTableName

public String getSourceTableName()

Returns:

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.

setSourceTableName

public FilterByTableRequest setSourceTableName(String sourceTableName)

Parameters:

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.

Returns:

this to mimic the builder pattern.

getSourceTableColumnName

public String getSourceTableColumnName()

Returns:

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.

setSourceTableColumnName

public FilterByTableRequest setSourceTableColumnName(String sourceTableColumnName)

Parameters:

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.

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.
• FILTER_MODE: String indicating the filter mode, either in_table or not_in_table. Supported values:
  • IN_TABLE
  • NOT_IN_TABLE
  The default value is IN_TABLE.
• MODE: Mode - should be either spatial or normal. Supported values:
  • NORMAL
  • SPATIAL
  The default value is NORMAL.
• BUFFER: Buffer size, in meters. Only relevant for spatial mode. The default value is '0'.
• BUFFER_METHOD: Method used to buffer polygons. Only relevant for spatial mode. Supported values:
  • NORMAL
  • GEOS: Use geos 1 edge per corner algorithm
  The default value is NORMAL.
• MAX_PARTITION_SIZE: Maximum number of points in a partition. Only relevant for spatial mode. The default value is '0'.
• MAX_PARTITION_SCORE: Maximum number of points * edges in a partition. Only relevant for spatial mode. The default value is '8000000'.
• X_COLUMN_NAME: Name of column containing x value of point being filtered in spatial mode. The default value is 'x'.
• 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.

setOptions

public FilterByTableRequest 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.
• FILTER_MODE: String indicating the filter mode, either in_table or not_in_table. Supported values:
  • IN_TABLE
  • NOT_IN_TABLE
  The default value is IN_TABLE.
• MODE: Mode - should be either spatial or normal. Supported values:
  • NORMAL
  • SPATIAL
  The default value is NORMAL.
• BUFFER: Buffer size, in meters. Only relevant for spatial mode. The default value is '0'.
• BUFFER_METHOD: Method used to buffer polygons. Only relevant for spatial mode. Supported values:
  • NORMAL
  • GEOS: Use geos 1 edge per corner algorithm
  The default value is NORMAL.
• MAX_PARTITION_SIZE: Maximum number of points in a partition. Only relevant for spatial mode. The default value is '0'.
• MAX_PARTITION_SCORE: Maximum number of points * edges in a partition. Only relevant for spatial mode. The default value is '8000000'.
• X_COLUMN_NAME: Name of column containing x value of point being filtered in spatial mode. The default value is 'x'.
• 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.

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