com.gpudb.protocol

Class CreateTableRequest

java.lang.Object

com.gpudb.protocol.CreateTableRequest

All Implemented Interfaces:

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

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

A set of parameters for GPUdb.createTable(CreateTableRequest).

Creates a new table or collection in GPUdb. If a new table is being created then type of the table is given by typeId which must the be the type id of a currently registered type (i.e. one created via GPUdb.createType(CreateTypeRequest)). The table will be created inside a collection if the option *collection_name* is specified. If that collection does not already exist then it will be created. To create a new, empty collection specify the collection name in tableName, leave typeId blank, and set the *is_collection* option to 'true'.

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

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

Methods inherited from class java.lang.Object

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

Constructor Detail

CreateTableRequest

public CreateTableRequest()

Constructs a CreateTableRequest object with default parameters.

CreateTableRequest

public CreateTableRequest(String tableName,
                          String typeId,
                          Map<String,String> options)

Constructs a CreateTableRequest object with the specified parameters.

Parameters:

tableName - Name of the table to be created. Must not be the name of a currently existing GPUdb table of a different type. Error for requests with existing table of the same name and type id may be suppressed by using the no_error_if_exists option. Cannot be an empty string. Valid characters are 'A-Za-z0-9_-(){}[] .:' (excluding the single quote), with the first character being one of 'A-Za-z0-9_'. The maximum length is 256 characters.

typeId - ID of a currently registered type in GPUdb. All objects added to the newly created table will be of this type. Must be an empty string if the *is_collection* is 'true'.

options - Optional parameters.

• no_error_if_exists: If true, prevents an error from occurring if the table already exists and is of the given type. If a table with the same ID but a different type exists, it is still an error. Values: true, false.
• collection_name: Name of a collection in GPUdb to which the newly created table is to be assigned as a child table. If empty, then the newly created table will be a top level table. If the collection does not allow duplicate children, then this table creation request will fail if there is an existing child table with the same type id specified in this request.
• is_collection: Indicates whether the new table to be created will be a collection. If false, the created table will be a top level table. Values: true, false.
• disallow_homogeneous_tables: For a collection, indicates whether multiple children of exactly the same data type will be allowed. Values: true, false.
• is_replicated: For a Table, this is an indication to GPUdb to replicate the table to all the ranks. This is only required when the table will be used to join with other tables in a query. Values: true, false.
• foreign_keys: Semicolon-separated list of foreign key constraints, of the format 'my_field references primary_table(primary_key_field)'.

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. Must not be the name of a currently existing GPUdb table of a different type. Error for requests with existing table of the same name and type id may be suppressed by using the no_error_if_exists option. Cannot be an empty string. Valid characters are 'A-Za-z0-9_-(){}[] .:' (excluding the single quote), with the first character being one of 'A-Za-z0-9_'. The maximum length is 256 characters.

setTableName

public CreateTableRequest setTableName(String tableName)

Parameters:

tableName - Name of the table to be created. Must not be the name of a currently existing GPUdb table of a different type. Error for requests with existing table of the same name and type id may be suppressed by using the no_error_if_exists option. Cannot be an empty string. Valid characters are 'A-Za-z0-9_-(){}[] .:' (excluding the single quote), with the first character being one of 'A-Za-z0-9_'. The maximum length is 256 characters.

Returns:

this to mimic the builder pattern.

getTypeId

public String getTypeId()

Returns:

ID of a currently registered type in GPUdb. All objects added to the newly created table will be of this type. Must be an empty string if the *is_collection* is 'true'.

setTypeId

public CreateTableRequest setTypeId(String typeId)

Parameters:

typeId - ID of a currently registered type in GPUdb. All objects added to the newly created table will be of this type. Must be an empty string if the *is_collection* is 'true'.

Returns:

this to mimic the builder pattern.

getOptions

public Map<String,String> getOptions()

Returns:

Optional parameters.

• no_error_if_exists: If true, prevents an error from occurring if the table already exists and is of the given type. If a table with the same ID but a different type exists, it is still an error. Values: true, false.
• collection_name: Name of a collection in GPUdb to which the newly created table is to be assigned as a child table. If empty, then the newly created table will be a top level table. If the collection does not allow duplicate children, then this table creation request will fail if there is an existing child table with the same type id specified in this request.
• is_collection: Indicates whether the new table to be created will be a collection. If false, the created table will be a top level table. Values: true, false.
• disallow_homogeneous_tables: For a collection, indicates whether multiple children of exactly the same data type will be allowed. Values: true, false.
• is_replicated: For a Table, this is an indication to GPUdb to replicate the table to all the ranks. This is only required when the table will be used to join with other tables in a query. Values: true, false.
• foreign_keys: Semicolon-separated list of foreign key constraints, of the format 'my_field references primary_table(primary_key_field)'.

setOptions

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

Parameters:

options - Optional parameters.

• no_error_if_exists: If true, prevents an error from occurring if the table already exists and is of the given type. If a table with the same ID but a different type exists, it is still an error. Values: true, false.
• collection_name: Name of a collection in GPUdb to which the newly created table is to be assigned as a child table. If empty, then the newly created table will be a top level table. If the collection does not allow duplicate children, then this table creation request will fail if there is an existing child table with the same type id specified in this request.
• is_collection: Indicates whether the new table to be created will be a collection. If false, the created table will be a top level table. Values: true, false.
• disallow_homogeneous_tables: For a collection, indicates whether multiple children of exactly the same data type will be allowed. Values: true, false.
• is_replicated: For a Table, this is an indication to GPUdb to replicate the table to all the ranks. This is only required when the table will be used to join with other tables in a query. Values: true, false.
• foreign_keys: Semicolon-separated list of foreign key constraints, of the format 'my_field references primary_table(primary_key_field)'.

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