show_table
- show_table(
table_name: string,
options?: Record<string, string>,
callback?: GPUdbCallback,
): Promise<ShowTableResponse>Parameters
- table_name: string
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.
Optionaloptions: Record<string, string>Optional parameters.
Optionalcallback: GPUdbCallbackOptional callback function
Returns Promise<ShowTableResponse>
Promise<Types.ShowTableResponse> - Promise resolving to the response
- Defined in src/GPUdb.ts:14010
- table_name: string
show_table_request
- show_table_request(
request: ShowTableRequest,
callback?: GPUdbCallback,
): Promise<ShowTableResponse>Retrieves detailed information about a table, view, or schema, specified in
table_name. If the suppliedtable_nameis a schema the call can return information about either the schema itself or the tables and views it contains. Iftable_nameis 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
sizesandfull_sizes), along with the total number of objects across all requested tables (intotal_sizeandtotal_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
table_nameto ’*’ and show_children to true. When doing this, the returnedtotal_sizeandtotal_full_sizewill not include the sizes of non-base tables (e.g., filters, views, joins, etc.).Parameters
- request: ShowTableRequest
Request object containing the parameters for the operation
Optionalcallback: GPUdbCallbackOptional callback function
Returns Promise<ShowTableResponse>
Promise<Types.ShowTableResponse> - Promise resolving to the response
- Defined in src/GPUdb.ts:13968
- request: ShowTableRequest
Retrieves detailed information about a table, view, or schema, specified in
table_name. If the suppliedtable_nameis a schema the call can return information about either the schema itself or the tables and views it contains. Iftable_nameis 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
sizesandfull_sizes), along with the total number of objects across all requested tables (intotal_sizeandtotal_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
table_nameto ’*’ and show_children to true. When doing this, the returnedtotal_sizeandtotal_full_sizewill not include the sizes of non-base tables (e.g., filters, views, joins, etc.).