A set of input parameters for createTable(const CreateTableRequest&) 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 createTable(const CreateTableRequest&) const.

Creates a new table or collection. If a new table is being created, the type of the table is given by typeId, which must the be the ID of a currently registered type (i.e. one created via createType(const CreateTypeRequest&) const). The table will be created inside a collection if the option collection_name is specified. If that collection does not already exist, it will be created.

To create a new collection, specify the name of the collection in tableName and set the is_collection option to true; typeId will be ignored.

Definition at line 28 of file create_table.h.

Constructor & Destructor Documentation

◆ CreateTableRequest() [1/2]

gpudb::CreateTableRequest::CreateTableRequest ( )

inline

Constructs a CreateTableRequest object with default parameter values.

Definition at line 35 of file create_table.h.

◆ CreateTableRequest() [2/2]

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. Error for requests with existing table of the same name and type id may be suppressed by using the no_error_if_exists option. See Tables for naming restrictions.
[in]	typeId_	ID of a currently registered type. All objects added to the newly created table will be of this type. Ignored if is_collection is true.
[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_collection_name: Name of a collection which is to contain the newly created table. If the collection provided is non-existent, the collection will be automatically created. If empty, then the newly created table will be a top-level table. gpudb::create_table_is_collection: Indicates whether the new table to be created will be a collection. gpudb::create_table_true gpudb::create_table_false The default value is gpudb::create_table_false. gpudb::create_table_disallow_homogeneous_tables: For a collection, indicates whether the collection prohibits containment of multiple tables of exactly the same data type. gpudb::create_table_true gpudb::create_table_false The default value is gpudb::create_table_false. gpudb::create_table_is_replicated: For a table, indicates the distribution scheme for the table's data. If true, 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. 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_ttl: For a table, sets the TTL of the table specified in tableName. gpudb::create_table_chunk_size: Indicates the chunk size to be used for this table. gpudb::create_table_is_result_table: For a table, indicates whether the table is an in-memory table. A result table cannot contain store_only, text_search, or string columns (charN columns are acceptable), 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.

Definition at line 150 of file create_table.h.

Member Data Documentation

◆ options

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

Definition at line 159 of file create_table.h.

◆ tableName

std::string gpudb::CreateTableRequest::tableName

Definition at line 157 of file create_table.h.

◆ typeId

std::string gpudb::CreateTableRequest::typeId

Definition at line 158 of file create_table.h.

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

gpudb/protocol/create_table.h

Public Member Functions

Public Attributes