gpudb::CreateTypeRequest Struct Reference

A set of input parameters for createType(const CreateTypeRequest&) 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

Detailed Description

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

Constructor & Destructor Documentation

CreateTypeRequest() [1/2]

gpudb::CreateTypeRequest::CreateTypeRequest ( )

inline

Constructs a CreateTypeRequest object with default parameter values.

Definition at line 63 of file create_type.h.

CreateTypeRequest() [2/2]

gpudb::CreateTypeRequest::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_  )

inline

Constructs a CreateTypeRequest object with the specified parameters.

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). gpudb::create_type_data: Default property for all numeric and string type columns; makes the column available for GPU queries. gpudb::create_type_text_search: Valid only for 'string' columns. Enables full text search for string columns. Can be set independently of data and store_only. gpudb::create_type_store_only: Persist the column value but do not make it available to queries (e.g. /filter)-i.e. it is mutually exclusive to the data property. Any 'bytes' type column must have a store_only property. This property reduces system memory usage. gpudb::create_type_disk_optimized: Works in conjunction with the data property for string columns. This property reduces system disk usage by disabling reverse string lookups. Queries like /filter, /filter/bylist, and /filter/byvalue work as usual but /aggregate/unique, /aggregate/groupby and /get/records/bycolumn are not allowed on columns with this property. gpudb::create_type_timestamp: Valid only for 'long' columns. Indicates that this field represents a timestamp and will be provided in milliseconds since the Unix epoch: 00:00:00 Jan 1 1970. Dates represented by a timestamp must fall between the year 1000 and the year 2900. gpudb::create_type_decimal: Valid only for 'string' columns. It represents a SQL type NUMERIC(19, 4) data type. There can be up to 15 digits before the decimal point and up to four digits in the fractional part. The value can be positive or negative (indicated by a minus sign at the beginning). This property is mutually exclusive with the text_search property. gpudb::create_type_date: Valid only for 'string' columns. Indicates that this field represents a date and will be provided in the format 'YYYY-MM-DD'. The allowable range is 1000-01-01 through 2900-01-01. This property is mutually exclusive with the text_search property. gpudb::create_type_time: Valid only for 'string' columns. Indicates that this field represents a time-of-day and will be provided in the format 'HH:MM:SS.mmm'. The allowable range is 00:00:00.000 through 23:59:59.999. This property is mutually exclusive with the text_search property. gpudb::create_type_datetime: Valid only for 'string' columns. Indicates that this field represents a datetime and will be provided in the format 'YYYY-MM-DD HH:MM:SS.mmm'. The allowable range is 1000-01-01 00:00:00.000 through 2900-01-01 23:59:59.999. This property is mutually exclusive with the text_search property. gpudb::create_type_char1: This property provides optimized memory, disk and query performance for string columns. Strings with this property must be no longer than 1 character. gpudb::create_type_char2: This property provides optimized memory, disk and query performance for string columns. Strings with this property must be no longer than 2 characters. gpudb::create_type_char4: This property provides optimized memory, disk and query performance for string columns. Strings with this property must be no longer than 4 characters. gpudb::create_type_char8: This property provides optimized memory, disk and query performance for string columns. Strings with this property must be no longer than 8 characters. gpudb::create_type_char16: This property provides optimized memory, disk and query performance for string columns. Strings with this property must be no longer than 16 characters. gpudb::create_type_char32: This property provides optimized memory, disk and query performance for string columns. Strings with this property must be no longer than 32 characters. gpudb::create_type_char64: This property provides optimized memory, disk and query performance for string columns. Strings with this property must be no longer than 64 characters. gpudb::create_type_char128: This property provides optimized memory, disk and query performance for string columns. Strings with this property must be no longer than 128 characters. gpudb::create_type_char256: This property provides optimized memory, disk and query performance for string columns. Strings with this property must be no longer than 256 characters. gpudb::create_type_int8: This property provides optimized memory and query performance for int columns. Ints with this property must be between -128 and +127 (inclusive) gpudb::create_type_int16: This property provides optimized memory and query performance for int columns. Ints with this property must be between -32768 and +32767 (inclusive) gpudb::create_type_ipv4: This property provides optimized memory, disk and query performance for string columns representing IPv4 addresses (i.e. 192.168.1.1). Strings with this property must be of the form: A.B.C.D where A, B, C and D are in the range of 0-255. gpudb::create_type_wkt: Valid only for 'string' and 'bytes' columns. Indicates that this field contains geospatial geometry objects in Well-Known Text (WKT) or Well-Known Binary (WKB) format. gpudb::create_type_primary_key: This property indicates that this column will be part of (or the entire) primary key. gpudb::create_type_shard_key: This property indicates that this column will be part of (or the entire) shard key. gpudb::create_type_nullable: This property indicates that this column is nullable. However, setting this property is insufficient for making the column nullable. The user must declare the type of the column as a union between its regular type and 'null' in the avro schema for the record type in typeDefinition. For example, if a column is of type integer and is nullable, then the entry for the column in the avro schema must be: ['int', 'null']. The C++, C#, Java, and Python APIs have built-in convenience for bypassing setting the avro schema by hand. For those languages, one can use this property as usual and not have to worry about the avro schema for the record. gpudb::create_type_dict: This property indicates that this column should be dictionary encoded. It can only be used in conjunction with string columns marked with a charN or date property or with int or long columns. This property is appropriate for columns where the cardinality (the number of unique values) is expected to be low, and can save a large amount of memory. gpudb::create_type_init_with_now: For columns with attributes of date, time, datetime or timestamp, at insert time, replace empty strings and invalid timestamps with NOW()
[in]	options_	Optional parameters.

Definition at line 267 of file create_type.h.

Member Data Documentation

label

std::string gpudb::CreateTypeRequest::label

Definition at line 276 of file create_type.h.

options

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

Definition at line 278 of file create_type.h.

properties

std::map<std::string, std::vector<std::string> > gpudb::CreateTypeRequest::properties

Definition at line 277 of file create_type.h.

typeDefinition

std::string gpudb::CreateTypeRequest::typeDefinition

Definition at line 275 of file create_type.h.

---

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

• gpudb/protocol/create_type.h