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.
• 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(CreateSchemaRequest) 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(CreateSchemaRequest) to create a schema instead] Indicates whether to create a schema instead of a table. Supported values:
  • TRUE
  • FALSE
  The default value is FALSE.
• DISALLOW_HOMOGENEOUS_TABLES: No longer supported; value will be ignored. 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.
• IS_RESULT_TABLE: Indicates whether the table is a memory-only table. A result table cannot contain columns with store_only or text_search data-handling or that are non-charN strings, 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.

The default value is an empty Map. A set of string constants for the parameter options.

Field Summary

Fields

Modifier and Type	Field and Description
static String	CHUNK_SIZE Indicates the number of records per chunk to be used for this table.
static String	COLLECTION_NAME [DEPRECATED--please specify the containing schema as part of tableName and use GPUdb.createSchema(CreateSchemaRequest) to create the schema if non-existent] Name of a schema which is to contain the newly created table.
static String	CREATE_TEMP_TABLE If true, a unique temporary table name will be generated in the sys_temp schema and used in place of tableName.
static String	DISALLOW_HOMOGENEOUS_TABLES No longer supported; value will be ignored.
static String	FALSE
static String	FOREIGN_KEYS Semicolon-separated list of	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	HASH Use	static String	INTERVAL Use	static String	IS_AUTOMATIC_PARTITION If true, a new partition will be created for values which don't fall into an existing partition.
static String	IS_COLLECTION [DEPRECATED--please use GPUdb.createSchema(CreateSchemaRequest) to create a schema instead] Indicates whether to create a schema instead of a table.
static String	IS_REPLICATED Affects the	static String	IS_RESULT_TABLE Indicates whether the table is a	static String	LIST Use	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	PARTITION_DEFINITIONS Comma-separated list of partition definitions, whose format depends on the choice of partition_type.
static String	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.
static String	PARTITION_TYPE	static String	RANGE Use	static String	SERIES Use	static String	STRATEGY_DEFINITION The	static String	TRUE
static String	TTL Sets the 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 CREATE_TEMP_TABLE public static final String 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. See Also: Constant Field Values COLLECTION_NAME public static final String COLLECTION_NAME [DEPRECATED--please specify the containing schema as part of tableName and use GPUdb.createSchema(CreateSchemaRequest) 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. See Also: Constant Field Values IS_COLLECTION public static final String IS_COLLECTION [DEPRECATED--please use GPUdb.createSchema(CreateSchemaRequest) to create a schema instead] Indicates whether to create a schema instead of a table. Supported values: TRUE FALSE The default value is FALSE. See Also: Constant Field Values DISALLOW_HOMOGENEOUS_TABLES public static final String DISALLOW_HOMOGENEOUS_TABLES No longer supported; value will be ignored. Supported values: TRUE FALSE The default value is FALSE. See Also: Constant Field Values IS_REPLICATED public static final String 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. See Also: Constant Field Values FOREIGN_KEYS public static final String 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]'. 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 PARTITION_TYPE public static final String 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. See Also: Constant Field Values RANGE public static final String RANGE Use range partitioning. See Also: Constant Field Values INTERVAL public static final String INTERVAL Use interval partitioning. See Also: Constant Field Values LIST public static final String LIST Use list partitioning. See Also: Constant Field Values HASH public static final String HASH Use hash partitioning. See Also: Constant Field Values SERIES public static final String SERIES Use series partitioning. See Also: Constant Field Values PARTITION_KEYS public static final String 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. See Also: Constant Field Values PARTITION_DEFINITIONS public static final String 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. See Also: Constant Field Values IS_AUTOMATIC_PARTITION public static final String 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. See Also: Constant Field Values TTL public static final String TTL Sets the TTL of the table specified in tableName. See Also: Constant Field Values CHUNK_SIZE public static final String CHUNK_SIZE Indicates the number of records per chunk to be used for this table. See Also: Constant Field Values IS_RESULT_TABLE public static final String IS_RESULT_TABLE Indicates whether the table is a memory-only table. A result table cannot contain columns with store_only or text_search data-handling or that are non-charN strings, 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 STRATEGY_DEFINITION public static final String STRATEGY_DEFINITION The tier strategy for the table and its columns. See Also: Constant Field Values Skip navigation links Overview Package Class Use Tree Deprecated Index Help Prev Class Next Class Frames No Frames All Classes Summary: Nested | Field | Constr | Method Detail: Field | Constr | Method Copyright © 2024. All rights reserved.