> ## Documentation Index > Fetch the complete documentation index at: https://docs.kinetica.com/llms.txt > Use this file to discover all available pages before exploring further. # show_table
show\_table(table\_name=None, options={"{"}{"}"})\[source]

Retrieves detailed information about a table, view, or schema, specified in input parameter table\_name. If the supplied input parameter table\_name is a schema the call can return information about either the schema itself or the tables and views it contains. If input parameter table\_name is empty, information about all schemas will be returned.

If the option get\_sizes is set to true, then the number of records in each table is returned (in output parameter sizes and output parameter full\_sizes), along with the total number of objects across all requested tables (in output parameter total\_size and output parameter total\_full\_size).

For a schema, setting the show\_children option to false returns only information about the schema itself; setting show\_children to true returns a list of tables and views contained in the schema, along with their corresponding detail.

To retrieve a list of every table, view, and schema in the database, set input parameter table\_name to ‘\*’ and show\_children to true. When doing this, the returned output parameter total\_size and output parameter total\_full\_size will not include the sizes of non-base tables (e.g., filters, views, joins, etc.).

Parameters

table\_name (str) –

Name of the table for which to retrieve the information, in \[schema\_name.]table\_name format, using standard name resolution rules. If blank, then returns information about all tables and views.

options (dict of str to str) –

Optional parameters. Allowed keys are:

  • dependencies – Include view dependencies in the output. Allowed values are:

    • true

    • false

    The default value is ‘false’.

  • force\_synchronous – If true then the table sizes will wait for read lock before returning. Allowed values are:

    • true

    • false

    The default value is ‘true’.

  • get\_access\_data – If true then data about the last read, write, alter and create will be returned. Allowed values are:

    • true

    • false

    The default value is ‘false’.

  • get\_cached\_sizes – If true then the number of records in each table, along with a cumulative count, will be returned; blank, otherwise. This version will return the sizes cached at rank 0, which may be stale if there is a multihead insert occurring. Allowed values are:

    • true

    • false

    The default value is ‘false’.

  • get\_sizes – If true then the number of records in each table, along with a cumulative count, will be returned; blank, otherwise. Allowed values are:

    • true

    • false

    The default value is ‘false’.

  • referencing\_materialized\_views – Include materialized views using this table as a source in the output. Allowed values are:

    • true

    • false

    The default value is ‘false’.

  • skip\_additional\_info – If true then the response will not populate the additional\_info field. Allowed values are:

    • true

    • false

    The default value is ‘false’.

  • no\_error\_if\_not\_exists – If false will return an error if the provided input parameter table\_name does not exist. If true then it will return an empty result. Allowed values are:

    • true

    • false

    The default value is ‘false’.

  • skip\_temp\_schemas – If true then the table list will not include tables from SYS\_TEMP and other system temporary schemas. This is the default behavior for non-admin users. Allowed values are:

    • true

    • false

    The default value is ‘false’.

  • show\_children – If input parameter table\_name is a schema, then true will return information about the tables and views in the schema, and false will return information about the schema itself. If input parameter table\_name is a table or view, show\_children must be false. If input parameter table\_name is empty, then show\_children must be true. Allowed values are:

    • true

    • false

    The default value is ‘true’.

  • get\_column\_info – If true then column info (memory usage, etc) will be returned. Allowed values are:

    • true

    • false

    The default value is ‘false’.

The default value is an empty dict ( {"{"}{"}"} ).

Returns

A dict with the following entries–

table\_name (str) –

Value of input parameter table\_name.

table\_names (list of str) –

If input parameter table\_name is a table or view, then the single element of the array is input parameter table\_name. If input parameter 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 input parameter table\_name is an empty string, then the array contains the names of all tables in the user’s default schema.

table\_descriptions (list of lists of str) –

List of descriptions for the respective tables in output parameter table\_names. Allowed values are:

  • COLLECTION

  • JOIN

  • LOGICAL\_EXTERNAL\_TABLE

  • LOGICAL\_VIEW

  • MATERIALIZED\_EXTERNAL\_TABLE

  • MATERIALIZED\_VIEW

  • MATERIALIZED\_VIEW\_MEMBER

  • MATERIALIZED\_VIEW\_UNDER\_CONSTRUCTION

  • REPLICATED

  • RESULT\_TABLE

  • SCHEMA

  • VIEW

type\_ids (list of str) –

Type IDs of the respective tables in output parameter table\_names.

type\_schemas (list of str) –

Type schemas of the respective tables in output parameter table\_names.

type\_labels (list of str) –

Type labels of the respective tables in output parameter table\_names.

properties (list of dicts of str to lists of str) –

Property maps of the respective tables in output parameter table\_names.

additional\_info (list of dicts of str to str) –

Additional information about the respective tables in output parameter table\_names. Allowed keys are:

  • request\_avro\_type – Method by which this table was created. Allowed values are:

    • create\_table

    • create\_projection

    • create\_union

  • 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. Allowed values are:

    • true

    • false

  • 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). Allowed values are:

    • 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: \ references \ from \(\). Not present for schemas. The default value is ‘’.

  • partition\_type – Partitioning scheme used for this table. Allowed values are:

    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: \@\@\. 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. Allowed values are:

    • 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 ‘’.

sizes (list of longs) –

If get\_sizes is true, an array containing the number of records of each corresponding table in output parameter table\_names. Otherwise, an empty array.

full\_sizes (list of longs) –

If get\_sizes is true, an array containing the number of records of each corresponding table in output parameter table\_names (same values as output parameter sizes). Otherwise, an empty array.

join\_sizes (list of floats) –

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 output parameter table\_names. For simple tables, this number will be the same as output parameter 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.

total\_size (long) –

If get\_sizes is true, the sum of the elements of output parameter sizes. Otherwise, -1.

total\_full\_size (long) –

If get\_sizes is true, the sum of the elements of output parameter full\_sizes (same value as output parameter total\_size). Otherwise, -1.

info (dict of str to str) –

Additional information.