|
Kinetica C# API
Version 7.2.3.1
|
A set of string constants for the parameter additional_info. 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" |
| No longer used. 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 | TOTAL_BYTES = "total_bytes" |
| The total size in bytes of all data stored in the table. More... | |
| const string | COLLECTION_NAMES = "collection_names" |
| [DEPRECATED–use schema_name instead] This will now contain the name of the schema for the table. More... | |
| const string | SCHEMA_NAME = "schema_name" |
| The name of the schema for the table. 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 | PRIMARY_KEY_TYPE = "primary_key_type" |
| The primary key type of the table (if it has a primary key). More... | |
| const string | MEMORY = "memory" |
| In-memory primary key. More... | |
| const string | DISK = "disk" |
| On-disk primary key. 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. More... | |
| 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 | HASH = "HASH" |
| Using hash partitioning. More... | |
| const string | SERIES = "SERIES" |
| Using series 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 indexes. More... | |
| const string | COLUMN_INFO = "column_info" |
| JSON-encoded string representing a map of column name to information including memory usage 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 initial datetime string that periodic refreshes began. More... | |
| const string | REFRESH_STOP_TIME = "refresh_stop_time" |
| Time at which the periodic view refresh stops. 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 datetime 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 | USER_CHUNK_COLUMN_MAX_MEMORY = "user_chunk_column_max_memory" |
| User-specified target max bytes per column in a chunk, if provided at table creation time. More... | |
| const string | USER_CHUNK_MAX_MEMORY = "user_chunk_max_memory" |
| User-specified target max bytes for all columns in a chunk, if provided at table creation time. More... | |
| const string | OWNER_RESOURCE_GROUP = "owner_resource_group" |
| Name of the owner resource group. 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... | |
| const string | DATASOURCE_SUBSCRIPTIONS = "datasource_subscriptions" |
| Semicolon-separated list of datasource names the table has subscribed to. More... | |
| const string | NULL_MODIFYING_COLUMNS = "null_modifying_columns" |
| Comma-separated list of null modifying column names. More... | |
| const string | COMPRESSION_CODEC = "compression_codec" |
| Default compression codec for the table. More... | |
| const string | CREATED_BY = "created_by" |
| User that created this table or view. More... | |
| const string | CREATED_TIME = "created_time" |
| Time (UTC) when this table or view was created. More... | |
| const string | LAST_READ_BY = "last_read_by" |
| User that last read this table or view. More... | |
| const string | LAST_READ_TIME = "last_read_time" |
| Time (UTC) when this table or view was last read. More... | |
| const string | READ_COUNT = "read_count" |
| Count of times this table or view was read. More... | |
| const string | LAST_WRITE_BY = "last_write_by" |
| User that last wrote to this table. More... | |
| const string | LAST_WRITE_TIME = "last_write_time" |
| Time (UTC) when this table was last written. More... | |
| const string | WRITE_COUNT = "write_count" |
| Count of times this table was written. More... | |
| const string | LAST_ALTER_BY = "last_alter_by" |
| User that last altered this table or view. More... | |
| const string | LAST_ALTER_TIME = "last_alter_time" |
| Time (UTC) when this table or view was last altered. More... | |
| const string | ALTER_COUNT = "alter_count" |
| Count of times this table or view was altered. More... | |
A set of string constants for the parameter additional_info.
Additional information about the respective tables in table_names.
Definition at line 702 of file ShowTable.cs.
| const string ShowTableResponse.AdditionalInfo.ALTER_COUNT = "alter_count" |
Count of times this table or view was altered.
The default value is ''.
Definition at line 1102 of file ShowTable.cs.
| const string 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 1041 of file ShowTable.cs.
| const string ShowTableResponse.AdditionalInfo.ATTRIBUTE_INDEXES = "attribute_indexes" |
Semicolon-separated list of indexes.
For column (attribute) indexes, only the indexed column name will be listed. For other index types, the index type will be listed with the colon-delimited indexed column(s) and the comma-delimited index option(s) using the form: <index_type><column_list><column_options>. Not present for schemas. The default value is ''.
Definition at line 916 of file ShowTable.cs.
| const string ShowTableResponse.AdditionalInfo.COLLECTION_NAMES = "collection_names" |
[DEPRECATED–use schema_name instead] This will now contain the name of the schema for the table.
There can only be one schema for a table.
Definition at line 761 of file ShowTable.cs.
| const string ShowTableResponse.AdditionalInfo.COLUMN_INFO = "column_info" |
JSON-encoded string representing a map of column name to information including memory usage if the GET_COLUMN_INFO option is TRUE.
The default value is ''.
Definition at line 924 of file ShowTable.cs.
| const string ShowTableResponse.AdditionalInfo.COMPRESSION_CODEC = "compression_codec" |
Default compression codec for the table.
The default value is ''.
Definition at line 1056 of file ShowTable.cs.
| const string ShowTableResponse.AdditionalInfo.CREATE_PROJECTION = "create_projection" |
Definition at line 726 of file ShowTable.cs.
| const string ShowTableResponse.AdditionalInfo.CREATE_TABLE = "create_table" |
Definition at line 725 of file ShowTable.cs.
| const string ShowTableResponse.AdditionalInfo.CREATE_UNION = "create_union" |
Definition at line 727 of file ShowTable.cs.
| const string ShowTableResponse.AdditionalInfo.CREATED_BY = "created_by" |
User that created this table or view.
The default value is ''.
Definition at line 1060 of file ShowTable.cs.
| const string ShowTableResponse.AdditionalInfo.CREATED_TIME = "created_time" |
Time (UTC) when this table or view was created.
The default value is ''.
Definition at line 1064 of file ShowTable.cs.
| const string ShowTableResponse.AdditionalInfo.DATASOURCE_SUBSCRIPTIONS = "datasource_subscriptions" |
Semicolon-separated list of datasource names the table has subscribed to.
The default value is ''.
Definition at line 1046 of file ShowTable.cs.
| const string ShowTableResponse.AdditionalInfo.DISK = "disk" |
On-disk primary key.
Definition at line 799 of file ShowTable.cs.
| const string ShowTableResponse.AdditionalInfo.FALSE = "false" |
Definition at line 747 of file ShowTable.cs.
| const string 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 schemas. The default value is ''.
Definition at line 807 of file ShowTable.cs.
| const string 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 schemas. The default value is ''.
Definition at line 814 of file ShowTable.cs.
| const string 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 955 of file ShowTable.cs.
| const string ShowTableResponse.AdditionalInfo.HASH = "HASH" |
Using hash partitioning.
Definition at line 880 of file ShowTable.cs.
| const string ShowTableResponse.AdditionalInfo.INTERVAL = "INTERVAL" |
Using interval partitioning.
Definition at line 870 of file ShowTable.cs.
| const string 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 905 of file ShowTable.cs.
| const string 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 987 of file ShowTable.cs.
| const string 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 981 of file ShowTable.cs.
| const string ShowTableResponse.AdditionalInfo.LAST_ALTER_BY = "last_alter_by" |
User that last altered this table or view.
The default value is ''.
Definition at line 1093 of file ShowTable.cs.
| const string ShowTableResponse.AdditionalInfo.LAST_ALTER_TIME = "last_alter_time" |
Time (UTC) when this table or view was last altered.
The default value is ''.
Definition at line 1098 of file ShowTable.cs.
| const string ShowTableResponse.AdditionalInfo.LAST_READ_BY = "last_read_by" |
User that last read this table or view.
The default value is ''.
Definition at line 1068 of file ShowTable.cs.
| const string ShowTableResponse.AdditionalInfo.LAST_READ_TIME = "last_read_time" |
Time (UTC) when this table or view was last read.
The default value is ''.
Definition at line 1073 of file ShowTable.cs.
| const string ShowTableResponse.AdditionalInfo.LAST_REFRESH_TIME = "last_refresh_time" |
For materialized view the datetime string indicating the last time the view was refreshed.
The default value is ''.
Definition at line 1011 of file ShowTable.cs.
| const string ShowTableResponse.AdditionalInfo.LAST_WRITE_BY = "last_write_by" |
User that last wrote to this table.
The default value is ''.
Definition at line 1081 of file ShowTable.cs.
| const string ShowTableResponse.AdditionalInfo.LAST_WRITE_TIME = "last_write_time" |
Time (UTC) when this table was last written.
The default value is ''.
Definition at line 1085 of file ShowTable.cs.
| const string ShowTableResponse.AdditionalInfo.LIST = "LIST" |
Using manual list partitioning.
Definition at line 875 of file ShowTable.cs.
| const string ShowTableResponse.AdditionalInfo.MEMORY = "memory" |
In-memory primary key.
Definition at line 796 of file ShowTable.cs.
| const string 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 1017 of file ShowTable.cs.
| const string ShowTableResponse.AdditionalInfo.NO_ACCESS = "no_access" |
No read/write operations are allowed on this table.
Definition at line 959 of file ShowTable.cs.
| const string ShowTableResponse.AdditionalInfo.NONE = "NONE" |
Using no partitioning.
Definition at line 888 of file ShowTable.cs.
| const string ShowTableResponse.AdditionalInfo.NULL_MODIFYING_COLUMNS = "null_modifying_columns" |
Comma-separated list of null modifying column names.
The default value is ''.
Definition at line 1051 of file ShowTable.cs.
| const string ShowTableResponse.AdditionalInfo.OWNER_RESOURCE_GROUP = "owner_resource_group" |
Name of the owner resource group.
The default value is ''.
Definition at line 1036 of file ShowTable.cs.
| const string 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 900 of file ShowTable.cs.
| const string ShowTableResponse.AdditionalInfo.PARTITION_KEYS = "partition_keys" |
Comma-separated list of partition keys.
The default value is ''.
Definition at line 892 of file ShowTable.cs.
| const string ShowTableResponse.AdditionalInfo.PARTITION_TYPE = "partition_type" |
Partitioning scheme used for this table.
Supported values:
The default value is NONE.
Definition at line 860 of file ShowTable.cs.
| const string ShowTableResponse.AdditionalInfo.PRIMARY_KEY_TYPE = "primary_key_type" |
The primary key type of the table (if it has a primary key).
Supported values:
Definition at line 793 of file ShowTable.cs.
| const string ShowTableResponse.AdditionalInfo.PROTECTED = "protected" |
| const string ShowTableResponse.AdditionalInfo.RANGE = "RANGE" |
Using range partitioning.
Definition at line 865 of file ShowTable.cs.
| const string ShowTableResponse.AdditionalInfo.READ_COUNT = "read_count" |
Count of times this table or view was read.
The default value is ''.
Definition at line 1077 of file ShowTable.cs.
| const string ShowTableResponse.AdditionalInfo.READ_ONLY = "read_only" |
Only read operations are allowed on this table.
Definition at line 962 of file ShowTable.cs.
| const string ShowTableResponse.AdditionalInfo.READ_WRITE = "read_write" |
All read/write operations are allowed on this table.
Definition at line 969 of file ShowTable.cs.
| const string 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 751 of file ShowTable.cs.
| const string 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 992 of file ShowTable.cs.
| const string 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 1006 of file ShowTable.cs.
| const string ShowTableResponse.AdditionalInfo.REFRESH_START_TIME = "refresh_start_time" |
For materialized view with periodic refresh_method the initial datetime string that periodic refreshes began.
The default value is ''.
Definition at line 997 of file ShowTable.cs.
| const string ShowTableResponse.AdditionalInfo.REFRESH_STOP_TIME = "refresh_stop_time" |
Time at which the periodic view refresh stops.
The default value is ''.
Definition at line 1001 of file ShowTable.cs.
| const string 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 schemas.
Definition at line 777 of file ShowTable.cs.
| const string ShowTableResponse.AdditionalInfo.REQUEST_AVRO_JSON = "request_avro_json" |
The JSON representation of request creating this table.
The default value is ''.
Definition at line 732 of file ShowTable.cs.
| const string ShowTableResponse.AdditionalInfo.REQUEST_AVRO_TYPE = "request_avro_type" |
Method by which this table was created.
Supported values:
Definition at line 723 of file ShowTable.cs.
| const string ShowTableResponse.AdditionalInfo.SCHEMA_NAME = "schema_name" |
The name of the schema for the table.
There can only be one schema for a table.
Definition at line 766 of file ShowTable.cs.
| const string ShowTableResponse.AdditionalInfo.SERIES = "SERIES" |
Using series partitioning.
Definition at line 885 of file ShowTable.cs.
| const string ShowTableResponse.AdditionalInfo.TABLE_TTL = "table_ttl" |
The value of the time-to-live setting.
Not present for schemas.
Definition at line 771 of file ShowTable.cs.
| const string ShowTableResponse.AdditionalInfo.TOTAL_BYTES = "total_bytes" |
The total size in bytes of all data stored in the table.
Definition at line 755 of file ShowTable.cs.
| const string ShowTableResponse.AdditionalInfo.TRUE = "true" |
Definition at line 746 of file ShowTable.cs.
| const string ShowTableResponse.AdditionalInfo.USER_CHUNK_COLUMN_MAX_MEMORY = "user_chunk_column_max_memory" |
User-specified target max bytes per column in a chunk, if provided at table creation time.
The default value is ''.
Definition at line 1027 of file ShowTable.cs.
| const string ShowTableResponse.AdditionalInfo.USER_CHUNK_MAX_MEMORY = "user_chunk_max_memory" |
User-specified target max bytes for all columns in a chunk, if provided at table creation time.
The default value is ''.
Definition at line 1032 of file ShowTable.cs.
| const string 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 1022 of file ShowTable.cs.
| const string 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 975 of file ShowTable.cs.
| const string ShowTableResponse.AdditionalInfo.WRITE_COUNT = "write_count" |
Count of times this table was written.
The default value is ''.
Definition at line 1089 of file ShowTable.cs.
| const string ShowTableResponse.AdditionalInfo.WRITE_ONLY = "write_only" |
Only write operations are allowed on this table.
Definition at line 965 of file ShowTable.cs.