Additional information about the respective tables in <member name="table_names">. More...

Public Attributes
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	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	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 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...

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 462 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 479 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 534 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 if the get_column_info option is true.

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

◆ FALSE

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

Definition at line 481 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 522 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 528 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 578 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 582 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 497 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 586 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 594 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 502 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 515 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 508 of file ShowTable.cs.

◆ TRUE

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

Definition at line 480 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 590 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

◆ COLUMN_INFO

◆ COMPRESSED_COLUMNS

◆ FALSE

◆ FOREIGN_KEYS

◆ FOREIGN_SHARD_KEY

◆ GLOBAL_ACCESS_MODE

◆ NO_ACCESS

◆ PROTECTED

◆ READ_ONLY

◆ READ_WRITE

◆ RECORD_BYTES

◆ REMAINING_TABLE_TTL

◆ TABLE_TTL

◆ TRUE

◆ WRITE_ONLY