- Generated by
1.8.15
|
Kinetica C# API
Version 7.2.3.1
|
A set of string constants for the parameter properties. 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 | 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 | COMPRESS = "compress" |
| This property indicates that this column should be compressed with the given codec and optional level; e.g., 'compress(snappy)' for Snappy compression and 'compress(zstd(7))' for zstd level 7 compression. 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... | |
A set of string constants for the parameter properties.
[DEPRECATED–please use these property values in the type_definition directly, as described at the top, instead] 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).
Definition at line 68 of file CreateType.cs.
| const string CreateTypeRequest.Properties.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 224 of file CreateType.cs.
| const string CreateTypeRequest.Properties.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 195 of file CreateType.cs.
| const string 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 141 of file CreateType.cs.
| const string 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 183 of file CreateType.cs.
| const string 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 165 of file CreateType.cs.
| const string 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 147 of file CreateType.cs.
| const string 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 189 of file CreateType.cs.
| const string 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 171 of file CreateType.cs.
| const string 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 153 of file CreateType.cs.
| const string 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 177 of file CreateType.cs.
| const string 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 159 of file CreateType.cs.
| const string CreateTypeRequest.Properties.COMPRESS = "compress" |
This property indicates that this column should be compressed with the given codec and optional level; e.g., 'compress(snappy)' for Snappy compression and 'compress(zstd(7))' for zstd level 7 compression.
This property is primarily used in order to save disk space.
Definition at line 281 of file CreateType.cs.
| const string CreateTypeRequest.Properties.DATA = "data" |
Default property for all numeric and string type columns; makes the column available for GPU queries.
Definition at line 72 of file CreateType.cs.
| const string 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 117 of file CreateType.cs.
| const string 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 135 of file CreateType.cs.
| const string 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 108 of file CreateType.cs.
| const string 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 291 of file CreateType.cs.
| const string 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 296 of file CreateType.cs.
| const string CreateTypeRequest.Properties.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 300 of file CreateType.cs.
| const string 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 207 of file CreateType.cs.
| const string 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 201 of file CreateType.cs.
| const string 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 215 of file CreateType.cs.
| const string CreateTypeRequest.Properties.JSON = "json" |
Valid only for 'string' columns.
Indicates that this field contains values in JSON format.
Definition at line 229 of file CreateType.cs.
| const string 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 272 of file CreateType.cs.
| const string CreateTypeRequest.Properties.PRIMARY_KEY = "primary_key" |
This property indicates that this column will be part of (or the entire) primary key.
Definition at line 246 of file CreateType.cs.
| const string CreateTypeRequest.Properties.SHARD_KEY = "shard_key" |
This property indicates that this column will be part of (or the entire) shard key.
Definition at line 257 of file CreateType.cs.
| const string CreateTypeRequest.Properties.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 252 of file CreateType.cs.
| const string CreateTypeRequest.Properties.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.
Definition at line 79 of file CreateType.cs.
| const string 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 126 of file CreateType.cs.
| const string 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 86 of file CreateType.cs.
| const string 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 93 of file CreateType.cs.
| const string CreateTypeRequest.Properties.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 305 of file CreateType.cs.
| const string CreateTypeRequest.Properties.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 98 of file CreateType.cs.
| const string CreateTypeRequest.Properties.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 235 of file CreateType.cs.
| const string 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 241 of file CreateType.cs.
1.8.15