Kinetica C# API
Version 6.0.1.0
|
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 | 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 | 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 | 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... | |
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). A set of string constants for the parameter <member name="properties">.
Definition at line 63 of file CreateType.cs.
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. This property cannot be combined with text_search
Definition at line 121 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. This property cannot be combined with text_search
Definition at line 163 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. This property cannot be combined with text_search
Definition at line 145 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. This property cannot be combined with text_search
Definition at line 127 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. This property cannot be combined with text_search
Definition at line 169 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. This property cannot be combined with text_search
Definition at line 151 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. This property cannot be combined with text_search
Definition at line 133 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. This property cannot be combined with text_search
Definition at line 157 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. This property cannot be combined with text_search
Definition at line 139 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 68 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.
Definition at line 109 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 103 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 /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.
Definition at line 88 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 179 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 174 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 186 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 <member name="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 Java and C++ 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.
Definition at line 209 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 190 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 194 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.
/filter/bybox)-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 80 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 73 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.
Definition at line 115 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 95 of file CreateType.cs.