Class GPUdbColumnProperty

class gpudb.GPUdbColumnProperty[source]

Bases: object

Column properties used for GPUdb record data types. The properties are class-level read-only properties, so the user can use them as such:

GPUdbColumnProperty.prop_name
DATA = 'data'

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

str – Valid only for ‘string’ columns. Enables full text search for string columns. Can be set independently of data and store_only.

STORE_ONLY = 'store_only'

str – 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.

DISK_OPTIMIZED = 'disk_optimized'

str – 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_by_list(), and filter_by_value() work as usual but aggregate_unique() and aggregate_group_by() are not allowed on columns with this property.

TIMESTAMP = 'timestamp'

str – 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.

ULONG = 'ulong'

str – Valid only for ‘string’ columns. It represents an unsigned long integer data type. The string can only be interpreted as an unsigned long data type with minimum value of zero, and maximum value of 18446744073709551615.

DECIMAL = 'decimal'

str – 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 = 'date'

str – 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 = 'time'

str – 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 = 'datetime'

str – 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 = 'char1'

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

CHAR2 = 'char2'

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

CHAR4 = 'char4'

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

CHAR8 = 'char8'

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

CHAR16 = 'char16'

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

CHAR32 = 'char32'

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

CHAR64 = 'char64'

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

CHAR128 = 'char128'

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

CHAR256 = 'char256'

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

INT8 = 'int8'

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

INT16 = 'int16'

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

IPV4 = 'ipv4'

str – 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 = 'wkt'

str – 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 = 'primary_key'

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

SHARD_KEY = 'shard_key'

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

NULLABLE = 'nullable'

str – 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 input parameter type_definition. 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.

DICT = 'dict'

str – This property indicates that this column should be dictionary encoded. It can only be used in conjunction with restricted string (charN), int, long or date columns. Dictionary encoding is best for columns where the cardinality (the number of unique values) is expected to be low. This property can save a large amount of memory.

INIT_WITH_NOW = 'init_with_now'

str – For ‘date’, ‘time’, ‘datetime’, or ‘timestamp’ column types, replace empty strings and invalid timestamps with ‘NOW()’ upon insert.