com.gpudb.protocol

Class CreateTypeRequest.Properties

java.lang.Object

com.gpudb.protocol.CreateTypeRequest.Properties

Enclosing class:

CreateTypeRequest

public static final class CreateTypeRequest.Properties
extends Object

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). Valid values are:

• DATA: Default property for all numeric and string type columns; makes the column available for GPU queries.
• TEXT_SEARCH: Valid only for 'string' columns. Enables full text search for string columns. Can be set independently of *data* and *store_only*.
• STORE_ONLY: Persist the column value but do not make it available to queries (e.g. GPUdb.filter(FilterRequest))-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.
• 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 GPUdb.filter(FilterRequest), GPUdb.filterByList(FilterByListRequest), and GPUdb.filterByValue(FilterByValueRequest) work as usual but GPUdb.aggregateUniqueRaw(AggregateUniqueRequest), GPUdb.aggregateGroupByRaw(AggregateGroupByRequest) and GPUdb.getRecordsByColumnRaw(GetRecordsByColumnRequest) are not allowed on columns with this property.
• 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.
• 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.
• 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.
• 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.
• 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.
• CHAR1: This property provides optimized memory, disk and query performance for string columns. Strings with this property must be no longer than 1 character. This property cannot be combined with *text_search*
• CHAR2: This property provides optimized memory, disk and query performance for string columns. Strings with this property must be no longer than 2 characters. This property cannot be combined with *text_search*
• CHAR4: This property provides optimized memory, disk and query performance for string columns. Strings with this property must be no longer than 4 characters. This property cannot be combined with *text_search*
• CHAR8: This property provides optimized memory, disk and query performance for string columns. Strings with this property must be no longer than 8 characters. This property cannot be combined with *text_search*
• CHAR16: This property provides optimized memory, disk and query performance for string columns. Strings with this property must be no longer than 16 characters. This property cannot be combined with *text_search*
• CHAR32: This property provides optimized memory, disk and query performance for string columns. Strings with this property must be no longer than 32 characters. This property cannot be combined with *text_search*
• CHAR64: This property provides optimized memory, disk and query performance for string columns. Strings with this property must be no longer than 64 characters. This property cannot be combined with *text_search*
• CHAR128: This property provides optimized memory, disk and query performance for string columns. Strings with this property must be no longer than 128 characters. This property cannot be combined with *text_search*
• CHAR256: This property provides optimized memory, disk and query performance for string columns. Strings with this property must be no longer than 256 characters. This property cannot be combined with *text_search*
• INT8: This property provides optimized memory and query performance for int columns. Ints with this property must be between -128 and +127 (inclusive)
• INT16: This property provides optimized memory and query performance for int columns. Ints with this property must be between -32768 and +32767 (inclusive)
• 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.
• 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.
• PRIMARY_KEY: This property indicates that this column will be part of (or the entire) primary key.
• SHARD_KEY: This property indicates that this column will be part of (or the entire) shard key.
• 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 two languages, one can use this property as usual and not have to worry about the avro schema for the record.

• 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 property. 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.

A set of string constants for the parameter properties.

Field Summary

Fields

Modifier and Type	Field and Description
static String	CHAR1 This property provides optimized memory, disk and query performance for string columns.
static String	CHAR128 This property provides optimized memory, disk and query performance for string columns.
static String	CHAR16 This property provides optimized memory, disk and query performance for string columns.
static String	CHAR2 This property provides optimized memory, disk and query performance for string columns.
static String	CHAR256 This property provides optimized memory, disk and query performance for string columns.
static String	CHAR32 This property provides optimized memory, disk and query performance for string columns.
static String	CHAR4 This property provides optimized memory, disk and query performance for string columns.
static String	CHAR64 This property provides optimized memory, disk and query performance for string columns.
static String	CHAR8 This property provides optimized memory, disk and query performance for string columns.
static String	DATA Default property for all numeric and string type columns; makes the column available for GPU queries.
static String	DATE Valid only for 'string' columns.
static String	DATETIME Valid only for 'string' columns.
static String	DECIMAL Valid only for 'string' columns.
static String	DICT This property indicates that this column should be dictionary encoded.
static String	DISK_OPTIMIZED Works in conjunction with the 'data' property for string columns.
static String	INT16 This property provides optimized memory and query performance for int columns.
static String	INT8 This property provides optimized memory and query performance for int columns.
static String	IPV4 This property provides optimized memory, disk and query performance for string columns representing IPv4 addresses (i.e.
static String	NULLABLE This property indicates that this column is nullable.
static String	PRIMARY_KEY This property indicates that this column will be part of (or the entire) primary key.
static String	SHARD_KEY This property indicates that this column will be part of (or the entire) shard key.
static String	STORE_ONLY Persist the column value but do not make it available to queries (e.g.
static String	TEXT_SEARCH Valid only for 'string' columns.
static String	TIME Valid only for 'string' columns.
static String	TIMESTAMP Valid only for 'long' columns.
static String	WKT Valid only for 'string' and 'bytes' columns.

Method Summary

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DATA

public static final String DATA

Default property for all numeric and string type columns; makes the column available for GPU queries.

See Also:

Constant Field Values

TEXT_SEARCH

public static final String TEXT_SEARCH

Valid only for 'string' columns. Enables full text search for string columns. Can be set independently of *data* and *store_only*.

See Also:

Constant Field Values

STORE_ONLY

public static final String STORE_ONLY

Persist the column value but do not make it available to queries (e.g. GPUdb.filter(FilterRequest))-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.

See Also:

Constant Field Values

DISK_OPTIMIZED

public static final String 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 GPUdb.filter(FilterRequest), GPUdb.filterByList(FilterByListRequest), and GPUdb.filterByValue(FilterByValueRequest) work as usual but GPUdb.aggregateUniqueRaw(AggregateUniqueRequest), GPUdb.aggregateGroupByRaw(AggregateGroupByRequest) and GPUdb.getRecordsByColumnRaw(GetRecordsByColumnRequest) are not allowed on columns with this property.

See Also:

Constant Field Values

TIMESTAMP

public static final String 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.

See Also:

Constant Field Values

DECIMAL

public static final String 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.

See Also:

Constant Field Values

DATE

public static final String 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.

See Also:

Constant Field Values

TIME

public static final String 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.

See Also:

Constant Field Values

DATETIME

public static final String 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.

See Also:

Constant Field Values

CHAR1

public static final String CHAR1

This property provides optimized memory, disk and query performance for string columns. Strings with this property must be no longer than 1 character. This property cannot be combined with *text_search*

See Also:

Constant Field Values

CHAR2

public static final String CHAR2

This property provides optimized memory, disk and query performance for string columns. Strings with this property must be no longer than 2 characters. This property cannot be combined with *text_search*

See Also:

Constant Field Values

CHAR4

public static final String CHAR4

This property provides optimized memory, disk and query performance for string columns. Strings with this property must be no longer than 4 characters. This property cannot be combined with *text_search*

See Also:

Constant Field Values

CHAR8

public static final String CHAR8

This property provides optimized memory, disk and query performance for string columns. Strings with this property must be no longer than 8 characters. This property cannot be combined with *text_search*

See Also:

Constant Field Values

CHAR16

public static final String CHAR16

This property provides optimized memory, disk and query performance for string columns. Strings with this property must be no longer than 16 characters. This property cannot be combined with *text_search*

See Also:

Constant Field Values

CHAR32

public static final String CHAR32

This property provides optimized memory, disk and query performance for string columns. Strings with this property must be no longer than 32 characters. This property cannot be combined with *text_search*

See Also:

Constant Field Values

CHAR64

public static final String CHAR64

This property provides optimized memory, disk and query performance for string columns. Strings with this property must be no longer than 64 characters. This property cannot be combined with *text_search*

See Also:

Constant Field Values

CHAR128

public static final String CHAR128

This property provides optimized memory, disk and query performance for string columns. Strings with this property must be no longer than 128 characters. This property cannot be combined with *text_search*

See Also:

Constant Field Values

CHAR256

public static final String CHAR256

This property provides optimized memory, disk and query performance for string columns. Strings with this property must be no longer than 256 characters. This property cannot be combined with *text_search*

See Also:

Constant Field Values

INT8

public static final String INT8

This property provides optimized memory and query performance for int columns. Ints with this property must be between -128 and +127 (inclusive)

See Also:

Constant Field Values

INT16

public static final String INT16

This property provides optimized memory and query performance for int columns. Ints with this property must be between -32768 and +32767 (inclusive)

See Also:

Constant Field Values

IPV4

public static final String 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.

See Also:

Constant Field Values

WKT

public static final String 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.

See Also:

Constant Field Values

PRIMARY_KEY

public static final String PRIMARY_KEY

This property indicates that this column will be part of (or the entire) primary key.

See Also:

Constant Field Values

SHARD_KEY

public static final String SHARD_KEY

This property indicates that this column will be part of (or the entire) shard key.

See Also:

Constant Field Values

NULLABLE

public static final String 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 two languages, one can use this property as usual and not have to worry about the avro schema for the record.

See Also:

Constant Field Values

DICT

public static final String 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 property. 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.

See Also:

Constant Field Values