com.gpudb.protocol

Class CreateTableRequest.Options

java.lang.Object

com.gpudb.protocol.CreateTableRequest.Options

Enclosing class:

CreateTableRequest

public static final class CreateTableRequest.Options
extends Object

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.
• COLLECTION_NAME: Name of a collection which is to contain the newly created table. If empty, then the newly created table will be a top-level table. If the collection does not allow duplicate types and it contains a table of the same type as the given one, then this table creation request will fail.
• IS_COLLECTION: Indicates whether the new table to be created will be a collection. Supported values:
  • TRUE
  • FALSE
  The default value is FALSE.
• DISALLOW_HOMOGENEOUS_TABLES: For a collection, indicates whether the collection prohibits containment of multiple tables of exactly the same data type. Supported values:
  • TRUE
  • FALSE
  The default value is FALSE.
• IS_REPLICATED: For a table, indicates whether the table is to be replicated to all the database ranks. This may be necessary when the table is to be joined with other tables in a query. Supported values:
  • TRUE
  • FALSE
  The default value is FALSE.
• FOREIGN_KEYS: Semicolon-separated list of foreign keys, of the format 'source_column references target_table(primary_key_column)'.
• FOREIGN_SHARD_KEY: Foreign shard key of the format 'source_column references shard_by_column from target_table(primary_key_column)'
• TTL: Sets the TTL of the table or collection specified in tableName. The value must be the desired TTL in minutes.
• IS_RESULT_TABLE: For a table, indicates whether the table is a non-persistent, memory-only table that will store the output of a proc executed with GPUdb.executeProc(ExecuteProcRequest). A result table cannot contain store_only, text_search, or string columns (char columns are acceptable), records cannot be inserted into it directly, and it will not be retained if the server is restarted. Supported values:
  • TRUE
  • FALSE
  The default value is FALSE.

A set of string constants for the parameter options.

Field Summary

Fields

Modifier and Type	Field and Description
static String	COLLECTION_NAME Name of a collection which is to contain the newly created table.
static String	DISALLOW_HOMOGENEOUS_TABLES For a collection, indicates whether the collection prohibits containment of multiple tables of exactly the same data type.
static String	FALSE
static String	FOREIGN_KEYS Semicolon-separated list of foreign keys, of the format 'source_column references target_table(primary_key_column)'.
static String	FOREIGN_SHARD_KEY Foreign shard key of the format 'source_column references shard_by_column from target_table(primary_key_column)'
static String	IS_COLLECTION Indicates whether the new table to be created will be a collection.
static String	IS_REPLICATED For a table, indicates whether the table is to be replicated to all the database ranks.
static String	IS_RESULT_TABLE For a table, indicates whether the table is a non-persistent, memory-only table that will store the output of a proc executed with GPUdb.executeProc(ExecuteProcRequest).
static String	NO_ERROR_IF_EXISTS If true, prevents an error from occurring if the table already exists and is of the given type.
static String	TRUE
static String	TTL Sets the TTL of the table or collection specified in tableName.

Method Summary

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

NO_ERROR_IF_EXISTS

public static final String 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.

See Also:

Constant Field Values

TRUE

public static final String TRUE

See Also:

Constant Field Values

FALSE

public static final String FALSE

See Also:

Constant Field Values

COLLECTION_NAME

public static final String COLLECTION_NAME

Name of a collection which is to contain the newly created table. If empty, then the newly created table will be a top-level table. If the collection does not allow duplicate types and it contains a table of the same type as the given one, then this table creation request will fail.

See Also:

Constant Field Values

IS_COLLECTION

public static final String IS_COLLECTION

Indicates whether the new table to be created will be a collection. Supported values:

• TRUE
• FALSE

The default value is FALSE.

See Also:

Constant Field Values

DISALLOW_HOMOGENEOUS_TABLES

public static final String DISALLOW_HOMOGENEOUS_TABLES

For a collection, indicates whether the collection prohibits containment of multiple tables of exactly the same data type. Supported values:

• TRUE
• FALSE

The default value is FALSE.

See Also:

Constant Field Values

IS_REPLICATED

public static final String IS_REPLICATED

For a table, indicates whether the table is to be replicated to all the database ranks. This may be necessary when the table is to be joined with other tables in a query. Supported values:

• TRUE
• FALSE

The default value is FALSE.

See Also:

Constant Field Values

FOREIGN_KEYS

public static final String FOREIGN_KEYS

Semicolon-separated list of foreign keys, of the format 'source_column references target_table(primary_key_column)'.

See Also:

Constant Field Values

FOREIGN_SHARD_KEY

public static final String FOREIGN_SHARD_KEY

Foreign shard key of the format 'source_column references shard_by_column from target_table(primary_key_column)'

See Also:

Constant Field Values

TTL

public static final String TTL

Sets the TTL of the table or collection specified in tableName. The value must be the desired TTL in minutes.

See Also:

Constant Field Values

IS_RESULT_TABLE

public static final String IS_RESULT_TABLE

For a table, indicates whether the table is a non-persistent, memory-only table that will store the output of a proc executed with GPUdb.executeProc(ExecuteProcRequest). A result table cannot contain store_only, text_search, or string columns (char columns are acceptable), records cannot be inserted into it directly, and it will not be retained if the server is restarted. Supported values:

• TRUE
• FALSE

The default value is FALSE.

See Also:

Constant Field Values