Skip to main content

Constants for the fields of the /show/table response.

Option fields

additional_info

Constants for additional_info.

pub const ALTERNATE_SHARD_KEYS: &str = “alternate_shard_keys”;

Semicolon-separated list of shard keys that were equated in joins (applicable for join tables).

pub const ALTER_COUNT: &str = “alter_count”;

Count of times this table or view was altered.

pub const ATTRIBUTE_INDEXES: &str = “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.

pub const COLLECTION_NAMES: &str = “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.

pub const COLUMN_INFO: &str = “column_info”;

JSON-encoded string representing a map of column name to information including memory usage if the get_column_info option is true.

pub const COMPRESSION_CODEC: &str = “compression_codec”;

Default compression codec for the table.

pub const CREATED_BY: &str = “created_by”;

User that created this table or view.

pub const CREATED_TIME: &str = “created_time”;

Time (UTC) when this table or view was created.

pub const CREATE_PROJECTION: &str = “create_projection”;
pub const CREATE_TABLE: &str = “create_table”;
pub const CREATE_UNION: &str = “create_union”;
pub const DATASOURCE_SUBSCRIPTIONS: &str = “datasource_subscriptions”;

Semicolon-separated list of datasource names the table has subscribed to.

pub const DISK: &str = “disk”;

On-disk primary key.

pub const FALSE: &str = “false”;
pub const FOREIGN_KEYS: &str = “foreign_keys”;

Semicolon-separated list of foreign keys, of the format ‘source_column references target_table(primary_key_column)’. Not present for schemas.

pub const FOREIGN_SHARD_KEY: &str = “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.

pub const GLOBAL_ACCESS_MODE: &str = “global_access_mode”;

Returns the global access mode (i.e. lock status) for the table.

pub const HASH: &str = “HASH”;

Using hash partitioning.

pub const INTERVAL: &str = “INTERVAL”;

Using interval partitioning.

pub const IS_AUTOMATIC_PARTITION: &str = “is_automatic_partition”;

True if partitions will be created for LIST VALUES which don’t fall into existing partitions.

pub const IS_DIRTY: &str = “is_dirty”;

True if some input table of the materialized view that affects this member table has been modified since the last refresh.

pub const IS_VIEW_PERSISTED: &str = “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.

pub const LAST_ALTER_BY: &str = “last_alter_by”;

User that last altered this table or view.

pub const LAST_ALTER_TIME: &str = “last_alter_time”;

Time (UTC) when this table or view was last altered.

pub const LAST_READ_BY: &str = “last_read_by”;

User that last read this table or view.

pub const LAST_READ_TIME: &str = “last_read_time”;

Time (UTC) when this table or view was last read.

pub const LAST_REFRESH_TIME: &str = “last_refresh_time”;

For materialized view the datetime string indicating the last time the view was refreshed.

pub const LAST_WRITE_BY: &str = “last_write_by”;

User that last wrote to this table.

pub const LAST_WRITE_TIME: &str = “last_write_time”;

Time (UTC) when this table was last written.

pub const LIST: &str = “LIST”;

Using manual list partitioning.

pub const MEMORY: &str = “memory”;

In-memory primary key.

pub const NEXT_REFRESH_TIME: &str = “next_refresh_time”;

For materialized view with periodic refresh_method a datetime string indicating the next time the view is to be refreshed.

pub const NONE: &str = “NONE”;

Using no partitioning.

pub const NO_ACCESS: &str = “no_access”;

No read/write operations are allowed on this table.

pub const NULL_MODIFYING_COLUMNS: &str = “null_modifying_columns”;

Comma-separated list of null modifying column names.

pub const OWNER_RESOURCE_GROUP: &str = “owner_resource_group”;

Name of the owner resource group.

pub const PARTITION_DEFINITIONS: &str = “partition_definitions”;

Comma-separated list of partition definitions, whose format depends on the partition_type. See partitioning documentation for details.

pub const PARTITION_KEYS: &str = “partition_keys”;

Comma-separated list of partition keys.

pub const PARTITION_TYPE: &str = “partition_type”;

Partitioning scheme used for this table.

pub const PRIMARY_KEY_TYPE: &str = “primary_key_type”;

The primary key type of the table (if it has a primary key).

pub const PROTECTED: &str = “protected”;

No longer used. Indicated whether the respective table was protected or not.

pub const RANGE: &str = “RANGE”;

Using range partitioning.

pub const READ_COUNT: &str = “read_count”;

Count of times this table or view was read.

pub const READ_ONLY: &str = “read_only”;

Only read operations are allowed on this table.

pub const READ_WRITE: &str = “read_write”;

All read/write operations are allowed on this table.

pub const RECORD_BYTES: &str = “record_bytes”;

The number of in-memory bytes per record which is the sum of the byte sizes of all columns with property ‘data’.

pub const REFRESH_METHOD: &str = “refresh_method”;

For materialized view current refresh_method - one of manual, periodic, on_change.

pub const REFRESH_PERIOD: &str = “refresh_period”;

For materialized view with periodic refresh_method the current refresh period in seconds.

pub const REFRESH_START_TIME: &str = “refresh_start_time”;

For materialized view with periodic refresh_method the initial datetime string that periodic refreshes began.

pub const REFRESH_STOP_TIME: &str = “refresh_stop_time”;

Time at which the periodic view refresh stops.

pub const REMAINING_TABLE_TTL: &str = “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.

pub const REQUEST_AVRO_JSON: &str = “request_avro_json”;

The JSON representation of request creating this table.

pub const REQUEST_AVRO_TYPE: &str = “request_avro_type”;

Method by which this table was created.

pub const SCHEMA_NAME: &str = “schema_name”;

The name of the schema for the table. There can only be one schema for a table.

pub const SERIES: &str = “SERIES”;

Using series partitioning.

pub const TABLE_TTL: &str = “table_ttl”;

The value of the time-to-live setting. Not present for schemas.

pub const TOTAL_BYTES: &str = “total_bytes”;

The total size in bytes of all data stored in the table.

pub const TRUE: &str = “true”;
pub const USER_CHUNK_COLUMN_MAX_MEMORY: &str = “user_chunk_column_max_memory”;

User-specified target max bytes per column in a chunk, if provided at table creation time.

pub const USER_CHUNK_MAX_MEMORY: &str = “user_chunk_max_memory”;

User-specified target max bytes for all columns in a chunk, if provided at table creation time.

pub const USER_CHUNK_SIZE: &str = “user_chunk_size”;

User-specified number of records per chunk, if provided at table creation time.

pub const VIEW_TABLE_NAME: &str = “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.

pub const WRITE_COUNT: &str = “write_count”;

Count of times this table was written.

pub const WRITE_ONLY: &str = “write_only”;

Only write operations are allowed on this table.

table_descriptions

Constants for table_descriptions.

pub const COLLECTION: &str = “COLLECTION”;
pub const JOIN: &str = “JOIN”;
pub const LOGICAL_EXTERNAL_TABLE: &str = “LOGICAL_EXTERNAL_TABLE”;
pub const LOGICAL_VIEW: &str = “LOGICAL_VIEW”;
pub const MATERIALIZED_EXTERNAL_TABLE: &str = “MATERIALIZED_EXTERNAL_TABLE”;
pub const MATERIALIZED_VIEW: &str = “MATERIALIZED_VIEW”;
pub const MATERIALIZED_VIEW_MEMBER: &str = “MATERIALIZED_VIEW_MEMBER”;
pub const MATERIALIZED_VIEW_UNDER_CONSTRUCTION: &str = “MATERIALIZED_VIEW_UNDER_CONSTRUCTION”;
pub const REPLICATED: &str = “REPLICATED”;
pub const RESULT_TABLE: &str = “RESULT_TABLE”;
pub const SCHEMA: &str = “SCHEMA”;
pub const VIEW: &str = “VIEW”;