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.

Creates a new table with the given type (definition of columns). The type is specified in typeId as either a numerical type ID (as returned by GPUdb.createType) or as a list of columns, each specified as a list of the column name, data type, and any column attributes.

Example of a type definition with some parameters:

     \[
         \["id", "int8", "primary\_key"],
         \["dept\_id", "int8", "primary\_key", "shard\_key"],
         \["manager\_id", "int8", "nullable"],
         \["first\_name", "char32"],
         \["last\_name", "char64"],
         \["salary", "decimal"],
         \["hire\_date", "date"]
     ]

Each column definition consists of the column name (which should meet the standard column naming criteria), the column's specific type (int, long, float, double, string, bytes, or any of the properties map values from GPUdb.createType), and any data handling, data key, or data replacement properties.

A table may optionally be designated to use a replicated distribution scheme, or be assigned: foreign keys to other tables, a partitioning scheme, and/or a tier strategy.

Nested Class Summary

Nested Classes

Modifier and Type

Class

Description

static final class

CreateTableRequest.Options

A set of string constants for the CreateTableRequest parameter options.
Constructor Summary

Constructors

Constructor

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

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()

Optional parameters.

org.apache.avro.Schema

getSchema()

This method supports the Avro framework and is not intended to be called directly by the user.

String

getTableName()

Name of the table to be created, in \[schema\_name.]table\_name format, using standard name resolution rules and meeting table naming criteria.

String

getTypeId()

The type for the table, specified as either an existing table's numerical type ID (as returned by GPUdb.createType) or a type definition (as described above).

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)

Optional parameters.

CreateTableRequest

setTableName(String tableName)

Name of the table to be created, in \[schema\_name.]table\_name format, using standard name resolution rules and meeting table naming criteria.

CreateTableRequest

setTypeId(String typeId)

The type for the table, specified as either an existing table's numerical type ID (as returned by GPUdb.createType) or a type definition (as described above).

String

toString()

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details
- 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, in \[schema\_name.]table\_name format, using standard name resolution rules and meeting table naming criteria. Error for requests with existing table of the same name and type ID may be suppressed by using the NO\_ERROR\_IF\_EXISTS option.
  
  typeId - The type for the table, specified as either an existing table's numerical type ID (as returned by GPUdb.createType) or a type definition (as described above).
  
  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. Supported values:
  
  TRUE
  
  FALSE
  
  The default value is FALSE.
  
  CREATE\_TEMP\_TABLE: If TRUE, a unique temporary table name will be generated in the sys\_temp schema and used in place of tableName. If IS\_RESULT\_TABLE is TRUE, then this is always allowed even if the caller does not have permission to create tables. The generated name is returned in QUALIFIED\_TABLE\_NAME. Supported values:
  
  TRUE
  
  FALSE
  
  The default value is FALSE.
  
  COLLECTION\_NAME: \[DEPRECATED--please specify the containing schema as part of tableName and use GPUdb.createSchema to create the schema if non-existent] Name of a schema which is to contain the newly created table. If the schema is non-existent, it will be automatically created.
  
  IS\_COLLECTION: \[DEPRECATED--please use GPUdb.createSchema to create a schema instead] Indicates whether to create a schema instead of a table. Supported values:
  
  TRUE
  
  FALSE
  
  The default value is FALSE.
  
  IS\_REPLICATED: Affects the distribution scheme for the table's data. If TRUE and the given type has no explicit shard key defined, the table will be replicated. If FALSE, the table will be sharded according to the shard key specified in the given typeId, or randomly sharded, if no shard key is specified. Note that a type containing a shard key cannot be used to create a replicated table. Supported values:
  
  TRUE
  
  FALSE
  
  The default value is FALSE.
  
  FOREIGN\_KEYS: Semicolon-separated list of foreign keys, of the format '(source\_column\_name \[, ...]) references target\_table\_name(primary\_key\_column\_name \[, ...]) \[as foreign\_key\_name]'.
  
  FOREIGN\_SHARD\_KEY: Foreign shard key of the format 'source\_column references shard\_by\_column from target\_table(primary\_key\_column)'.
  
  PARTITION\_TYPE: Partitioning scheme to use. Supported values:
  
  RANGE: Use range partitioning.
  
  INTERVAL: Use interval partitioning.
  
  LIST: Use list partitioning.
  
  HASH: Use hash partitioning.
  
  SERIES: Use series partitioning.
  
  PARTITION\_KEYS: Comma-separated list of partition keys, which are the columns or column expressions by which records will be assigned to partitions defined by PARTITION\_DEFINITIONS.
  
  PARTITION\_DEFINITIONS: Comma-separated list of partition definitions, whose format depends on the choice of PARTITION\_TYPE. See range partitioning, interval partitioning, list partitioning, hash partitioning, or series partitioning for example formats.
  
  IS\_AUTOMATIC\_PARTITION: If TRUE, a new partition will be created for values which don't fall into an existing partition. Currently only supported for list partitions. Supported values:
  
  TRUE
  
  FALSE
  
  The default value is FALSE.
  
  TTL: Sets the TTL of the table specified in tableName.
  
  CHUNK\_SIZE: Indicates the number of records per chunk to be used for this table.
  
  CHUNK\_COLUMN\_MAX\_MEMORY: Indicates the target maximum data size for each column in a chunk to be used for this table.
  
  CHUNK\_MAX\_MEMORY: Indicates the target maximum data size for all columns in a chunk to be used for this table.
  
  IS\_RESULT\_TABLE: Indicates whether the table is a memory-only table. A result table cannot contain columns with text\_search data-handling, and it will not be retained if the server is restarted. Supported values:
  
  TRUE
  
  FALSE
  
  The default value is FALSE.
  
  STRATEGY\_DEFINITION: The tier strategy for the table and its columns.
  
  COMPRESSION\_CODEC: The default compression codec for this table's columns.
  
  LOAD\_VECTORS\_POLICY: Set startup data loading scheme for the table. Supported values:
  
  ALWAYS: Load as much vector data as possible into memory before accepting requests.
  
  LAZY: Load the necessary vector data at start, and load the remainder lazily.
  
  ON\_DEMAND: Load vector data as requests use it.
  
  SYSTEM: Load vector data using the system-configured default.
  
  The default value is SYSTEM.
  
  BUILD\_PK\_INDEX\_POLICY: Set startup primary-key index generation scheme for the table. Supported values:
  
  ALWAYS: Generate as much primary key index data as possible before accepting requests.
  
  LAZY: Generate the necessary primary key index data at start, and load the remainder lazily.
  
  ON\_DEMAND: Generate primary key index data as requests use it.
  
  SYSTEM: Generate primary key index data using the system-configured default.
  
  The default value is SYSTEM.
  
  The default value is an empty Map.
Method Details
- 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()
  
  Name of the table to be created, in \[schema\_name.]table\_name format, using standard name resolution rules and meeting table naming criteria. Error for requests with existing table of the same name and type ID may be suppressed by using the NO\_ERROR\_IF\_EXISTS option.
  
  Returns:
  
  The current value of tableName.
- setTableName
  
  public CreateTableRequest setTableName(String tableName)
  
  Name of the table to be created, in \[schema\_name.]table\_name format, using standard name resolution rules and meeting table naming criteria. Error for requests with existing table of the same name and type ID may be suppressed by using the NO\_ERROR\_IF\_EXISTS option.
  
  Parameters:
  
  tableName - The new value for tableName.
  
  Returns:
  
  this to mimic the builder pattern.
- getTypeId
  
  public String getTypeId()
  
  The type for the table, specified as either an existing table's numerical type ID (as returned by GPUdb.createType) or a type definition (as described above).
  
  Returns:
  
  The current value of typeId.
- setTypeId
  
  public CreateTableRequest setTypeId(String typeId)
  
  The type for the table, specified as either an existing table's numerical type ID (as returned by GPUdb.createType) or a type definition (as described above).
  
  Parameters:
  
  typeId - The new value for typeId.
  
  Returns:
  
  this to mimic the builder pattern.
- getOptions
  
  public Map\<String,String> getOptions()
  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. Supported values:
  
  TRUE
  
  FALSE
  
  The default value is FALSE.
  
  CREATE\_TEMP\_TABLE: If TRUE, a unique temporary table name will be generated in the sys\_temp schema and used in place of tableName. If IS\_RESULT\_TABLE is TRUE, then this is always allowed even if the caller does not have permission to create tables. The generated name is returned in QUALIFIED\_TABLE\_NAME. Supported values:
  
  TRUE
  
  FALSE
  
  The default value is FALSE.
  
  COLLECTION\_NAME: \[DEPRECATED--please specify the containing schema as part of tableName and use GPUdb.createSchema to create the schema if non-existent] Name of a schema which is to contain the newly created table. If the schema is non-existent, it will be automatically created.
  
  IS\_COLLECTION: \[DEPRECATED--please use GPUdb.createSchema to create a schema instead] Indicates whether to create a schema instead of a table. Supported values:
  
  TRUE
  
  FALSE
  
  The default value is FALSE.
  
  IS\_REPLICATED: Affects the distribution scheme for the table's data. If TRUE and the given type has no explicit shard key defined, the table will be replicated. If FALSE, the table will be sharded according to the shard key specified in the given typeId, or randomly sharded, if no shard key is specified. Note that a type containing a shard key cannot be used to create a replicated table. Supported values:
  
  TRUE
  
  FALSE
  
  The default value is FALSE.
  
  FOREIGN\_KEYS: Semicolon-separated list of foreign keys, of the format '(source\_column\_name \[, ...]) references target\_table\_name(primary\_key\_column\_name \[, ...]) \[as foreign\_key\_name]'.
  
  FOREIGN\_SHARD\_KEY: Foreign shard key of the format 'source\_column references shard\_by\_column from target\_table(primary\_key\_column)'.
  
  PARTITION\_TYPE: Partitioning scheme to use. Supported values:
  
  RANGE: Use range partitioning.
  
  INTERVAL: Use interval partitioning.
  
  LIST: Use list partitioning.
  
  HASH: Use hash partitioning.
  
  SERIES: Use series partitioning.
  
  PARTITION\_KEYS: Comma-separated list of partition keys, which are the columns or column expressions by which records will be assigned to partitions defined by PARTITION\_DEFINITIONS.
  
  PARTITION\_DEFINITIONS: Comma-separated list of partition definitions, whose format depends on the choice of PARTITION\_TYPE. See range partitioning, interval partitioning, list partitioning, hash partitioning, or series partitioning for example formats.
  
  IS\_AUTOMATIC\_PARTITION: If TRUE, a new partition will be created for values which don't fall into an existing partition. Currently only supported for list partitions. Supported values:
  
  TRUE
  
  FALSE
  
  The default value is FALSE.
  
  TTL: Sets the TTL of the table specified in tableName.
  
  CHUNK\_SIZE: Indicates the number of records per chunk to be used for this table.
  
  CHUNK\_COLUMN\_MAX\_MEMORY: Indicates the target maximum data size for each column in a chunk to be used for this table.
  
  CHUNK\_MAX\_MEMORY: Indicates the target maximum data size for all columns in a chunk to be used for this table.
  
  IS\_RESULT\_TABLE: Indicates whether the table is a memory-only table. A result table cannot contain columns with text\_search data-handling, and it will not be retained if the server is restarted. Supported values:
  
  TRUE
  
  FALSE
  
  The default value is FALSE.
  
  STRATEGY\_DEFINITION: The tier strategy for the table and its columns.
  
  COMPRESSION\_CODEC: The default compression codec for this table's columns.
  
  LOAD\_VECTORS\_POLICY: Set startup data loading scheme for the table. Supported values:
  
  ALWAYS: Load as much vector data as possible into memory before accepting requests.
  
  LAZY: Load the necessary vector data at start, and load the remainder lazily.
  
  ON\_DEMAND: Load vector data as requests use it.
  
  SYSTEM: Load vector data using the system-configured default.
  
  The default value is SYSTEM.
  
  BUILD\_PK\_INDEX\_POLICY: Set startup primary-key index generation scheme for the table. Supported values:
  
  ALWAYS: Generate as much primary key index data as possible before accepting requests.
  
  LAZY: Generate the necessary primary key index data at start, and load the remainder lazily.
  
  ON\_DEMAND: Generate primary key index data as requests use it.
  
  SYSTEM: Generate primary key index data using the system-configured default.
  
  The default value is SYSTEM.
  
  The default value is an empty Map.
  Returns:
  
  The current value of options.
- setOptions
  
  public CreateTableRequest setOptions(Map\<String,String> 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. Supported values:
  
  TRUE
  
  FALSE
  
  The default value is FALSE.
  
  CREATE\_TEMP\_TABLE: If TRUE, a unique temporary table name will be generated in the sys\_temp schema and used in place of tableName. If IS\_RESULT\_TABLE is TRUE, then this is always allowed even if the caller does not have permission to create tables. The generated name is returned in QUALIFIED\_TABLE\_NAME. Supported values:
  
  TRUE
  
  FALSE
  
  The default value is FALSE.
  
  COLLECTION\_NAME: \[DEPRECATED--please specify the containing schema as part of tableName and use GPUdb.createSchema to create the schema if non-existent] Name of a schema which is to contain the newly created table. If the schema is non-existent, it will be automatically created.
  
  IS\_COLLECTION: \[DEPRECATED--please use GPUdb.createSchema to create a schema instead] Indicates whether to create a schema instead of a table. Supported values:
  
  TRUE
  
  FALSE
  
  The default value is FALSE.
  
  IS\_REPLICATED: Affects the distribution scheme for the table's data. If TRUE and the given type has no explicit shard key defined, the table will be replicated. If FALSE, the table will be sharded according to the shard key specified in the given typeId, or randomly sharded, if no shard key is specified. Note that a type containing a shard key cannot be used to create a replicated table. Supported values:
  
  TRUE
  
  FALSE
  
  The default value is FALSE.
  
  FOREIGN\_KEYS: Semicolon-separated list of foreign keys, of the format '(source\_column\_name \[, ...]) references target\_table\_name(primary\_key\_column\_name \[, ...]) \[as foreign\_key\_name]'.
  
  FOREIGN\_SHARD\_KEY: Foreign shard key of the format 'source\_column references shard\_by\_column from target\_table(primary\_key\_column)'.
  
  PARTITION\_TYPE: Partitioning scheme to use. Supported values:
  
  RANGE: Use range partitioning.
  
  INTERVAL: Use interval partitioning.
  
  LIST: Use list partitioning.
  
  HASH: Use hash partitioning.
  
  SERIES: Use series partitioning.
  
  PARTITION\_KEYS: Comma-separated list of partition keys, which are the columns or column expressions by which records will be assigned to partitions defined by PARTITION\_DEFINITIONS.
  
  PARTITION\_DEFINITIONS: Comma-separated list of partition definitions, whose format depends on the choice of PARTITION\_TYPE. See range partitioning, interval partitioning, list partitioning, hash partitioning, or series partitioning for example formats.
  
  IS\_AUTOMATIC\_PARTITION: If TRUE, a new partition will be created for values which don't fall into an existing partition. Currently only supported for list partitions. Supported values:
  
  TRUE
  
  FALSE
  
  The default value is FALSE.
  
  TTL: Sets the TTL of the table specified in tableName.
  
  CHUNK\_SIZE: Indicates the number of records per chunk to be used for this table.
  
  CHUNK\_COLUMN\_MAX\_MEMORY: Indicates the target maximum data size for each column in a chunk to be used for this table.
  
  CHUNK\_MAX\_MEMORY: Indicates the target maximum data size for all columns in a chunk to be used for this table.
  
  IS\_RESULT\_TABLE: Indicates whether the table is a memory-only table. A result table cannot contain columns with text\_search data-handling, and it will not be retained if the server is restarted. Supported values:
  
  TRUE
  
  FALSE
  
  The default value is FALSE.
  
  STRATEGY\_DEFINITION: The tier strategy for the table and its columns.
  
  COMPRESSION\_CODEC: The default compression codec for this table's columns.
  
  LOAD\_VECTORS\_POLICY: Set startup data loading scheme for the table. Supported values:
  
  ALWAYS: Load as much vector data as possible into memory before accepting requests.
  
  LAZY: Load the necessary vector data at start, and load the remainder lazily.
  
  ON\_DEMAND: Load vector data as requests use it.
  
  SYSTEM: Load vector data using the system-configured default.
  
  The default value is SYSTEM.
  
  BUILD\_PK\_INDEX\_POLICY: Set startup primary-key index generation scheme for the table. Supported values:
  
  ALWAYS: Generate as much primary key index data as possible before accepting requests.
  
  LAZY: Generate the necessary primary key index data at start, and load the remainder lazily.
  
  ON\_DEMAND: Generate primary key index data as requests use it.
  
  SYSTEM: Generate primary key index data using the system-configured default.
  
  The default value is SYSTEM.
  
  The default value is an empty Map.
  Parameters:
  
  options - The new value for options.
  
  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

Class CreateTableRequest

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Details

CreateTableRequest

CreateTableRequest

Method Details

getClassSchema

getTableName

setTableName

getTypeId

setTypeId

getOptions

setOptions

getSchema

get

put

equals

toString

hashCode