A set of string constants for the parameter ShowTableResponse.additional_info. More…
Static Public Attributes | |
| const string | REQUEST_AVRO_TYPE = “request_avro_type” |
| Method by which this table was created. | |
| const string | CREATE_TABLE = “create_table” |
| A constant for the ShowTableResponse.AdditionalInfo options. | |
| const string | CREATE_PROJECTION = “create_projection” |
| A constant for the ShowTableResponse.AdditionalInfo options. | |
| const string | CREATE_UNION = “create_union” |
| A constant for the ShowTableResponse.AdditionalInfo options. | |
| const string | REQUEST_AVRO_JSON = “request_avro_json” |
| The JSON representation of request creating this table. | |
| const string | PROTECTED = “protected” |
| No longer used. | |
| const string | TRUE = “true” |
| A boolean constant for the ShowTableResponse.AdditionalInfo options. | |
| const string | FALSE = “false” |
| A boolean constant for the ShowTableResponse.AdditionalInfo options. | |
| 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’. | |
| const string | TOTAL_BYTES = “total_bytes” |
| The total size in bytes of all data stored in the table. | |
| const string | COLLECTION_NAMES = “collection_names” |
| [DEPRECATED–use schema_name instead] This will now contain the name of the schema for the table. | |
| const string | SCHEMA_NAME = “schema_name” |
| The name of the schema for the table. | |
| const string | TABLE_TTL = “table_ttl” |
| The value of the time-to-live setting. | |
| 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). | |
| const string | PRIMARY_KEY_TYPE = “primary_key_type” |
| The primary key type of the table (if it has a primary key). | |
| const string | MEMORY = “memory” |
| In-memory primary key. | |
| const string | DISK = “disk” |
| On-disk primary key. | |
| const string | FOREIGN_KEYS = “foreign_keys” |
| Semicolon-separated list of foreign keys, of the format ‘source_column references target_table(primary_key_column)’. | |
| 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>). | |
| const string | PARTITION_TYPE = “partition_type” |
| Partitioning scheme used for this table. | |
| const string | RANGE = “RANGE” |
| Using range partitioning. | |
| const string | INTERVAL = “INTERVAL” |
| Using interval partitioning. | |
| const string | LIST = “LIST” |
| Using manual list partitioning. | |
| const string | HASH = “HASH” |
| Using hash partitioning. | |
| const string | SERIES = “SERIES” |
| Using series partitioning. | |
| const string | NONE = “NONE” |
| Using no partitioning. | |
| const string | PARTITION_KEYS = “partition_keys” |
| Comma-separated list of partition keys. | |
| const string | PARTITION_DEFINITIONS = “partition_definitions” |
| Comma-separated list of partition definitions, whose format depends on the partition_type. | |
| const string | IS_AUTOMATIC_PARTITION = “is_automatic_partition” |
| True if partitions will be created for LIST VALUES which don’t fall into existing partitions. | |
| const string | ATTRIBUTE_INDEXES = “attribute_indexes” |
| Semicolon-separated list of indexes. | |
| 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. | |
| const string | GLOBAL_ACCESS_MODE = “global_access_mode” |
| Returns the global access mode (i.e. | |
| const string | NO_ACCESS = “no_access” |
| No read/write operations are allowed on this table. | |
| const string | READ_ONLY = “read_only” |
| Only read operations are allowed on this table. | |
| const string | WRITE_ONLY = “write_only” |
| Only write operations are allowed on this table. | |
| const string | READ_WRITE = “read_write” |
| All read/write operations are allowed on this table. | |
| 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. | |
| const string | IS_VIEW_PERSISTED = “is_view_persisted” |
| True if the view named view_table_name is persisted - reported for each view member. | |
| 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. | |
| const string | REFRESH_METHOD = “refresh_method” |
| For materialized view current refresh_method - one of manual, periodic, on_change. | |
| const string | REFRESH_START_TIME = “refresh_start_time” |
| For materialized view with periodic refresh_method the initial datetime string that periodic refreshes began. | |
| const string | REFRESH_STOP_TIME = “refresh_stop_time” |
| Time at which the periodic view refresh stops. | |
| const string | REFRESH_PERIOD = “refresh_period” |
| For materialized view with periodic refresh_method the current refresh period in seconds. | |
| const string | LAST_REFRESH_TIME = “last_refresh_time” |
| For materialized view the datetime string indicating the last time the view was refreshed. | |
| 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. | |
| const string | USER_CHUNK_SIZE = “user_chunk_size” |
| User-specified number of records per chunk, if provided at table creation time. | |
| 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. | |
| 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. | |
| const string | OWNER_RESOURCE_GROUP = “owner_resource_group” |
| Name of the owner resource group. | |
| const string | ALTERNATE_SHARD_KEYS = “alternate_shard_keys” |
| Semicolon-separated list of shard keys that were equated in joins (applicable for join tables). | |
| const string | DATASOURCE_SUBSCRIPTIONS = “datasource_subscriptions” |
| Semicolon-separated list of datasource names the table has subscribed to. | |
| const string | NULL_MODIFYING_COLUMNS = “null_modifying_columns” |
| Comma-separated list of null modifying column names. | |
| const string | COMPRESSION_CODEC = “compression_codec” |
| Default compression codec for the table. | |
| const string | CREATED_BY = “created_by” |
| User that created this table or view. | |
| const string | CREATED_TIME = “created_time” |
| Time (UTC) when this table or view was created. | |
| const string | LAST_READ_BY = “last_read_by” |
| User that last read this table or view. | |
| const string | LAST_READ_TIME = “last_read_time” |
| Time (UTC) when this table or view was last read. | |
| const string | READ_COUNT = “read_count” |
| Count of times this table or view was read. | |
| const string | LAST_WRITE_BY = “last_write_by” |
| User that last wrote to this table. | |
| const string | LAST_WRITE_TIME = “last_write_time” |
| Time (UTC) when this table was last written. | |
| const string | WRITE_COUNT = “write_count” |
| Count of times this table was written. | |
| const string | LAST_ALTER_BY = “last_alter_by” |
| User that last altered this table or view. | |
| const string | LAST_ALTER_TIME = “last_alter_time” |
| Time (UTC) when this table or view was last altered. | |
| const string | ALTER_COUNT = “alter_count” |
| Count of times this table or view was altered. | |
Detailed Description
A set of string constants for the parameter ShowTableResponse.additional_info.
Additional information about the respective tables in ShowTableResponse.table_names.
Definition at line 904 of file ShowTable.cs.
Member Data Documentation
◆ ALTER_COUNT
| static |
Count of times this table or view was altered.
The default value is ”.
Definition at line 1341 of file ShowTable.cs.
◆ ALTERNATE_SHARD_KEYS
| static |
Semicolon-separated list of shard keys that were equated in joins (applicable for join tables).
The default value is ”.
Definition at line 1280 of file ShowTable.cs.
◆ ATTRIBUTE_INDEXES
| static |
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 1151 of file ShowTable.cs.
◆ COLLECTION_NAMES
| static |
[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 982 of file ShowTable.cs.
◆ COLUMN_INFO
| static |
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 1159 of file ShowTable.cs.
◆ COMPRESSION_CODEC
| static |
Default compression codec for the table.
The default value is ”.
Definition at line 1295 of file ShowTable.cs.
◆ CREATE_PROJECTION
| static |
A constant for the ShowTableResponse.AdditionalInfo options.
Definition at line 933 of file ShowTable.cs.
◆ CREATE_TABLE
| static |
A constant for the ShowTableResponse.AdditionalInfo options.
Definition at line 929 of file ShowTable.cs.
◆ CREATE_UNION
| static |
A constant for the ShowTableResponse.AdditionalInfo options.
Definition at line 937 of file ShowTable.cs.
◆ CREATED_BY
| static |
User that created this table or view.
The default value is ”.
Definition at line 1299 of file ShowTable.cs.
◆ CREATED_TIME
| static |
Time (UTC) when this table or view was created.
The default value is ”.
Definition at line 1303 of file ShowTable.cs.
◆ DATASOURCE_SUBSCRIPTIONS
| static |
Semicolon-separated list of datasource names the table has subscribed to.
The default value is ”.
Definition at line 1285 of file ShowTable.cs.
◆ DISK
| static |
On-disk primary key.
Definition at line 1023 of file ShowTable.cs.
◆ FALSE
| static |
A boolean constant for the ShowTableResponse.AdditionalInfo options.
Definition at line 968 of file ShowTable.cs.
◆ FOREIGN_KEYS
| static |
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 1031 of file ShowTable.cs.
◆ FOREIGN_SHARD_KEY
| static |
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 1038 of file ShowTable.cs.
◆ GLOBAL_ACCESS_MODE
| static |
Returns the global access mode (i.e.
lock status) for the table.
Supported values:
- NO_ACCESS: No read/write operations are allowed on this table.
- READ_ONLY: Only read operations are allowed on this table.
- WRITE_ONLY: Only write operations are allowed on this table.
- READ_WRITE: All read/write operations are allowed on this table.
Definition at line 1194 of file ShowTable.cs.
◆ HASH
| static |
Using hash partitioning.
Definition at line 1115 of file ShowTable.cs.
◆ INTERVAL
| static |
Using interval partitioning.
Definition at line 1105 of file ShowTable.cs.
◆ IS_AUTOMATIC_PARTITION
| static |
True if partitions will be created for LIST VALUES which don’t fall into existing partitions.
The default value is ”.
Definition at line 1140 of file ShowTable.cs.
◆ IS_DIRTY
| static |
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 1226 of file ShowTable.cs.
◆ IS_VIEW_PERSISTED
| static |
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 1220 of file ShowTable.cs.
◆ LAST_ALTER_BY
| static |
User that last altered this table or view.
The default value is ”.
Definition at line 1332 of file ShowTable.cs.
◆ LAST_ALTER_TIME
| static |
Time (UTC) when this table or view was last altered.
The default value is ”.
Definition at line 1337 of file ShowTable.cs.
◆ LAST_READ_BY
| static |
User that last read this table or view.
The default value is ”.
Definition at line 1307 of file ShowTable.cs.
◆ LAST_READ_TIME
| static |
Time (UTC) when this table or view was last read.
The default value is ”.
Definition at line 1312 of file ShowTable.cs.
◆ LAST_REFRESH_TIME
| static |
For materialized view the datetime string indicating the last time the view was refreshed.
The default value is ”.
Definition at line 1250 of file ShowTable.cs.
◆ LAST_WRITE_BY
| static |
User that last wrote to this table.
The default value is ”.
Definition at line 1320 of file ShowTable.cs.
◆ LAST_WRITE_TIME
| static |
Time (UTC) when this table was last written.
The default value is ”.
Definition at line 1324 of file ShowTable.cs.
◆ LIST
| static |
Using manual list partitioning.
Definition at line 1110 of file ShowTable.cs.
◆ MEMORY
| static |
In-memory primary key.
Definition at line 1020 of file ShowTable.cs.
◆ NEXT_REFRESH_TIME
| static |
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 1256 of file ShowTable.cs.
◆ NO_ACCESS
| static |
No read/write operations are allowed on this table.
Definition at line 1198 of file ShowTable.cs.
◆ NONE
| static |
Using no partitioning.
Definition at line 1123 of file ShowTable.cs.
◆ NULL_MODIFYING_COLUMNS
| static |
Comma-separated list of null modifying column names.
The default value is ”.
Definition at line 1290 of file ShowTable.cs.
◆ OWNER_RESOURCE_GROUP
| static |
Name of the owner resource group.
The default value is ”.
Definition at line 1275 of file ShowTable.cs.
◆ PARTITION_DEFINITIONS
| static |
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 1135 of file ShowTable.cs.
◆ PARTITION_KEYS
| static |
Comma-separated list of partition keys.
The default value is ”.
Definition at line 1127 of file ShowTable.cs.
◆ PARTITION_TYPE
| static |
Partitioning scheme used for this table.
Supported values:
- RANGE: Using range partitioning.
- INTERVAL: Using interval partitioning.
- LIST: Using manual list partitioning.
- HASH: Using hash partitioning.
- SERIES: Using series partitioning.
- NONE: Using no partitioning.
The default value is NONE.
Definition at line 1095 of file ShowTable.cs.
◆ PRIMARY_KEY_TYPE
| static |
The primary key type of the table (if it has a primary key).
Supported values:
Definition at line 1017 of file ShowTable.cs.
◆ PROTECTED
| static |
No longer used.
Indicated whether the respective table was protected or not. Supported values:
Definition at line 960 of file ShowTable.cs.
◆ RANGE
| static |
Using range partitioning.
Definition at line 1100 of file ShowTable.cs.
◆ READ_COUNT
| static |
Count of times this table or view was read.
The default value is ”.
Definition at line 1316 of file ShowTable.cs.
◆ READ_ONLY
| static |
Only read operations are allowed on this table.
Definition at line 1201 of file ShowTable.cs.
◆ READ_WRITE
| static |
All read/write operations are allowed on this table.
Definition at line 1208 of file ShowTable.cs.
◆ RECORD_BYTES
| static |
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 972 of file ShowTable.cs.
◆ REFRESH_METHOD
| static |
For materialized view current refresh_method - one of manual, periodic, on_change.
The default value is ”.
Definition at line 1231 of file ShowTable.cs.
◆ REFRESH_PERIOD
| static |
For materialized view with periodic refresh_method the current refresh period in seconds.
The default value is ”.
Definition at line 1245 of file ShowTable.cs.
◆ REFRESH_START_TIME
| static |
For materialized view with periodic refresh_method the initial datetime string that periodic refreshes began.
The default value is ”.
Definition at line 1236 of file ShowTable.cs.
◆ REFRESH_STOP_TIME
| static |
Time at which the periodic view refresh stops.
The default value is ”.
Definition at line 1240 of file ShowTable.cs.
◆ REMAINING_TABLE_TTL
| static |
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 998 of file ShowTable.cs.
◆ REQUEST_AVRO_JSON
| static |
The JSON representation of request creating this table.
The default value is ”.
Definition at line 942 of file ShowTable.cs.
◆ REQUEST_AVRO_TYPE
| static |
Method by which this table was created.
Supported values:
Definition at line 925 of file ShowTable.cs.
◆ SCHEMA_NAME
| static |
The name of the schema for the table.
There can only be one schema for a table.
Definition at line 987 of file ShowTable.cs.
◆ SERIES
| static |
Using series partitioning.
Definition at line 1120 of file ShowTable.cs.
◆ TABLE_TTL
| static |
The value of the time-to-live setting.
Not present for schemas.
Definition at line 992 of file ShowTable.cs.
◆ TOTAL_BYTES
| static |
The total size in bytes of all data stored in the table.
Definition at line 976 of file ShowTable.cs.
◆ TRUE
| static |
A boolean constant for the ShowTableResponse.AdditionalInfo options.
Definition at line 964 of file ShowTable.cs.
◆ USER_CHUNK_COLUMN_MAX_MEMORY
| static |
User-specified target max bytes per column in a chunk, if provided at table creation time.
The default value is ”.
Definition at line 1266 of file ShowTable.cs.
◆ USER_CHUNK_MAX_MEMORY
| static |
User-specified target max bytes for all columns in a chunk, if provided at table creation time.
The default value is ”.
Definition at line 1271 of file ShowTable.cs.
◆ USER_CHUNK_SIZE
| static |
User-specified number of records per chunk, if provided at table creation time.
The default value is ”.
Definition at line 1261 of file ShowTable.cs.
◆ VIEW_TABLE_NAME
| static |
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 1214 of file ShowTable.cs.
◆ WRITE_COUNT
| static |
Count of times this table was written.
The default value is ”.
Definition at line 1328 of file ShowTable.cs.
◆ WRITE_ONLY
| static |
Only write operations are allowed on this table.
Definition at line 1204 of file ShowTable.cs.
The documentation for this struct was generated from the following files:
- _build/public-os_ubuntu24.04-arch_amd64-cc_gcc_13.3.0/install/Kinetica/Protocol/ShowTable.cs
- Kinetica/Protocol/ShowTable.cs