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	ALLOW_HOMOGENEOUS_TABLES = "allow_homogeneous_tables"
	Only present if the respective table is a collection. More...

const string	TRUE = "true"

const string	FALSE = "false"

const string	PROTECTED = "protected"
	Indicates whether the respective table is protected or not. More...

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	MEMORY_TTL = "memory_ttl"
	The value of the time-to-live in minutes for unqueried column data to stay in memory. 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	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 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"
	If this entity is a member of a materialized view, the name of that view. More...

const string	IS_VIEW_PERSISTED = "is_view_persisted"
	If this entity is a member of a materialized view, whether that view is persisted. More...

const string	IS_DIRTY = "is_dirty"
	If this entity is a member of a materialized view, whether 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"
	If this entity is a member of a materialized view, the current refresh method of that view. More...

const string	MANUAL = "manual"

const string	PERIODIC = "periodic"

const string	ON_CHANGE = "on_change"

const string	REFRESH_START_TIME = "refresh_start_time"
	If this entity is a member of a materialized view with a periodic refresh method, the current initial date/time that the view's periodic refreshes began More...

const string	REFRESH_PERIOD = "refresh_period"
	If this entity is a member of a materialized view with a periodic refresh method, the current refresh period of that view in seconds. More...

const string	LAST_REFRESH_TIME = "last_refresh_time"
	If this entity is a member of a materialized view, the last date/time that view was refreshed. More...

const string	NEXT_REFRESH_TIME = "next_refresh_time"
	If this entity is a member of a materialized view with a periodic refresh method, the next date/time that view is to be refreshed. More...

Detailed Description

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

Member Data Documentation

◆ ALLOW_HOMOGENEOUS_TABLES

const string kinetica.ShowTableResponse.AdditionalInfo.ALLOW_HOMOGENEOUS_TABLES = "allow_homogeneous_tables"

Only present if the respective table is a collection.

The value indicates whether the collection is allowed to contain multiple tables or views of the same type or not. Supported values:

TRUE
FALSE

Definition at line 586 of file ShowTable.cs.

◆ ATTRIBUTE_INDEXES

const string kinetica.ShowTableResponse.AdditionalInfo.ATTRIBUTE_INDEXES = "attribute_indexes"

Semicolon-separated list of columns that have indexes.

Not present for collections.

Definition at line 648 of file ShowTable.cs.

◆ COLLECTION_NAMES

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

Definition at line 661 of file ShowTable.cs.

◆ COMPRESSED_COLUMNS

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.

Definition at line 656 of file ShowTable.cs.

◆ CREATE_PROJECTION

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

Definition at line 565 of file ShowTable.cs.

◆ CREATE_TABLE

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

Definition at line 564 of file ShowTable.cs.

◆ CREATE_UNION

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

Definition at line 566 of file ShowTable.cs.

◆ FALSE

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

Definition at line 588 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 collections.

Definition at line 636 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 collections.

Definition at line 642 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 692 of file ShowTable.cs.

◆ IS_DIRTY

const string kinetica.ShowTableResponse.AdditionalInfo.IS_DIRTY = "is_dirty"

If this entity is a member of a materialized view, whether some input table of the materialized view that affects this member table has been modified since the last refresh.

Supported values:

TRUE
FALSE

Definition at line 745 of file ShowTable.cs.

◆ IS_VIEW_PERSISTED

const string kinetica.ShowTableResponse.AdditionalInfo.IS_VIEW_PERSISTED = "is_view_persisted"

If this entity is a member of a materialized view, whether that view is persisted.

If true, signifies that the method of recreating this member is saved, but not its data. Supported values:

TRUE
FALSE

Definition at line 729 of file ShowTable.cs.

◆ LAST_REFRESH_TIME

const string kinetica.ShowTableResponse.AdditionalInfo.LAST_REFRESH_TIME = "last_refresh_time"

If this entity is a member of a materialized view, the last date/time that view was refreshed.

Definition at line 781 of file ShowTable.cs.

◆ MANUAL

const string kinetica.ShowTableResponse.AdditionalInfo.MANUAL = "manual"

Definition at line 765 of file ShowTable.cs.

◆ MEMORY_TTL

const string kinetica.ShowTableResponse.AdditionalInfo.MEMORY_TTL = "memory_ttl"

The value of the time-to-live in minutes for unqueried column data to stay in memory.

Not present for collections or if not set for this table.

Definition at line 629 of file ShowTable.cs.

◆ NEXT_REFRESH_TIME

const string kinetica.ShowTableResponse.AdditionalInfo.NEXT_REFRESH_TIME = "next_refresh_time"

If this entity is a member of a materialized view with a periodic refresh method, the next date/time that view is to be refreshed.

Definition at line 786 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 696 of file ShowTable.cs.

◆ ON_CHANGE

const string kinetica.ShowTableResponse.AdditionalInfo.ON_CHANGE = "on_change"

Definition at line 767 of file ShowTable.cs.

◆ PERIODIC

const string kinetica.ShowTableResponse.AdditionalInfo.PERIODIC = "periodic"

Definition at line 766 of file ShowTable.cs.

◆ PROTECTED

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

Indicates whether the respective table is protected or not.

Supported values:

TRUE
FALSE

Definition at line 604 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 700 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 708 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 609 of file ShowTable.cs.

◆ REFRESH_METHOD

const string kinetica.ShowTableResponse.AdditionalInfo.REFRESH_METHOD = "refresh_method"

If this entity is a member of a materialized view, the current refresh method of that view.

Supported values:

Definition at line 764 of file ShowTable.cs.

◆ REFRESH_PERIOD

const string kinetica.ShowTableResponse.AdditionalInfo.REFRESH_PERIOD = "refresh_period"

If this entity is a member of a materialized view with a periodic refresh method, the current refresh period of that view in seconds.

Definition at line 777 of file ShowTable.cs.

◆ REFRESH_START_TIME

const string kinetica.ShowTableResponse.AdditionalInfo.REFRESH_START_TIME = "refresh_start_time"

If this entity is a member of a materialized view with a periodic refresh method, the current initial date/time that the view's periodic refreshes began

Definition at line 772 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 collections.

Definition at line 624 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.

Definition at line 570 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 563 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 collections.

Definition at line 618 of file ShowTable.cs.

◆ TRUE

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

Definition at line 587 of file ShowTable.cs.

◆ VIEW_TABLE_NAME

const string kinetica.ShowTableResponse.AdditionalInfo.VIEW_TABLE_NAME = "view_table_name"

If this entity is a member of a materialized view, the name of that view.

If this name is the same as the view's name, then this is the root of the view.

Definition at line 713 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 704 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

◆ ALLOW_HOMOGENEOUS_TABLES

◆ ATTRIBUTE_INDEXES

◆ COLLECTION_NAMES

◆ COLUMN_INFO

◆ COMPRESSED_COLUMNS

◆ CREATE_PROJECTION

◆ CREATE_TABLE

◆ CREATE_UNION

◆ FALSE

◆ FOREIGN_KEYS

◆ FOREIGN_SHARD_KEY

◆ GLOBAL_ACCESS_MODE

◆ IS_DIRTY

◆ IS_VIEW_PERSISTED

◆ LAST_REFRESH_TIME

◆ MANUAL

◆ MEMORY_TTL

◆ NEXT_REFRESH_TIME

◆ NO_ACCESS

◆ ON_CHANGE

◆ PERIODIC

◆ PROTECTED

◆ READ_ONLY

◆ READ_WRITE

◆ RECORD_BYTES

◆ REFRESH_METHOD

◆ REFRESH_PERIOD

◆ REFRESH_START_TIME

◆ REMAINING_TABLE_TTL

◆ REQUEST_AVRO_JSON

◆ REQUEST_AVRO_TYPE

◆ TABLE_TTL

◆ TRUE

◆ VIEW_TABLE_NAME

◆ WRITE_ONLY