Skip to main content
interface ShowTableResponse
additional_info: Record<string, string>[];
full_sizes: number[];
info: Record<string, string>;
join_sizes: number[];
properties: Record<string, string[]>[];
request_time_secs?: number;
sizes: number[];
table_descriptions: string[][];
table_name: string;
table_names: string[];
total_full_size: number;
total_size: number;
type_ids: string[];
type_labels: string[];
type_schemas: string[];
additional_info full_sizes info join_sizes properties request_time_secs? sizes table_descriptions table_name table_names total_full_size total_size type_ids type_labels type_schemas
additional_info: Record<string, string>[]

Additional information about the respective tables in table_names.

full_sizes: number[]

If get_sizes is true, an array containing the number of records of each corresponding table in table_names (same values as sizes). Otherwise, an empty array.

info: Record<string, string>

Additional information.

join_sizes: number[]

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 table_names. For simple tables, this number will be the same as 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.

properties: Record<string, string[]>[]

Property maps of the respective tables in table_names.

request_time_secs?: number

Server-reported request time in seconds, when it sent one

sizes: number[]

If get_sizes is true, an array containing the number of records of each corresponding table in table_names. Otherwise, an empty array.

table_descriptions: string[][]

List of descriptions for the respective tables in table_names.

table_name: string

Value of table_name.

table_names: string[]

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.

total_full_size: number

If get_sizes is true, the sum of the elements of full_sizes (same value as total_size). Otherwise, -1.

total_size: number

If get_sizes is true, the sum of the elements of sizes. Otherwise, -1.

type_ids: string[]

Type IDs of the respective tables in table_names.

type_labels: string[]

Type labels of the respective tables in table_names.

type_schemas: string[]

Type schemas of the respective tables in table_names.