|
Kinetica C# API
Version 7.0.19.0
|
|
Kinetica C# API
Version 7.0.19.0
|
Additional information about the respective tables in <member name="table_names">. More...
Public Attributes | |
| const string | REQUEST_AVRO_TYPE = "request_avro_type" |
| Method by which this table was created. More... | |
| const string | CREATE_TABLE = "create_table" |
| const string | CREATE_PROJECTION = "create_projection" |
| const string | CREATE_UNION = "create_union" |
| const string | REQUEST_AVRO_JSON = "request_avro_json" |
| The JSON representation of request creating this table. More... | |
| const string | PROTECTED = "protected" |
| Indicates whether the respective table is protected or not. More... | |
| const string | TRUE = "true" |
| const string | FALSE = "false" |
| const string | RECORD_BYTES = "record_bytes" |
| The number of in-memory bytes per record which is the sum of the byte sizes of all columns with property 'data'. More... | |
| const string | COLLECTION_NAMES = "collection_names" |
| The names of the collections this table is part of. More... | |
| const string | TABLE_TTL = "table_ttl" |
| The value of the time-to-live setting. More... | |
| const string | REMAINING_TABLE_TTL = "remaining_table_ttl" |
| The remaining time-to-live, in minutes, before the respective table expires (-1 if it will never expire). More... | |
| const string | FOREIGN_KEYS = "foreign_keys" |
| Semicolon-separated list of foreign keys, of the format 'source_column references target_table(primary_key_column)'. More... | |
| const string | FOREIGN_SHARD_KEY = "foreign_shard_key" |
| Foreign shard key description of the format: 'fk_foreign_key references pk_column_name from pk_table_name(pk_primary_key)'. More... | |
| const string | PARTITION_TYPE = "partition_type" |
Partitioning scheme used for this table Supported values:
| |
| const string | RANGE = "RANGE" |
| Using range partitioning More... | |
| const string | INTERVAL = "INTERVAL" |
| Using interval partitioning More... | |
| const string | LIST = "LIST" |
| Using manual list partitioning More... | |
| const string | NONE = "NONE" |
| Using no partitioning More... | |
| const string | PARTITION_KEYS = "partition_keys" |
| Comma-separated list of partition keys. More... | |
| const string | PARTITION_DEFINITIONS = "partition_definitions" |
| Comma-separated list of partition definitions, whose format depends on the partition_type. More... | |
| const string | IS_AUTOMATIC_PARTITION = "is_automatic_partition" |
| True if partitions will be created for LIST VALUES which don't fall into existing partitions. More... | |
| const string | ATTRIBUTE_INDEXES = "attribute_indexes" |
| Semicolon-separated list of columns that have indexes. More... | |
| const string | COMPRESSED_COLUMNS = "compressed_columns" |
| Semicolon-separated list of compressed columns with the corresponding compression type for each; e.g. More... | |
| const string | COLUMN_INFO = "column_info" |
| JSON-encoded string representing a map of column name to information including memory usage if if the get_column_info option is true. More... | |
| const string | GLOBAL_ACCESS_MODE = "global_access_mode" |
| Returns the global access mode (i.e. More... | |
| const string | NO_ACCESS = "no_access" |
| No read/write operations are allowed on this table. More... | |
| const string | READ_ONLY = "read_only" |
| Only read operations are allowed on this table. More... | |
| const string | WRITE_ONLY = "write_only" |
| Only write operations are allowed on this table. More... | |
| const string | READ_WRITE = "read_write" |
| All read/write operations are allowed on this table. More... | |
| const string | VIEW_TABLE_NAME = "view_table_name" |
| For materialized view the name of the view this member table is part of - if same as the table_name then this is the root of the view. More... | |
| const string | IS_VIEW_PERSISTED = "is_view_persisted" |
| True if the view named view_table_name is persisted - reported for each view member. More... | |
| const string | IS_DIRTY = "is_dirty" |
| True if some input table of the materialized view that affects this member table has been modified since the last refresh. More... | |
| const string | REFRESH_METHOD = "refresh_method" |
| For materialized view current refresh_method - one of manual, periodic, on_change. More... | |
| const string | REFRESH_START_TIME = "refresh_start_time" |
| For materialized view with periodic refresh_method the current intial datetime string that periodic refreshes began. More... | |
| const string | REFRESH_PERIOD = "refresh_period" |
| For materialized view with periodic refresh_method the current refresh period in seconds. More... | |
| const string | LAST_REFRESH_TIME = "last_refresh_time" |
| For materialized view the a datatime string indicating the last time the view was refreshed. More... | |
| const string | NEXT_REFRESH_TIME = "next_refresh_time" |
| For materialized view with periodic refresh_method a datetime string indicating the next time the view is to be refreshed. More... | |
| const string | USER_CHUNK_SIZE = "user_chunk_size" |
| User-specified number of records per chunk, if provided at table creation time. More... | |
| const string | ALTERNATE_SHARD_KEYS = "alternate_shard_keys" |
| Semicolon-separated list of shard keys that were equated in joins (applicable for join tables). More... | |
Additional information about the respective tables in <member name="table_names">.
Supported values:
set of string constants for the parameter <member name="additional_info">.
Definition at line 561 of file ShowTable.cs.
| const string kinetica.ShowTableResponse.AdditionalInfo.ALTERNATE_SHARD_KEYS = "alternate_shard_keys" |
Semicolon-separated list of shard keys that were equated in joins (applicable for join tables).
The default value is ''.
Definition at line 825 of file ShowTable.cs.
| const string kinetica.ShowTableResponse.AdditionalInfo.ATTRIBUTE_INDEXES = "attribute_indexes" |
Semicolon-separated list of columns that have indexes.
Not present for collections. The default value is ''.
Definition at line 713 of file ShowTable.cs.
| const string kinetica.ShowTableResponse.AdditionalInfo.COLLECTION_NAMES = "collection_names" |
The names of the collections this table is part of.
Only set if table is part of a collection
Definition at line 614 of file ShowTable.cs.
| const string kinetica.ShowTableResponse.AdditionalInfo.COLUMN_INFO = "column_info" |
JSON-encoded string representing a map of column name to information including memory usage if if the get_column_info option is true.
The default value is ''.
Definition at line 727 of file ShowTable.cs.
| const string kinetica.ShowTableResponse.AdditionalInfo.COMPRESSED_COLUMNS = "compressed_columns" |
Semicolon-separated list of compressed columns with the corresponding compression type for each; e.g.
: {first_name,snappy};{last_name,lz4hc}. Not present for collections. The default value is ''.
Definition at line 721 of file ShowTable.cs.
| const string kinetica.ShowTableResponse.AdditionalInfo.CREATE_PROJECTION = "create_projection" |
Definition at line 582 of file ShowTable.cs.
| const string kinetica.ShowTableResponse.AdditionalInfo.CREATE_TABLE = "create_table" |
Definition at line 581 of file ShowTable.cs.
| const string kinetica.ShowTableResponse.AdditionalInfo.CREATE_UNION = "create_union" |
Definition at line 583 of file ShowTable.cs.
| const string kinetica.ShowTableResponse.AdditionalInfo.FALSE = "false" |
Definition at line 605 of file ShowTable.cs.
| const string kinetica.ShowTableResponse.AdditionalInfo.FOREIGN_KEYS = "foreign_keys" |
Semicolon-separated list of foreign keys, of the format 'source_column references target_table(primary_key_column)'.
Not present for collections. The default value is ''.
Definition at line 632 of file ShowTable.cs.
| const string kinetica.ShowTableResponse.AdditionalInfo.FOREIGN_SHARD_KEY = "foreign_shard_key" |
Foreign shard key description of the format: 'fk_foreign_key references pk_column_name from pk_table_name(pk_primary_key)'.
Not present for collections. The default value is ''.
Definition at line 638 of file ShowTable.cs.
| const string kinetica.ShowTableResponse.AdditionalInfo.GLOBAL_ACCESS_MODE = "global_access_mode" |
Returns the global access mode (i.e.
lock status) for the table. Supported values:
Definition at line 758 of file ShowTable.cs.
| const string kinetica.ShowTableResponse.AdditionalInfo.INTERVAL = "INTERVAL" |
Using interval partitioning
Definition at line 683 of file ShowTable.cs.
| const string kinetica.ShowTableResponse.AdditionalInfo.IS_AUTOMATIC_PARTITION = "is_automatic_partition" |
True if partitions will be created for LIST VALUES which don't fall into existing partitions.
The default value is ''.
Definition at line 707 of file ShowTable.cs.
| const string kinetica.ShowTableResponse.AdditionalInfo.IS_DIRTY = "is_dirty" |
True if some input table of the materialized view that affects this member table has been modified since the last refresh.
The default value is ''.
Definition at line 790 of file ShowTable.cs.
| const string kinetica.ShowTableResponse.AdditionalInfo.IS_VIEW_PERSISTED = "is_view_persisted" |
True if the view named view_table_name is persisted - reported for each view member.
Means method of recreating this member is saved - not the members data. The default value is ''.
Definition at line 785 of file ShowTable.cs.
| const string kinetica.ShowTableResponse.AdditionalInfo.LAST_REFRESH_TIME = "last_refresh_time" |
For materialized view the a datatime string indicating the last time the view was refreshed.
The default value is ''.
Definition at line 810 of file ShowTable.cs.
| const string kinetica.ShowTableResponse.AdditionalInfo.LIST = "LIST" |
Using manual list partitioning
Definition at line 688 of file ShowTable.cs.
| const string kinetica.ShowTableResponse.AdditionalInfo.NEXT_REFRESH_TIME = "next_refresh_time" |
For materialized view with periodic refresh_method a datetime string indicating the next time the view is to be refreshed.
The default value is ''.
Definition at line 815 of file ShowTable.cs.
| const string kinetica.ShowTableResponse.AdditionalInfo.NO_ACCESS = "no_access" |
No read/write operations are allowed on this table.
Definition at line 762 of file ShowTable.cs.
| const string kinetica.ShowTableResponse.AdditionalInfo.NONE = "NONE" |
Using no partitioning
Definition at line 691 of file ShowTable.cs.
| const string kinetica.ShowTableResponse.AdditionalInfo.PARTITION_DEFINITIONS = "partition_definitions" |
Comma-separated list of partition definitions, whose format depends on the partition_type.
See partitioning documentation for details. The default value is ''.
Definition at line 702 of file ShowTable.cs.
| const string kinetica.ShowTableResponse.AdditionalInfo.PARTITION_KEYS = "partition_keys" |
Comma-separated list of partition keys.
The default value is ''.
Definition at line 695 of file ShowTable.cs.
| const string kinetica.ShowTableResponse.AdditionalInfo.PARTITION_TYPE = "partition_type" |
Partitioning scheme used for this table Supported values:
The default value is NONE.
Definition at line 673 of file ShowTable.cs.
| const string kinetica.ShowTableResponse.AdditionalInfo.PROTECTED = "protected" |
Indicates whether the respective table is protected or not.
Supported values:
Definition at line 603 of file ShowTable.cs.
| const string kinetica.ShowTableResponse.AdditionalInfo.RANGE = "RANGE" |
Using range partitioning
Definition at line 678 of file ShowTable.cs.
| const string kinetica.ShowTableResponse.AdditionalInfo.READ_ONLY = "read_only" |
Only read operations are allowed on this table.
Definition at line 766 of file ShowTable.cs.
| const string kinetica.ShowTableResponse.AdditionalInfo.READ_WRITE = "read_write" |
All read/write operations are allowed on this table.
Definition at line 774 of file ShowTable.cs.
| const string kinetica.ShowTableResponse.AdditionalInfo.RECORD_BYTES = "record_bytes" |
The number of in-memory bytes per record which is the sum of the byte sizes of all columns with property 'data'.
Definition at line 610 of file ShowTable.cs.
| const string kinetica.ShowTableResponse.AdditionalInfo.REFRESH_METHOD = "refresh_method" |
For materialized view current refresh_method - one of manual, periodic, on_change.
The default value is ''.
Definition at line 795 of file ShowTable.cs.
| const string kinetica.ShowTableResponse.AdditionalInfo.REFRESH_PERIOD = "refresh_period" |
For materialized view with periodic refresh_method the current refresh period in seconds.
The default value is ''.
Definition at line 805 of file ShowTable.cs.
| const string kinetica.ShowTableResponse.AdditionalInfo.REFRESH_START_TIME = "refresh_start_time" |
For materialized view with periodic refresh_method the current intial datetime string that periodic refreshes began.
The default value is ''.
Definition at line 800 of file ShowTable.cs.
| const string kinetica.ShowTableResponse.AdditionalInfo.REMAINING_TABLE_TTL = "remaining_table_ttl" |
The remaining time-to-live, in minutes, before the respective table expires (-1 if it will never expire).
Not present for collections.
Definition at line 625 of file ShowTable.cs.
| const string kinetica.ShowTableResponse.AdditionalInfo.REQUEST_AVRO_JSON = "request_avro_json" |
The JSON representation of request creating this table.
The default value is ''.
Definition at line 587 of file ShowTable.cs.
| const string kinetica.ShowTableResponse.AdditionalInfo.REQUEST_AVRO_TYPE = "request_avro_type" |
Method by which this table was created.
Supported values:
Definition at line 580 of file ShowTable.cs.
| const string kinetica.ShowTableResponse.AdditionalInfo.TABLE_TTL = "table_ttl" |
The value of the time-to-live setting.
Not present for collections.
Definition at line 619 of file ShowTable.cs.
| const string kinetica.ShowTableResponse.AdditionalInfo.TRUE = "true" |
Definition at line 604 of file ShowTable.cs.
| const string kinetica.ShowTableResponse.AdditionalInfo.USER_CHUNK_SIZE = "user_chunk_size" |
User-specified number of records per chunk, if provided at table creation time.
The default value is ''.
Definition at line 820 of file ShowTable.cs.
| const string kinetica.ShowTableResponse.AdditionalInfo.VIEW_TABLE_NAME = "view_table_name" |
For materialized view the name of the view this member table is part of - if same as the table_name then this is the root of the view.
The default value is ''.
Definition at line 779 of file ShowTable.cs.
| const string kinetica.ShowTableResponse.AdditionalInfo.WRITE_ONLY = "write_only" |
Only write operations are allowed on this table.
Definition at line 770 of file ShowTable.cs.
1.8.5 
