GPUdb C++ API  Version 7.0.19.0
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
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 or collection. 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). 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.

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

Definition at line 40 of file create_table.h.

Constructor & Destructor Documentation

gpudb::CreateTableRequest::CreateTableRequest ( )
inline

Constructs a CreateTableRequest object with default parameter values.

Definition at line 47 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. 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.

Definition at line 227 of file create_table.h.

Member Data Documentation

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

Definition at line 236 of file create_table.h.

std::string gpudb::CreateTableRequest::tableName

Definition at line 234 of file create_table.h.

std::string gpudb::CreateTableRequest::typeId

Definition at line 235 of file create_table.h.


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