GPUdb C++ API
Version 7.0.19.0
|
A set of input parameters for const. More...
#include <gpudb/protocol/create_type.h>
Public Member Functions | |
CreateTypeRequest () | |
Constructs a CreateTypeRequest object with default parameter values. More... | |
CreateTypeRequest (const std::string &typeDefinition_, const std::string &label_, const std::map< std::string, std::vector< std::string > > &properties_, const std::map< std::string, std::string > &options_) | |
Constructs a CreateTypeRequest object with the specified parameters. More... | |
Public Attributes | |
std::string | typeDefinition |
std::string | label |
std::map< std::string, std::vector< std::string > > | properties |
std::map< std::string, std::string > | options |
A set of input parameters for const.
Creates a new type describing the layout or schema of a table. The type definition is a JSON string describing the fields (i.e. columns) of the type. Each field consists of a name and a data type. Supported data types are: double, float, int, long, string, and bytes. In addition one or more properties can be specified for each column which customize the memory usage and query availability of that column. Note that some properties are mutually exclusive–i.e. they cannot be specified for any given column simultaneously. One example of mutually exclusive properties are data and store_only.
A single primary key and/or single shard key can be set across one or more columns. If a primary key is specified, then a uniqueness constraint is enforced, in that only a single object can exist with a given primary key. When inserting data into a table with a primary key, depending on the parameters in the request, incoming objects with primary key values that match existing objects will either overwrite (i.e. update) the existing object or will be skipped and not added into the set.
Example of a type definition with some of the parameters::
{"type":"record", "name":"point", "fields":[{"name":"msg_id","type":"string"}, {"name":"x","type":"double"}, {"name":"y","type":"double"}, {"name":"TIMESTAMP","type":"double"}, {"name":"source","type":"string"}, {"name":"group_id","type":"string"}, {"name":"OBJECT_ID","type":"string"}] }
Properties::
{"group_id":["store_only"], "msg_id":["store_only","text_search"] }
Definition at line 57 of file create_type.h.
|
inline |
Constructs a CreateTypeRequest object with default parameter values.
Definition at line 63 of file create_type.h.
|
inline |
Constructs a CreateTypeRequest object with the specified parameters.
[in] | typeDefinition_ | a JSON string describing the columns of the type to be registered. |
[in] | label_ | A user-defined description string which can be used to differentiate between tables and types with otherwise identical schemas. |
[in] | properties_ | Each key-value pair specifies the properties to use for a given column where the key is the column name. All keys used must be relevant column names for the given table. Specifying any property overrides the default properties for that column (which is based on the column's data type).
|
[in] | options_ | Optional parameters. |
Definition at line 273 of file create_type.h.
std::string gpudb::CreateTypeRequest::label |
Definition at line 282 of file create_type.h.
std::map<std::string, std::string> gpudb::CreateTypeRequest::options |
Definition at line 284 of file create_type.h.
std::map<std::string, std::vector<std::string> > gpudb::CreateTypeRequest::properties |
Definition at line 283 of file create_type.h.
std::string gpudb::CreateTypeRequest::typeDefinition |
Definition at line 281 of file create_type.h.