Kinetica C# API  Version 7.0.19.0
 All Classes Namespaces Files Functions Variables Enumerations Enumerator Properties Pages
kinetica.CreateTypeRequest.Properties Struct Reference

Each key-value pair specifies the properties to use for a given column where the key is the column name. 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 ULONG = "ulong"
 Valid only for 'string' 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 'date', 'time', 'datetime', or 'timestamp' column types, replace empty strings and invalid timestamps with 'NOW()' upon insert. More...
 

Detailed Description

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. /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: 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 and /aggregate/groupby 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.
  • ULONG: 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: 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.
  • CHAR2: This property provides optimized memory, disk and query performance for string columns. Strings with this property must be no longer than 2 characters.
  • CHAR4: This property provides optimized memory, disk and query performance for string columns. Strings with this property must be no longer than 4 characters.
  • CHAR8: This property provides optimized memory, disk and query performance for string columns. Strings with this property must be no longer than 8 characters.
  • CHAR16: This property provides optimized memory, disk and query performance for string columns. Strings with this property must be no longer than 16 characters.
  • CHAR32: This property provides optimized memory, disk and query performance for string columns. Strings with this property must be no longer than 32 characters.
  • CHAR64: This property provides optimized memory, disk and query performance for string columns. Strings with this property must be no longer than 64 characters.
  • CHAR128: This property provides optimized memory, disk and query performance for string columns. Strings with this property must be no longer than 128 characters.
  • CHAR256: This property provides optimized memory, disk and query performance for string columns. Strings with this property must be no longer than 256 characters.
  • 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 . 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: 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: For 'date', 'time', 'datetime', or 'timestamp' column types, replace empty strings and invalid timestamps with 'NOW()' upon insert.

A set of string constants for the parameter properties.

Definition at line 304 of file CreateType.cs.

Member Data Documentation

const string kinetica.CreateTypeRequest.Properties.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 386 of file CreateType.cs.

const string kinetica.CreateTypeRequest.Properties.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 421 of file CreateType.cs.

const string kinetica.CreateTypeRequest.Properties.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 406 of file CreateType.cs.

const string kinetica.CreateTypeRequest.Properties.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 391 of file CreateType.cs.

const string kinetica.CreateTypeRequest.Properties.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 426 of file CreateType.cs.

const string kinetica.CreateTypeRequest.Properties.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 411 of file CreateType.cs.

const string kinetica.CreateTypeRequest.Properties.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 396 of file CreateType.cs.

const string kinetica.CreateTypeRequest.Properties.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 416 of file CreateType.cs.

const string kinetica.CreateTypeRequest.Properties.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 401 of file CreateType.cs.

const string kinetica.CreateTypeRequest.Properties.DATA = "data"

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

Definition at line 309 of file CreateType.cs.

const string kinetica.CreateTypeRequest.Properties.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 366 of file CreateType.cs.

const string kinetica.CreateTypeRequest.Properties.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 381 of file CreateType.cs.

const string kinetica.CreateTypeRequest.Properties.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 359 of file CreateType.cs.

const string kinetica.CreateTypeRequest.Properties.DICT = "dict"

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.

Definition at line 485 of file CreateType.cs.

const string kinetica.CreateTypeRequest.Properties.DISK_OPTIMIZED = "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 Kinetica.filter(string,string,string,IDictionary{string, string}), Kinetica.filterByList(string,string,IDictionary{string, IList{string}},IDictionary{string, string}), and Kinetica.filterByValue(string,string,bool,double,string,string,IDictionary{string, string}) work as usual but Kinetica.aggregateUnique(string,string,long,long,IDictionary{string, string}) and Kinetica.aggregateGroupBy(string,IList{string},long,long,IDictionary{string, string}) are not allowed on columns with this property.

Definition at line 337 of file CreateType.cs.

const string kinetica.CreateTypeRequest.Properties.INIT_WITH_NOW = "init_with_now"

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

Definition at line 490 of file CreateType.cs.

const string kinetica.CreateTypeRequest.Properties.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 436 of file CreateType.cs.

const string kinetica.CreateTypeRequest.Properties.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 431 of file CreateType.cs.

const string kinetica.CreateTypeRequest.Properties.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 443 of file CreateType.cs.

const string kinetica.CreateTypeRequest.Properties.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 476 of file CreateType.cs.

const string kinetica.CreateTypeRequest.Properties.PRIMARY_KEY = "primary_key"

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

Definition at line 455 of file CreateType.cs.

const string kinetica.CreateTypeRequest.Properties.SHARD_KEY = "shard_key"

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

Definition at line 461 of file CreateType.cs.

const string kinetica.CreateTypeRequest.Properties.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 322 of file CreateType.cs.

const string kinetica.CreateTypeRequest.Properties.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 314 of file CreateType.cs.

const string kinetica.CreateTypeRequest.Properties.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 373 of file CreateType.cs.

const string kinetica.CreateTypeRequest.Properties.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 344 of file CreateType.cs.

const string kinetica.CreateTypeRequest.Properties.ULONG = "ulong"

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.

Definition at line 350 of file CreateType.cs.

const string kinetica.CreateTypeRequest.Properties.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 449 of file CreateType.cs.


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