23.4 GET_TABLE_INFO Function Signature 2

This function gets formatted metadata for one or more tables or views, specified with an array.

Syntax

FUNCTION apex_db_dictionary.get_table_info (
    p_table_array                IN   apex_t_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_array	Array of table/view names, e.g. apex_t_varchar2('EMP','DEPT') Optionally, include the owner, e.g. apex_t_varchar2('HR.EMP, HR.DEPT') if not owned by the current user. Enclose in double-quotes if the identifier is case-sensitive or includes special characters, e.g. apex__t_varchar2(' "HR" . "Employees" ')
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 containing a formatted description of the EMP and DEPT tables.

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