23.3 GET_TABLE_INFO Function Signature 1

This function gets formatted metadata for one or more tables or views.

Syntax

FUNCTION apex_db_dictionary.get_table_info (
    p_table_names                IN   VARCHAR2,
    p_include_constraints        IN   BOOLEAN          DEFAULT TRUE,
    p_include_indexes            IN   BOOLEAN          DEFAULT FALSE,
    p_include_comments           IN   BOOLEAN          DEFAULT TRUE,
    p_include_annotations        IN   BOOLEAN          DEFAULT TRUE,
    p_include_domains            IN   BOOLEAN          DEFAULT TRUE,
    p_include_virtual_columns    IN   BOOLEAN          DEFAULT FALSE,
    p_format                     IN   t_format_type    DEFAULT C_MARKDOWN )
    RETURN CLOB;

Parameters

Parameter	Description
p_table_names	Comma-separated list of table/view names (e.g., 'EMP, DEPT, EMP_VIEW'). Include the owner (e.g. 'HR.EMP, HR.DEPT') if not owned by the current user. For case-sensitive quoted identifiers, include the quotes (e.g. '"Dept", "HR"."OrderLines"').
p_include_constraints	Show constraints section (default TRUE).
p_include_indexes	Show indexes section (default FALSE).
p_include_comments	Show table/column comments (default TRUE).
p_include_annotations	Show table/column annotations (default TRUE).
p_include_domains	Show SQL Domain metadata section (default TRUE).
p_include_virtual_columns	Include virtual columns in output (default FALSE).
p_format	c_markdown (default) or c_plain.

Returns

This function returns a CLOB containing formatted descriptions for all requested tables/views.

Example

This example returns a CLOB with formatted descriptions of the EMP and DEPT tables.

declare
    l_text clob; 
begin
    l_text := apex_db_dictionary.get_table_info( 
        p_table_names => 'EMP, DEPT' ); 
end;