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.).
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.
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.The default value is false.The supported values are:
If true then the number of records in each table, along with a cumulative count, will be returned; blank, otherwise.The default value is false.The supported values are:
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.The default value is false.The supported values are:
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.The default value is false.The supported values are:
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.The default value is true.The supported values are:
The Kinetica server embeds the endpoint response inside a standard response structure which contains status information and the actual response to the query. Here is a description of the various fields of the wrapper:
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.
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 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 ”.
Comma-separated list of partition definitions, whose format depends on the partition_type. See partitioning documentation for details.The default value is ”.
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 ”.
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 ”.
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 ”.
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 ”.
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.
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.
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.
