com.gpudb.protocol

Class AlterTableRequest

java.lang.Object

com.gpudb.protocol.AlterTableRequest

All Implemented Interfaces:

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

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

A set of parameters for GPUdb.alterTable(AlterTableRequest).

Apply various modifications to a table or collection. Available modifications include:

Creating or deleting an index on a particular column. This can speed up certain search queries (such as GPUdb.getRecordsRaw(GetRecordsRequest), GPUdb.deleteRecords(DeleteRecordsRequest), GPUdb.updateRecordsRaw(RawUpdateRecordsRequest)) when using expressions containing equality or relational operators on indexed columns. This only applies to child tables.

Making a table protected or not. Protected tables need the admin password to be sent in a GPUdb.clearTable(ClearTableRequest) to delete the table. This can be applied to child tables or collections or views.

Setting the time-to-live (TTL). This can be applied to tables, views, or collections. When applied to collections, every table & view within the collection will have its TTL set to the given value.

Allowing homogeneous child tables. This only applies to collections.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AlterTableRequest.Action Modification operation to be applied to the table or collection Values: create_index, delete_index, allow_homogeneous_tables, protected, ttl.

Constructor Summary

Constructors

Constructor and Description
AlterTableRequest() Constructs an AlterTableRequest object with default parameters.
AlterTableRequest(String tableName, String action, String value, Map<String,String> options) Constructs an AlterTableRequest 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.
String	getAction()
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()
String	getValue()
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.
AlterTableRequest	setAction(String action)
AlterTableRequest	setOptions(Map<String,String> options)
AlterTableRequest	setTableName(String tableName)
AlterTableRequest	setValue(String value)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

AlterTableRequest

public AlterTableRequest()

Constructs an AlterTableRequest object with default parameters.

AlterTableRequest

public AlterTableRequest(String tableName,
                         String action,
                         String value,
                         Map<String,String> options)

Constructs an AlterTableRequest object with the specified parameters.

Parameters:

tableName - Table on which the operation will be performed. Must be a valid table or collection in GPUdb.

action - Modification operation to be applied to the table or collection Values: create_index, delete_index, allow_homogeneous_tables, protected, ttl.

value - The value of the modification. May be a column name, 'true' or 'false', or a time-to-live depending on action.

options - Optional parameters.

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:

Table on which the operation will be performed. Must be a valid table or collection in GPUdb.

setTableName

public AlterTableRequest setTableName(String tableName)

Parameters:

tableName - Table on which the operation will be performed. Must be a valid table or collection in GPUdb.

Returns:

this to mimic the builder pattern.

getAction

public String getAction()

Returns:

Modification operation to be applied to the table or collection Values: create_index, delete_index, allow_homogeneous_tables, protected, ttl.

setAction

public AlterTableRequest setAction(String action)

Parameters:

action - Modification operation to be applied to the table or collection Values: create_index, delete_index, allow_homogeneous_tables, protected, ttl.

Returns:

this to mimic the builder pattern.

getValue

public String getValue()

Returns:

The value of the modification. May be a column name, 'true' or 'false', or a time-to-live depending on action.

setValue

public AlterTableRequest setValue(String value)

Parameters:

value - The value of the modification. May be a column name, 'true' or 'false', or a time-to-live depending on action.

Returns:

this to mimic the builder pattern.

getOptions

public Map<String,String> getOptions()

Returns:

Optional parameters.

setOptions

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

Parameters:

options - Optional parameters.

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