com.gpudb.protocol

Class CreateMaterializedViewRequest

java.lang.Object

com.gpudb.protocol.CreateMaterializedViewRequest

All Implemented Interfaces:

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

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

A set of parameters for GPUdb.createMaterializedView(CreateMaterializedViewRequest).

Initiates the process of creating a materialized view, reserving the view's name to prevent other views or tables from being created with that name.

For materialized view details and examples, see Materialized Views.

The response contains viewId, which is used to tag each subsequent operation (projection, union, aggregation, filter, or join) that will compose the view.

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
CreateMaterializedViewRequest() Constructs a CreateMaterializedViewRequest object with default parameters.
CreateMaterializedViewRequest(String tableName, Map<String,String> options) Constructs a CreateMaterializedViewRequest 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.
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()
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.
CreateMaterializedViewRequest	setOptions(Map<String,String> options)
CreateMaterializedViewRequest	setTableName(String tableName)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

CreateMaterializedViewRequest

public CreateMaterializedViewRequest()

Constructs a CreateMaterializedViewRequest object with default parameters.

CreateMaterializedViewRequest

public CreateMaterializedViewRequest(String tableName,
                                     Map<String,String> options)

Constructs a CreateMaterializedViewRequest object with the specified parameters.

Parameters:

tableName - Name of the table to be created that is the top-level table of the materialized view, in [schema_name.]table_name format, using standard name resolution rules and meeting table naming criteria.

options - Optional parameters.

• COLLECTION_NAME: [DEPRECATED--please specify the containing schema for the materialized view as part of tableName and use GPUdb.createSchema(CreateSchemaRequest) to create the schema if non-existent] Name of a schema which is to contain the newly created view. If the schema provided is non-existent, it will be automatically created.
• EXECUTE_AS: User name to use to run the refresh job
• PERSIST: If true, then the materialized view specified in tableName will be persisted and will not expire unless a ttl is specified. If false, then the materialized view will be an in-memory table and will expire unless a ttl is specified otherwise. Supported values:
  • TRUE
  • FALSE
  The default value is FALSE.
• REFRESH_SPAN: Sets the future time-offset(in seconds) at which periodic refresh stops
• REFRESH_STOP_TIME: When refresh_method is periodic, specifies the time at which a periodic refresh is stopped. Value is a datetime string with format 'YYYY-MM-DD HH:MM:SS'.
• REFRESH_METHOD: Method by which the join can be refreshed when the data in underlying member tables have changed. Supported values:
  • MANUAL: Refresh only occurs when manually requested by calling GPUdb.alterTable(AlterTableRequest) with an 'action' of 'refresh'
  • ON_QUERY: Refresh any time the view is queried.
  • ON_CHANGE: If possible, incrementally refresh (refresh just those records added) whenever an insert, update, delete or refresh of input table is done. A full refresh is done if an incremental refresh is not possible.
  • PERIODIC: Refresh table periodically at rate specified by refresh_period
  The default value is MANUAL.
• REFRESH_PERIOD: When refresh_method is periodic, specifies the period in seconds at which refresh occurs
• REFRESH_START_TIME: When refresh_method is periodic, specifies the first time at which a refresh is to be done. Value is a datetime string with format 'YYYY-MM-DD HH:MM:SS'.
• TTL: Sets the TTL of the table specified in tableName.

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 be created that is the top-level table of the materialized view, in [schema_name.]table_name format, using standard name resolution rules and meeting table naming criteria.

setTableName

public CreateMaterializedViewRequest setTableName(String tableName)

Parameters:

tableName - Name of the table to be created that is the top-level table of the materialized view, in [schema_name.]table_name format, using standard name resolution rules and meeting table naming criteria.

Returns:

this to mimic the builder pattern.

getOptions

public Map<String,String> getOptions()

Returns:

Optional parameters.

• COLLECTION_NAME: [DEPRECATED--please specify the containing schema for the materialized view as part of tableName and use GPUdb.createSchema(CreateSchemaRequest) to create the schema if non-existent] Name of a schema which is to contain the newly created view. If the schema provided is non-existent, it will be automatically created.
• EXECUTE_AS: User name to use to run the refresh job
• PERSIST: If true, then the materialized view specified in tableName will be persisted and will not expire unless a ttl is specified. If false, then the materialized view will be an in-memory table and will expire unless a ttl is specified otherwise. Supported values:
  • TRUE
  • FALSE
  The default value is FALSE.
• REFRESH_SPAN: Sets the future time-offset(in seconds) at which periodic refresh stops
• REFRESH_STOP_TIME: When refresh_method is periodic, specifies the time at which a periodic refresh is stopped. Value is a datetime string with format 'YYYY-MM-DD HH:MM:SS'.
• REFRESH_METHOD: Method by which the join can be refreshed when the data in underlying member tables have changed. Supported values:
  • MANUAL: Refresh only occurs when manually requested by calling GPUdb.alterTable(AlterTableRequest) with an 'action' of 'refresh'
  • ON_QUERY: Refresh any time the view is queried.
  • ON_CHANGE: If possible, incrementally refresh (refresh just those records added) whenever an insert, update, delete or refresh of input table is done. A full refresh is done if an incremental refresh is not possible.
  • PERIODIC: Refresh table periodically at rate specified by refresh_period
  The default value is MANUAL.
• REFRESH_PERIOD: When refresh_method is periodic, specifies the period in seconds at which refresh occurs
• REFRESH_START_TIME: When refresh_method is periodic, specifies the first time at which a refresh is to be done. Value is a datetime string with format 'YYYY-MM-DD HH:MM:SS'.
• TTL: Sets the TTL of the table specified in tableName.

The default value is an empty Map.

setOptions

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

Parameters:

options - Optional parameters.

• COLLECTION_NAME: [DEPRECATED--please specify the containing schema for the materialized view as part of tableName and use GPUdb.createSchema(CreateSchemaRequest) to create the schema if non-existent] Name of a schema which is to contain the newly created view. If the schema provided is non-existent, it will be automatically created.
• EXECUTE_AS: User name to use to run the refresh job
• PERSIST: If true, then the materialized view specified in tableName will be persisted and will not expire unless a ttl is specified. If false, then the materialized view will be an in-memory table and will expire unless a ttl is specified otherwise. Supported values:
  • TRUE
  • FALSE
  The default value is FALSE.
• REFRESH_SPAN: Sets the future time-offset(in seconds) at which periodic refresh stops
• REFRESH_STOP_TIME: When refresh_method is periodic, specifies the time at which a periodic refresh is stopped. Value is a datetime string with format 'YYYY-MM-DD HH:MM:SS'.
• REFRESH_METHOD: Method by which the join can be refreshed when the data in underlying member tables have changed. Supported values:
  • MANUAL: Refresh only occurs when manually requested by calling GPUdb.alterTable(AlterTableRequest) with an 'action' of 'refresh'
  • ON_QUERY: Refresh any time the view is queried.
  • ON_CHANGE: If possible, incrementally refresh (refresh just those records added) whenever an insert, update, delete or refresh of input table is done. A full refresh is done if an incremental refresh is not possible.
  • PERIODIC: Refresh table periodically at rate specified by refresh_period
  The default value is MANUAL.
• REFRESH_PERIOD: When refresh_method is periodic, specifies the period in seconds at which refresh occurs
• REFRESH_START_TIME: When refresh_method is periodic, specifies the first time at which a refresh is to be done. Value is a datetime string with format 'YYYY-MM-DD HH:MM:SS'.
• TTL: Sets the TTL of the table specified in tableName.

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