23.10 FORMAT_METADATA Function Signature 2

This procedure converts DBMS_DEVELOPER.GET_METADATA JSON output to readable text for human and LLM consumption. This overload is provided for Oracle Database 19c backwards compatibility.

Syntax

FUNCTION apex_db_dictionary.format_metadata (
    p_json                       IN   CLOB,
    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_json	JSON output from DBMS_DEVELOPER.GET_METADATA as CLOB
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

CLOB containing formatted table description.