- Generated by
1.8.15
|
Kinetica C# API
Version 7.2.3.0
|
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 select '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 | UUID = "uuid" |
| 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 | BOOLEAN = "boolean" |
| This property provides optimized memory and query performance for int 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 | ARRAY = "array" |
| Valid only for 'string' columns. More... | |
| const string | JSON = "json" |
| Valid only for 'string' columns. More... | |
| const string | VECTOR = "vector" |
| Valid only for 'bytes' columns. 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 | SOFT_PRIMARY_KEY = "soft_primary_key" |
| This property indicates that this column will be part of (or the entire) soft 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... | |
| const string | INIT_WITH_UUID = "init_with_uuid" |
| For 'uuid' type, replace empty strings and invalid UUID values with randomly-generated UUIDs upon insert. More... | |
| const string | UPDATE_WITH_NOW = "update_with_now" |
| For 'date', 'time', 'datetime', or 'timestamp' column types, always update the field with 'NOW()' upon any update. More... | |
Column properties used for Kinetica types.
Definition at line 10 of file ColumnProperty.cs.
| const string kinetica.ColumnProperty.ARRAY = "array" |
Valid only for 'string' columns.
Indicates that this field contains an array. The value type and (optionally) the item count should be specified in parenthesis; e.g., 'array(int, 10)' for a 10-integer array. Both 'array(int)' and 'array(int, -1)' will designate an unlimited-length integer array, though no bounds checking is performed on arrays of any length.
Definition at line 188 of file ColumnProperty.cs.
| const string kinetica.ColumnProperty.BOOLEAN = "boolean" |
This property provides optimized memory and query performance for int columns.
Ints with this property must be between 0 and 1(inclusive)
Definition at line 159 of file ColumnProperty.cs.
| 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 105 of file ColumnProperty.cs.
| 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 147 of file ColumnProperty.cs.
| 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 129 of file ColumnProperty.cs.
| 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 111 of file ColumnProperty.cs.
| 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 153 of file ColumnProperty.cs.
| 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 135 of file ColumnProperty.cs.
| 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 117 of file ColumnProperty.cs.
| 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 141 of file ColumnProperty.cs.
| 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 123 of file ColumnProperty.cs.
| 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 14 of file ColumnProperty.cs.
| 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 83 of file ColumnProperty.cs.
| 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 99 of file ColumnProperty.cs.
| 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 75 of file ColumnProperty.cs.
| const string kinetica.ColumnProperty.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 247 of file ColumnProperty.cs.
| const string kinetica.ColumnProperty.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, Kinetica.filterByList, and Kinetica.filterByValue work as usual but Kinetica.aggregateUnique and Kinetica.aggregateGroupBy are not allowed on columns with this property.
Definition at line 47 of file ColumnProperty.cs.
| const string kinetica.ColumnProperty.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 252 of file ColumnProperty.cs.
| const string kinetica.ColumnProperty.INIT_WITH_UUID = "init_with_uuid" |
For 'uuid' type, replace empty strings and invalid UUID values with randomly-generated UUIDs upon insert.
Definition at line 256 of file ColumnProperty.cs.
| 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 171 of file ColumnProperty.cs.
| 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 165 of file ColumnProperty.cs.
| 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 179 of file ColumnProperty.cs.
| const string kinetica.ColumnProperty.JSON = "json" |
Valid only for 'string' columns.
Indicates that this field contains values in JSON format.
Definition at line 193 of file ColumnProperty.cs.
| 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 237 of file ColumnProperty.cs.
| 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 210 of file ColumnProperty.cs.
| 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 221 of file ColumnProperty.cs.
| const string kinetica.ColumnProperty.SOFT_PRIMARY_KEY = "soft_primary_key" |
This property indicates that this column will be part of (or the entire) soft primary key.
Definition at line 216 of file ColumnProperty.cs.
| const string kinetica.ColumnProperty.STORE_ONLY = "store_only" |
Persist the column value but do not make it available to queries (e.g.
Kinetica.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.
Definition at line 32 of file ColumnProperty.cs.
| const string kinetica.ColumnProperty.TEXT_SEARCH = "text_search" |
Valid only for select 'string' columns.
Enables full text search–see Full Text Search for details and applicable string column types. Can be set independently of DATA and STORE_ONLY.
Definition at line 22 of file ColumnProperty.cs.
| 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 91 of file ColumnProperty.cs.
| 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.
| const string kinetica.ColumnProperty.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 61 of file ColumnProperty.cs.
| const string kinetica.ColumnProperty.UPDATE_WITH_NOW = "update_with_now" |
For 'date', 'time', 'datetime', or 'timestamp' column types, always update the field with 'NOW()' upon any update.
Definition at line 261 of file ColumnProperty.cs.
| const string kinetica.ColumnProperty.UUID = "uuid" |
Valid only for 'string' columns.
It represents an uuid data type. Internally, it is stored as a 128-bit integer.
Definition at line 66 of file ColumnProperty.cs.
| const string kinetica.ColumnProperty.VECTOR = "vector" |
Valid only for 'bytes' columns.
Indicates that this field contains a vector of floats. The length should be specified in parenthesis, e.g., 'vector(1000)'.
Definition at line 199 of file ColumnProperty.cs.
| 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 205 of file ColumnProperty.cs.
1.8.15