gpudb::CreateTableRequest Struct Reference

A set of input parameters for const. More...

#include <gpudb/protocol/create_table.h>

Public Member Functions
	CreateTableRequest ()
	Constructs a CreateTableRequest object with default parameter values. More...
	CreateTableRequest (const std::string &tableName_, const std::string &typeId_, const std::map< std::string, std::string > &options_)
	Constructs a CreateTableRequest object with the specified parameters. More...

Public Attributes
std::string	tableName
std::string	typeId
std::map< std::string, std::string >	options

Detailed Description

A set of input parameters for const.

Creates a new table. If a new table is being created, the type of the table is given by typeId, which must be the ID of a currently registered type (i.e. one created via const).

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.

Definition at line 31 of file create_table.h.

Constructor & Destructor Documentation

gpudb::CreateTableRequest::CreateTableRequest ( )

inline

Constructs a CreateTableRequest object with default parameter values.

Definition at line 38 of file create_table.h.

gpudb::CreateTableRequest::CreateTableRequest ( const std::string &  tableName_, const std::string &  typeId_, const std::map< std::string, std::string > &  options_  )

inline

Constructs a CreateTableRequest object with the specified parameters.

Parameters

[in]	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.
[in]	typeId_	ID of a currently registered type. All objects added to the newly created table will be of this type.
[in]	options_	Optional parameters. gpudb::create_table_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. gpudb::create_table_true gpudb::create_table_false The default value is gpudb::create_table_false. gpudb::create_table_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. gpudb::create_table_true gpudb::create_table_false The default value is gpudb::create_table_false. gpudb::create_table_collection_name: [DEPRECATED–please specify the containing schema as part of tableName and use /create/schema 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. gpudb::create_table_is_collection: [DEPRECATED–please use /create/schema to create a schema instead] Indicates whether to create a schema instead of a table. gpudb::create_table_true gpudb::create_table_false The default value is gpudb::create_table_false. gpudb::create_table_disallow_homogeneous_tables: No longer supported; value will be ignored. gpudb::create_table_true gpudb::create_table_false The default value is gpudb::create_table_false. gpudb::create_table_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. gpudb::create_table_true gpudb::create_table_false The default value is gpudb::create_table_false. gpudb::create_table_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]'. gpudb::create_table_foreign_shard_key: Foreign shard key of the format 'source_column references shard_by_column from target_table(primary_key_column)'. gpudb::create_table_partition_type: Partitioning scheme to use. gpudb::create_table_RANGE: Use range partitioning. gpudb::create_table_INTERVAL: Use interval partitioning. gpudb::create_table_LIST: Use list partitioning. gpudb::create_table_HASH: Use hash partitioning. gpudb::create_table_SERIES: Use series partitioning. gpudb::create_table_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. gpudb::create_table_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. gpudb::create_table_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. gpudb::create_table_true gpudb::create_table_false The default value is gpudb::create_table_false. gpudb::create_table_ttl: Sets the TTL of the table specified in tableName. gpudb::create_table_chunk_size: Indicates the number of records per chunk to be used for this table. gpudb::create_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. gpudb::create_table_true gpudb::create_table_false The default value is gpudb::create_table_false. gpudb::create_table_strategy_definition: The tier strategy for the table and its columns.

Definition at line 243 of file create_table.h.

Member Data Documentation

std::map<std::string, std::string> gpudb::CreateTableRequest::options

Definition at line 252 of file create_table.h.

std::string gpudb::CreateTableRequest::tableName

Definition at line 250 of file create_table.h.

std::string gpudb::CreateTableRequest::typeId

Definition at line 251 of file create_table.h.

---

The documentation for this struct was generated from the following file:

• gpudb/protocol/create_table.h