Skip to main content

A set of results returned by Kinetica.showTable. More…

Inheritance diagram for kinetica.ShowTableResponse:
[legend]
Collaboration diagram for kinetica.ShowTableResponse:
[legend]

​
Classes

struct  AdditionalInfo
 A set of string constants for the parameter ShowTableResponse.additional_info. More…
 
struct  TableDescriptions
 A set of string constants for the parameter ShowTableResponse.table_descriptions. More…
 

​
Properties

string table_name [get, set]
 Value of table_name.
 
IList< string > table_names = new List<string>() [get, set]
 If table_name is a table or view, then the single element of the array is table_name.
 
IList< IList< string > > table_descriptions = new List<IList<string>>() [get, set]
 List of descriptions for the respective tables in ShowTableResponse.table_names.
 
IList< string > type_ids = new List<string>() [get, set]
 Type IDs of the respective tables in ShowTableResponse.table_names.
 
IList< string > type_schemas = new List<string>() [get, set]
 Type schemas of the respective tables in ShowTableResponse.table_names.
 
IList< string > type_labels = new List<string>() [get, set]
 Type labels of the respective tables in ShowTableResponse.table_names.
 
IList< IDictionary< string, IList< string > > > properties = new List<IDictionary<string, IList<string>>>() [get, set]
 Property maps of the respective tables in ShowTableResponse.table_names.
 
IList< IDictionary< string, string > > additional_info = new List<IDictionary<string, string>>() [get, set]
 Additional information about the respective tables in ShowTableResponse.table_names.
 
IList< long > sizes = new List<long>() [get, set]
 If GET_SIZES is TRUE, an array containing the number of records of each corresponding table in ShowTableResponse.table_names.
 
IList< long > full_sizes = new List<long>() [get, set]
 If GET_SIZES is TRUE, an array containing the number of records of each corresponding table in ShowTableResponse.table_names (same values as ShowTableResponse.sizes).
 
IList< double > join_sizes = new List<double>() [get, set]
 If GET_SIZES is TRUE, an array containing the number of unfiltered records in the cross product of the sub-tables of each corresponding join-table in ShowTableResponse.table_names.
 
long total_size [get, set]
 If GET_SIZES is TRUE, the sum of the elements of ShowTableResponse.sizes.
 
long total_full_size [get, set]
 If GET_SIZES is TRUE, the sum of the elements of ShowTableResponse.full_sizes (same value as ShowTableResponse.total_size).
 
IDictionary< string, string > info = new Dictionary<string, string>() [get, set]
 Additional information.
 
 Properties inherited from kinetica.KineticaData
Schema Schema [get]
 Avro Schema for this class.
 

​
Additional Inherited Members

 Public Member Functions inherited from kinetica.KineticaData
 KineticaData (KineticaType type)
 Constructor from Kinetica Type.
 
 KineticaData (System.Type type=null)
 Default constructor, with optional System.Type.
 
object Get (int fieldPos)
 Retrieve a specific property from this object.
 
void Put (int fieldPos, object fieldValue)
 Write a specific property to this object.
 
 KineticaData (KineticaType type)
 Constructor from Kinetica Type.
 
 KineticaData (System.Type type=null)
 Default constructor, with optional System.Type.
 
object Get (int fieldPos)
 Retrieve a specific property from this object.
 
void Put (int fieldPos, object fieldValue)
 Write a specific property to this object.
 
 Static Public Member Functions inherited from kinetica.KineticaData
static ? RecordSchema SchemaFromType (System.Type t, KineticaType? ktype=null)
 Create an Avro Schema from a System.Type and a KineticaType.
 
static ? RecordSchema SchemaFromType (System.Type t, KineticaType? ktype=null)
 Create an Avro Schema from a System.Type and a KineticaType.
 

​
Detailed Description

A set of results returned by Kinetica.showTable.

Definition at line 843 of file ShowTable.cs.

​
Property Documentation

​
◆ additional_info

IList< IDictionary< string, string > > kinetica.ShowTableResponse.additional_info = new List<IDictionary<string, string>>()
 getset

Additional information about the respective tables in ShowTableResponse.table_names.

  • REQUEST_AVRO_TYPE: Method by which this table was created. Supported values:
  • REQUEST_AVRO_JSON: The JSON representation of request creating this table. The default value is ”.
  • PROTECTED: No longer used. Indicated whether the respective table was protected or not. Supported values:
  • RECORD_BYTES: The number of in-memory bytes per record which is the sum of the byte sizes of all columns with property ‘data’.
  • TOTAL_BYTES: The total size in bytes of all data stored in the table.
  • 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.
  • SCHEMA_NAME: The name of the schema for the table. There can only be one schema for a table.
  • TABLE_TTL: The value of the time-to-live setting. Not present for schemas.
  • 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.
  • 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.
  • 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 ”.
  • 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 ”.
  • PARTITION_TYPE: Partitioning scheme used for this table. Supported values:The default value is NONE.
  • PARTITION_KEYS: Comma-separated list of partition keys. The default value is ”.
  • PARTITION_DEFINITIONS: Comma-separated list of partition definitions, whose format depends on the partition_type. See partitioning documentation for details. The default value is ”.
  • IS_AUTOMATIC_PARTITION: True if partitions will be created for LIST VALUES which don’t fall into existing partitions. The default value is ”.
  • 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>&lt;column_list>&lt;column_options>. Not present for schemas. The default value is ”.
  • 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 ”.
  • 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.
  • 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 ”.
  • 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 ”.
  • 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 ”.
  • REFRESH_METHOD: For materialized view current refresh_method - one of manual, periodic, on_change. The default value is ”.
  • REFRESH_START_TIME: For materialized view with periodic refresh_method the initial datetime string that periodic refreshes began. The default value is ”.
  • REFRESH_STOP_TIME: Time at which the periodic view refresh stops. The default value is ”.
  • REFRESH_PERIOD: For materialized view with periodic refresh_method the current refresh period in seconds. The default value is ”.
  • LAST_REFRESH_TIME: For materialized view the datetime string indicating the last time the view was refreshed. The default value is ”.
  • 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 ”.
  • USER_CHUNK_SIZE: User-specified number of records per chunk, if provided at table creation time. The default value is ”.
  • 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 ”.
  • 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 ”.
  • OWNER_RESOURCE_GROUP: Name of the owner resource group. The default value is ”.
  • ALTERNATE_SHARD_KEYS: Semicolon-separated list of shard keys that were equated in joins (applicable for join tables). The default value is ”.
  • DATASOURCE_SUBSCRIPTIONS: Semicolon-separated list of datasource names the table has subscribed to. The default value is ”.
  • NULL_MODIFYING_COLUMNS: Comma-separated list of null modifying column names. The default value is ”.
  • COMPRESSION_CODEC: Default compression codec for the table. The default value is ”.
  • CREATED_BY: User that created this table or view. The default value is ”.
  • CREATED_TIME: Time (UTC) when this table or view was created. The default value is ”.
  • LAST_READ_BY: User that last read this table or view. The default value is ”.
  • LAST_READ_TIME: Time (UTC) when this table or view was last read. The default value is ”.
  • READ_COUNT: Count of times this table or view was read. The default value is ”.
  • LAST_WRITE_BY: User that last wrote to this table. The default value is ”.
  • LAST_WRITE_TIME: Time (UTC) when this table was last written. The default value is ”.
  • WRITE_COUNT: Count of times this table was written. The default value is ”.
  • LAST_ALTER_BY: User that last altered this table or view. The default value is ”.
  • LAST_ALTER_TIME: Time (UTC) when this table or view was last altered. The default value is ”.
  • ALTER_COUNT: Count of times this table or view was altered. The default value is ”.

Definition at line 1948 of file ShowTable.cs.

​
◆ full_sizes

IList< long > kinetica.ShowTableResponse.full_sizes = new List<long>()
 getset

If GET_SIZES is TRUE, an array containing the number of records of each corresponding table in ShowTableResponse.table_names (same values as ShowTableResponse.sizes).

Otherwise, an empty array.

Definition at line 1965 of file ShowTable.cs.

​
◆ info

IDictionary< string, string > kinetica.ShowTableResponse.info = new Dictionary<string, string>()
 getset

Additional information.

Definition at line 1998 of file ShowTable.cs.

​
◆ join_sizes

IList< double > kinetica.ShowTableResponse.join_sizes = new List<double>()
 getset

If GET_SIZES is TRUE, an array containing the number of unfiltered records in the cross product of the sub-tables of each corresponding join-table in ShowTableResponse.table_names.

For simple tables, this number will be the same as ShowTableResponse.sizes. For join-tables, this value gives the number of joined-table rows that must be processed by any aggregate functions operating on the table. Otherwise, (if GET_SIZES is FALSE), an empty array.

Definition at line 1980 of file ShowTable.cs.

​
◆ properties

IList< IDictionary< string, IList< string > > > kinetica.ShowTableResponse.properties = new List<IDictionary<string, IList<string>>>()
 getset

Property maps of the respective tables in ShowTableResponse.table_names.

Definition at line 1446 of file ShowTable.cs.

​
◆ sizes

IList< long > kinetica.ShowTableResponse.sizes = new List<long>()
 getset

If GET_SIZES is TRUE, an array containing the number of records of each corresponding table in ShowTableResponse.table_names.

Otherwise, an empty array.

Definition at line 1956 of file ShowTable.cs.

​
◆ table_descriptions

IList< IList< string > > kinetica.ShowTableResponse.table_descriptions = new List<IList<string>>()
 getset

List of descriptions for the respective tables in ShowTableResponse.table_names.

Supported values:

Definition at line 1430 of file ShowTable.cs.

​
◆ table_name

string kinetica.ShowTableResponse.table_name
 getset

Value of table_name.

Definition at line 1346 of file ShowTable.cs.

​
◆ table_names

IList< string > kinetica.ShowTableResponse.table_names = new List<string>()
 getset

If table_name is a table or view, then the single element of the array is table_name.

If table_name is a schema and SHOW_CHILDREN is set to TRUE, then this array is populated with the names of all tables and views in the given schema; if SHOW_CHILDREN is FALSE, then this array will only include the schema name itself. If table_name is an empty string, then the array contains the names of all tables in the user’s default schema.

Definition at line 1363 of file ShowTable.cs.

​
◆ total_full_size

long kinetica.ShowTableResponse.total_full_size
 getset

If GET_SIZES is TRUE, the sum of the elements of ShowTableResponse.full_sizes (same value as ShowTableResponse.total_size).

Otherwise, -1.

Definition at line 1995 of file ShowTable.cs.

​
◆ total_size

long kinetica.ShowTableResponse.total_size
 getset

If GET_SIZES is TRUE, the sum of the elements of ShowTableResponse.sizes.

Otherwise, -1.

Definition at line 1987 of file ShowTable.cs.

​
◆ type_ids

IList< string > kinetica.ShowTableResponse.type_ids = new List<string>()
 getset

Type IDs of the respective tables in ShowTableResponse.table_names.

Definition at line 1434 of file ShowTable.cs.

​
◆ type_labels

IList< string > kinetica.ShowTableResponse.type_labels = new List<string>()
 getset

Type labels of the respective tables in ShowTableResponse.table_names.

Definition at line 1442 of file ShowTable.cs.

​
◆ type_schemas

IList< string > kinetica.ShowTableResponse.type_schemas = new List<string>()
 getset

Type schemas of the respective tables in ShowTableResponse.table_names.

Definition at line 1438 of file ShowTable.cs.

The documentation for this class 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