> ## 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

<ul>
  <li>
    show\_table(\
    &#x20;table\_name: string,\
    &#x20;options?: Record\<string, string>,\
    &#x20;callback?: [GPUdbCallback](https://docs.kinetica.com/content/api/javascript/types/GPUdbCallback.md),\
    ): Promise\<[ShowTableResponse](https://docs.kinetica.com/content/api/javascript/interfaces/ShowTableResponse.md)>

    Retrieves detailed information about a table, view, or schema, specified in `table_name`. If the supplied `table_name` is a schema the call can return information about either the schema itself or the tables and views it contains. If `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 `sizes` and `full_sizes`), along with the total number of objects across all requested tables (in `total_size` and `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 `table_name` to '\*' and show\_children to true. When doing this, the returned `total_size` and `total_full_size` will not include the sizes of non-base tables (e.g., filters, views, joins, etc.).

    #### Parameters

    <ul>
      <li>
        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.
      </li>

      <li>
        `Optional`options: Record\<string, string>

        Optional parameters.
      </li>

      <li>
        `Optional`callback: [GPUdbCallback](https://docs.kinetica.com/content/api/javascript/types/GPUdbCallback.md)

        Optional callback function
      </li>
    </ul>

    #### Returns Promise\<[ShowTableResponse](https://docs.kinetica.com/content/api/javascript/interfaces/ShowTableResponse.md)>

    Promise\<Types.ShowTableResponse> - Promise resolving to the response

    <ul>
      <li>Defined in [src/GPUdb.ts:14266](https://github.com/kineticadb/kinetica-api-typescript/blob/master/src/GPUdb.ts#L14266)</li>
    </ul>
  </li>
</ul>

### show\_table\_request

<ul>
  <li>
    show\_table\_request(\
    &#x20;request: [ShowTableRequest](https://docs.kinetica.com/content/api/javascript/interfaces/ShowTableRequest.md),\
    &#x20;callback?: [GPUdbCallback](https://docs.kinetica.com/content/api/javascript/types/GPUdbCallback.md),\
    ): Promise\<[ShowTableResponse](https://docs.kinetica.com/content/api/javascript/interfaces/ShowTableResponse.md)>

    Retrieves detailed information about a table, view, or schema, specified in `table_name`. If the supplied `table_name` is a schema the call can return information about either the schema itself or the tables and views it contains. If `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 `sizes` and `full_sizes`), along with the total number of objects across all requested tables (in `total_size` and `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 `table_name` to '\*' and show\_children to true. When doing this, the returned `total_size` and `total_full_size` will not include the sizes of non-base tables (e.g., filters, views, joins, etc.).

    #### Parameters

    <ul>
      <li>
        request: [ShowTableRequest](https://docs.kinetica.com/content/api/javascript/interfaces/ShowTableRequest.md)

        Request object containing the parameters for the operation
      </li>

      <li>
        `Optional`callback: [GPUdbCallback](https://docs.kinetica.com/content/api/javascript/types/GPUdbCallback.md)

        Optional callback function
      </li>
    </ul>

    #### Returns Promise\<[ShowTableResponse](https://docs.kinetica.com/content/api/javascript/interfaces/ShowTableResponse.md)>

    Promise\<Types.ShowTableResponse> - Promise resolving to the response

    <ul>
      <li>Defined in [src/GPUdb.ts:14224](https://github.com/kineticadb/kinetica-api-typescript/blob/master/src/GPUdb.ts#L14224)</li>
    </ul>
  </li>
</ul>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.