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	COMPRESSED_COLUMNS = "compressed_columns"
	No longer supported. 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 current intial 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 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	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...

Detailed Description

A set of string constants for the parameter additional_info.

Additional information about the respective tables in table_names.

Definition at line 503 of file ShowTable.cs.

Member Data Documentation

◆ ALTERNATE_SHARD_KEYS

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 863 of file ShowTable.cs.

◆ ATTRIBUTE_INDEXES

const string kinetica.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 727 of file ShowTable.cs.

◆ COLLECTION_NAMES

const string kinetica.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 564 of file ShowTable.cs.

◆ COLUMN_INFO

const string kinetica.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 739 of file ShowTable.cs.

◆ COMPRESSED_COLUMNS

const string kinetica.ShowTableResponse.AdditionalInfo.COMPRESSED_COLUMNS = "compressed_columns"

No longer supported.

The default value is ''.

Definition at line 731 of file ShowTable.cs.

◆ CREATE_PROJECTION

const string kinetica.ShowTableResponse.AdditionalInfo.CREATE_PROJECTION = "create_projection"

Definition at line 527 of file ShowTable.cs.

◆ CREATE_TABLE

const string kinetica.ShowTableResponse.AdditionalInfo.CREATE_TABLE = "create_table"

Definition at line 526 of file ShowTable.cs.

◆ CREATE_UNION

const string kinetica.ShowTableResponse.AdditionalInfo.CREATE_UNION = "create_union"

Definition at line 528 of file ShowTable.cs.

◆ DATASOURCE_SUBSCRIPTIONS

const string kinetica.ShowTableResponse.AdditionalInfo.DATASOURCE_SUBSCRIPTIONS = "datasource_subscriptions"

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

The default value is ''.

Definition at line 868 of file ShowTable.cs.

◆ DISK

const string kinetica.ShowTableResponse.AdditionalInfo.DISK = "disk"

On-disk primary key

Definition at line 604 of file ShowTable.cs.

◆ FALSE

const string kinetica.ShowTableResponse.AdditionalInfo.FALSE = "false"

Definition at line 549 of file ShowTable.cs.

◆ FOREIGN_KEYS

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 schemas. The default value is ''.

Definition at line 612 of file ShowTable.cs.

◆ FOREIGN_SHARD_KEY

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 schemas. The default value is ''.

Definition at line 619 of file ShowTable.cs.

◆ GLOBAL_ACCESS_MODE

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:

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 772 of file ShowTable.cs.

◆ HASH

const string kinetica.ShowTableResponse.AdditionalInfo.HASH = "HASH"

Using hash partitioning.

Definition at line 690 of file ShowTable.cs.

◆ INTERVAL

const string kinetica.ShowTableResponse.AdditionalInfo.INTERVAL = "INTERVAL"

Using interval partitioning

Definition at line 680 of file ShowTable.cs.

◆ IS_AUTOMATIC_PARTITION

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 715 of file ShowTable.cs.

◆ IS_DIRTY

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 807 of file ShowTable.cs.

◆ IS_VIEW_PERSISTED

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 801 of file ShowTable.cs.

◆ LAST_REFRESH_TIME

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 833 of file ShowTable.cs.

◆ LIST

const string kinetica.ShowTableResponse.AdditionalInfo.LIST = "LIST"

Using manual list partitioning

Definition at line 685 of file ShowTable.cs.

◆ MEMORY

const string kinetica.ShowTableResponse.AdditionalInfo.MEMORY = "memory"

In-memory primary key

Definition at line 601 of file ShowTable.cs.

◆ NEXT_REFRESH_TIME

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 839 of file ShowTable.cs.

◆ NO_ACCESS

const string kinetica.ShowTableResponse.AdditionalInfo.NO_ACCESS = "no_access"

No read/write operations are allowed on this table.

Definition at line 776 of file ShowTable.cs.

◆ NONE

const string kinetica.ShowTableResponse.AdditionalInfo.NONE = "NONE"

Using no partitioning

Definition at line 698 of file ShowTable.cs.

◆ NULL_MODIFYING_COLUMNS

const string kinetica.ShowTableResponse.AdditionalInfo.NULL_MODIFYING_COLUMNS = "null_modifying_columns"

Comma-separated list of null modifying column names.

The default value is ''.

Definition at line 873 of file ShowTable.cs.

◆ OWNER_RESOURCE_GROUP

const string kinetica.ShowTableResponse.AdditionalInfo.OWNER_RESOURCE_GROUP = "owner_resource_group"

Name of the owner resource group.

The default value is ''.

Definition at line 858 of file ShowTable.cs.

◆ PARTITION_DEFINITIONS

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 710 of file ShowTable.cs.

◆ PARTITION_KEYS

const string kinetica.ShowTableResponse.AdditionalInfo.PARTITION_KEYS = "partition_keys"

Comma-separated list of partition keys.

The default value is ''.

Definition at line 702 of file ShowTable.cs.

◆ PARTITION_TYPE

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 670 of file ShowTable.cs.

◆ PRIMARY_KEY_TYPE

const string kinetica.ShowTableResponse.AdditionalInfo.PRIMARY_KEY_TYPE = "primary_key_type"

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

Supported values:

MEMORY: In-memory primary key
DISK: On-disk primary key

Definition at line 598 of file ShowTable.cs.

◆ PROTECTED

const string kinetica.ShowTableResponse.AdditionalInfo.PROTECTED = "protected"

No longer used.

Supported values:

TRUE
FALSE

Definition at line 546 of file ShowTable.cs.

◆ RANGE

const string kinetica.ShowTableResponse.AdditionalInfo.RANGE = "RANGE"

Using range partitioning

Definition at line 675 of file ShowTable.cs.

◆ READ_ONLY

const string kinetica.ShowTableResponse.AdditionalInfo.READ_ONLY = "read_only"

Only read operations are allowed on this table.

Definition at line 780 of file ShowTable.cs.

◆ READ_WRITE

const string kinetica.ShowTableResponse.AdditionalInfo.READ_WRITE = "read_write"

All read/write operations are allowed on this table.

Definition at line 788 of file ShowTable.cs.

◆ RECORD_BYTES

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 554 of file ShowTable.cs.

◆ REFRESH_METHOD

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 812 of file ShowTable.cs.

◆ REFRESH_PERIOD

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 828 of file ShowTable.cs.

◆ REFRESH_START_TIME

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 818 of file ShowTable.cs.

◆ REFRESH_STOP_TIME

const string kinetica.ShowTableResponse.AdditionalInfo.REFRESH_STOP_TIME = "refresh_stop_time"

Time at which the periodic view refresh stops.

The default value is ''.

Definition at line 823 of file ShowTable.cs.

◆ REMAINING_TABLE_TTL

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 schemas.

Definition at line 581 of file ShowTable.cs.

◆ REQUEST_AVRO_JSON

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 533 of file ShowTable.cs.

◆ REQUEST_AVRO_TYPE

const string kinetica.ShowTableResponse.AdditionalInfo.REQUEST_AVRO_TYPE = "request_avro_type"

Method by which this table was created.

Supported values:

Definition at line 524 of file ShowTable.cs.

◆ SCHEMA_NAME

const string kinetica.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 569 of file ShowTable.cs.

◆ SERIES

const string kinetica.ShowTableResponse.AdditionalInfo.SERIES = "SERIES"

Using series partitioning.

Definition at line 695 of file ShowTable.cs.

◆ TABLE_TTL

const string kinetica.ShowTableResponse.AdditionalInfo.TABLE_TTL = "table_ttl"

The value of the time-to-live setting.

Not present for schemas.

Definition at line 574 of file ShowTable.cs.

◆ TOTAL_BYTES

const string kinetica.ShowTableResponse.AdditionalInfo.TOTAL_BYTES = "total_bytes"

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

Definition at line 558 of file ShowTable.cs.

◆ TRUE

const string kinetica.ShowTableResponse.AdditionalInfo.TRUE = "true"

Definition at line 548 of file ShowTable.cs.

◆ USER_CHUNK_COLUMN_MAX_MEMORY

const string kinetica.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 849 of file ShowTable.cs.

◆ USER_CHUNK_MAX_MEMORY

const string kinetica.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 854 of file ShowTable.cs.

◆ USER_CHUNK_SIZE

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 844 of file ShowTable.cs.

◆ VIEW_TABLE_NAME

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 794 of file ShowTable.cs.

◆ WRITE_ONLY

const string kinetica.ShowTableResponse.AdditionalInfo.WRITE_ONLY = "write_only"

Only write operations are allowed on this table.

Definition at line 784 of file ShowTable.cs.

The documentation for this struct was generated from the following file:

Kinetica/Protocol/ShowTable.cs

Public Attributes

Detailed Description

Member Data Documentation

◆ ALTERNATE_SHARD_KEYS

◆ ATTRIBUTE_INDEXES

◆ COLLECTION_NAMES

◆ COLUMN_INFO

◆ COMPRESSED_COLUMNS

◆ CREATE_PROJECTION

◆ CREATE_TABLE

◆ CREATE_UNION

◆ DATASOURCE_SUBSCRIPTIONS

◆ DISK

◆ FALSE

◆ FOREIGN_KEYS

◆ FOREIGN_SHARD_KEY

◆ GLOBAL_ACCESS_MODE

◆ HASH

◆ INTERVAL

◆ IS_AUTOMATIC_PARTITION

◆ IS_DIRTY

◆ IS_VIEW_PERSISTED

◆ LAST_REFRESH_TIME

◆ LIST

◆ MEMORY

◆ NEXT_REFRESH_TIME

◆ NO_ACCESS

◆ NONE

◆ NULL_MODIFYING_COLUMNS

◆ OWNER_RESOURCE_GROUP

◆ PARTITION_DEFINITIONS

◆ PARTITION_KEYS

◆ PARTITION_TYPE

◆ PRIMARY_KEY_TYPE

◆ PROTECTED

◆ RANGE

◆ READ_ONLY

◆ READ_WRITE

◆ RECORD_BYTES

◆ REFRESH_METHOD

◆ REFRESH_PERIOD

◆ REFRESH_START_TIME

◆ REFRESH_STOP_TIME

◆ REMAINING_TABLE_TTL

◆ REQUEST_AVRO_JSON

◆ REQUEST_AVRO_TYPE

◆ SCHEMA_NAME

◆ SERIES

◆ TABLE_TTL

◆ TOTAL_BYTES

◆ TRUE

◆ USER_CHUNK_COLUMN_MAX_MEMORY

◆ USER_CHUNK_MAX_MEMORY

◆ USER_CHUNK_SIZE

◆ VIEW_TABLE_NAME

◆ WRITE_ONLY