Kinetica C# API  Version 6.2.0.1
kinetica.ColumnProperty Struct Reference

Column properties used for Kinetica types. More...

Public Attributes

const string DATA = "data"
 Default property for all numeric and string type columns; makes the column available for GPU queries. More...
 
const string TEXT_SEARCH = "text_search"
 Valid only for 'string' columns. More...
 
const string STORE_ONLY = "store_only"
 Persist the column value but do not make it available to queries (e.g. More...
 
const string DISK_OPTIMIZED = "disk_optimized"
 Works in conjunction with the data property for string columns. More...
 
const string TIMESTAMP = "timestamp"
 Valid only for 'long' columns. More...
 
const string DECIMAL = "decimal"
 Valid only for 'string' columns. More...
 
const string DATE = "date"
 Valid only for 'string' columns. More...
 
const string TIME = "time"
 Valid only for 'string' columns. More...
 
const string DATETIME = "datetime"
 Valid only for 'string' columns. More...
 
const string CHAR1 = "char1"
 This property provides optimized memory, disk and query performance for string columns. More...
 
const string CHAR2 = "char2"
 This property provides optimized memory, disk and query performance for string columns. More...
 
const string CHAR4 = "char4"
 This property provides optimized memory, disk and query performance for string columns. More...
 
const string CHAR8 = "char8"
 This property provides optimized memory, disk and query performance for string columns. More...
 
const string CHAR16 = "char16"
 This property provides optimized memory, disk and query performance for string columns. More...
 
const string CHAR32 = "char32"
 This property provides optimized memory, disk and query performance for string columns. More...
 
const string CHAR64 = "char64"
 This property provides optimized memory, disk and query performance for string columns. More...
 
const string CHAR128 = "char128"
 This property provides optimized memory, disk and query performance for string columns. More...
 
const string CHAR256 = "char256"
 This property provides optimized memory, disk and query performance for string columns. More...
 
const string INT8 = "int8"
 This property provides optimized memory and query performance for int columns. More...
 
const string INT16 = "int16"
 This property provides optimized memory and query performance for int columns. More...
 
const string IPV4 = "ipv4"
 This property provides optimized memory, disk and query performance for string columns representing IPv4 addresses (i.e. More...
 
const string WKT = "wkt"
 Valid only for 'string' and 'bytes' columns. More...
 
const string PRIMARY_KEY = "primary_key"
 This property indicates that this column will be part of (or the entire) primary key. More...
 
const string SHARD_KEY = "shard_key"
 This property indicates that this column will be part of (or the entire) shard key. More...
 
const string NULLABLE = "nullable"
 This property indicates that this column is nullable. More...
 
const string DICT = "dict"
 This property indicates that this column should be dictionary encoded. More...
 
const string INIT_WITH_NOW = "init_with_now"
 For columns with attributes of date, time, datetime or timestamp, at insert time, replace empty strings and invalid timestamps with NOW() More...
 

Detailed Description

Column properties used for Kinetica types.

Definition at line 12 of file ColumnProperty.cs.

Member Data Documentation

◆ CHAR1

const string kinetica.ColumnProperty.CHAR1 = "char1"

This property provides optimized memory, disk and query performance for string columns.

Strings with this property must be no longer than 1 character.

Definition at line 88 of file ColumnProperty.cs.

◆ CHAR128

const string kinetica.ColumnProperty.CHAR128 = "char128"

This property provides optimized memory, disk and query performance for string columns.

Strings with this property must be no longer than 128 characters.

Definition at line 123 of file ColumnProperty.cs.

◆ CHAR16

const string kinetica.ColumnProperty.CHAR16 = "char16"

This property provides optimized memory, disk and query performance for string columns.

Strings with this property must be no longer than 16 characters.

Definition at line 108 of file ColumnProperty.cs.

◆ CHAR2

const string kinetica.ColumnProperty.CHAR2 = "char2"

This property provides optimized memory, disk and query performance for string columns.

Strings with this property must be no longer than 2 characters.

Definition at line 93 of file ColumnProperty.cs.

◆ CHAR256

const string kinetica.ColumnProperty.CHAR256 = "char256"

This property provides optimized memory, disk and query performance for string columns.

Strings with this property must be no longer than 256 characters.

Definition at line 128 of file ColumnProperty.cs.

◆ CHAR32

const string kinetica.ColumnProperty.CHAR32 = "char32"

This property provides optimized memory, disk and query performance for string columns.

Strings with this property must be no longer than 32 characters.

Definition at line 113 of file ColumnProperty.cs.

◆ CHAR4

const string kinetica.ColumnProperty.CHAR4 = "char4"

This property provides optimized memory, disk and query performance for string columns.

Strings with this property must be no longer than 4 characters.

Definition at line 98 of file ColumnProperty.cs.

◆ CHAR64

const string kinetica.ColumnProperty.CHAR64 = "char64"

This property provides optimized memory, disk and query performance for string columns.

Strings with this property must be no longer than 64 characters.

Definition at line 118 of file ColumnProperty.cs.

◆ CHAR8

const string kinetica.ColumnProperty.CHAR8 = "char8"

This property provides optimized memory, disk and query performance for string columns.

Strings with this property must be no longer than 8 characters.

Definition at line 103 of file ColumnProperty.cs.

◆ DATA

const string kinetica.ColumnProperty.DATA = "data"

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

Definition at line 17 of file ColumnProperty.cs.

◆ DATE

const string kinetica.ColumnProperty.DATE = "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.

Definition at line 69 of file ColumnProperty.cs.

◆ DATETIME

const string kinetica.ColumnProperty.DATETIME = "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.

Definition at line 83 of file ColumnProperty.cs.

◆ DECIMAL

const string kinetica.ColumnProperty.DECIMAL = "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.

Definition at line 62 of file ColumnProperty.cs.

◆ DICT

const string kinetica.ColumnProperty.DICT = "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.

Definition at line 181 of file ColumnProperty.cs.

◆ DISK_OPTIMIZED

◆ INIT_WITH_NOW

const string kinetica.ColumnProperty.INIT_WITH_NOW = "init_with_now"

For columns with attributes of date, time, datetime or timestamp, at insert time, replace empty strings and invalid timestamps with NOW()

Definition at line 186 of file ColumnProperty.cs.

◆ INT16

const string kinetica.ColumnProperty.INT16 = "int16"

This property provides optimized memory and query performance for int columns.

Ints with this property must be between -32768 and +32767 (inclusive)

Definition at line 138 of file ColumnProperty.cs.

◆ INT8

const string kinetica.ColumnProperty.INT8 = "int8"

This property provides optimized memory and query performance for int columns.

Ints with this property must be between -128 and +127 (inclusive)

Definition at line 133 of file ColumnProperty.cs.

◆ IPV4

const string kinetica.ColumnProperty.IPV4 = "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.

Definition at line 144 of file ColumnProperty.cs.

◆ NULLABLE

const string kinetica.ColumnProperty.NULLABLE = "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 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.

Definition at line 173 of file ColumnProperty.cs.

◆ PRIMARY_KEY

const string kinetica.ColumnProperty.PRIMARY_KEY = "primary_key"

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

Definition at line 154 of file ColumnProperty.cs.

◆ SHARD_KEY

const string kinetica.ColumnProperty.SHARD_KEY = "shard_key"

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

Definition at line 159 of file ColumnProperty.cs.

◆ STORE_ONLY

const string kinetica.ColumnProperty.STORE_ONLY = "store_only"

Persist the column value but do not make it available to queries (e.g.

Kinetica.filter(string,string,string,IDictionary<string, string>))-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.

Definition at line 30 of file ColumnProperty.cs.

◆ TEXT_SEARCH

const string kinetica.ColumnProperty.TEXT_SEARCH = "text_search"

Valid only for 'string' columns.

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

Definition at line 22 of file ColumnProperty.cs.

◆ TIME

const string kinetica.ColumnProperty.TIME = "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.

Definition at line 76 of file ColumnProperty.cs.

◆ TIMESTAMP

const string kinetica.ColumnProperty.TIMESTAMP = "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.

Definition at line 54 of file ColumnProperty.cs.

◆ WKT

const string kinetica.ColumnProperty.WKT = "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.

Definition at line 149 of file ColumnProperty.cs.


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