com.gpudb.protocol

Class CreateTypeRequest

java.lang.Object

com.gpudb.protocol.CreateTypeRequest

All Implemented Interfaces:

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

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

A set of parameters for GPUdb.createType(CreateTypeRequest).

Creates a new type in GPUdb describing the layout or schema of a table. The type definition is a JSON string describing the fields (i.e. columns) of the type. Each field consists of a name and a data type. Supported data types are: double, float, int, long, string, and bytes. In addition one or more properties can be specified for each column which customize the memory usage and query availability of that column. Note that some properties are mutually exclusive--i.e. they cannot be specified for any given column simultaneously. One example of mutually exclusive properties are data and store_only.

To set a *primary key* on one or more columns include the property 'primary_key' on the desired column_names. If a primary key is specified then GPUdb enforces a uniqueness constraint in that only a single object can exist with a given primary key. When inserting data into a table with a primary key, depending on the parameters in the request, incoming objects with primary keys that match existing objects will either overwrite (i.e. update) the existing object or will be skipped and not added into the set.

Example of a type definition with some of the parameters::

{"type":"record",
"name":"point",
"fields":[{"name":"msg_id","type":"string"},
{"name":"x","type":"double"},
{"name":"y","type":"double"},
{"name":"TIMESTAMP","type":"double"},
{"name":"source","type":"string"},
{"name":"group_id","type":"string"},
{"name":"OBJECT_ID","type":"string"}]
}

Properties::

{"group_id":["store_only"],
"msg_id":["store_only","text_search"]
}

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CreateTypeRequest.Properties Each key-value pair specifies the properties to use for a given column where the key is the column name.

Constructor Summary

Constructors

Constructor and Description
CreateTypeRequest() Constructs a CreateTypeRequest object with default parameters.
CreateTypeRequest(String typeDefinition, String label, Map<String,List<String>> properties, Map<String,String> options) Constructs a CreateTypeRequest 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	getLabel()
Map<String,String>	getOptions()
Map<String,List<String>>	getProperties()
org.apache.avro.Schema	getSchema() This method supports the Avro framework and is not intended to be called directly by the user.
String	getTypeDefinition()
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.
CreateTypeRequest	setLabel(String label)
CreateTypeRequest	setOptions(Map<String,String> options)
CreateTypeRequest	setProperties(Map<String,List<String>> properties)
CreateTypeRequest	setTypeDefinition(String typeDefinition)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

CreateTypeRequest

public CreateTypeRequest()

Constructs a CreateTypeRequest object with default parameters.

CreateTypeRequest

public CreateTypeRequest(String typeDefinition,
                         String label,
                         Map<String,List<String>> properties,
                         Map<String,String> options)

Constructs a CreateTypeRequest object with the specified parameters.

Parameters:

typeDefinition - a JSON string describing the columns of the type to be registered.

label - A user-defined description string which can be used to differentiate between tables and types with otherwise identical schemas.

properties - Each key-value pair specifies the properties to use for a given column where the key is the column name. All keys used must be relevant column names for the given table. Specifying any property overrides the default properties for that column (which is based on the column's data type).

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.

getTypeDefinition

public String getTypeDefinition()

Returns:

a JSON string describing the columns of the type to be registered.

setTypeDefinition

public CreateTypeRequest setTypeDefinition(String typeDefinition)

Parameters:

typeDefinition - a JSON string describing the columns of the type to be registered.

Returns:

this to mimic the builder pattern.

getLabel

public String getLabel()

Returns:

A user-defined description string which can be used to differentiate between tables and types with otherwise identical schemas.

setLabel

public CreateTypeRequest setLabel(String label)

Parameters:

label - A user-defined description string which can be used to differentiate between tables and types with otherwise identical schemas.

Returns:

this to mimic the builder pattern.

getProperties

public Map<String,List<String>> getProperties()

Returns:

Each key-value pair specifies the properties to use for a given column where the key is the column name. All keys used must be relevant column names for the given table. Specifying any property overrides the default properties for that column (which is based on the column's data type).

setProperties

public CreateTypeRequest setProperties(Map<String,List<String>> properties)

Parameters:

properties - Each key-value pair specifies the properties to use for a given column where the key is the column name. All keys used must be relevant column names for the given table. Specifying any property overrides the default properties for that column (which is based on the column's data type).

Returns:

this to mimic the builder pattern.

getOptions

public Map<String,String> getOptions()

Returns:

Optional parameters.

setOptions

public CreateTypeRequest 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