DESCRIBE_INDEX
Creates a report describing the index. This includes the settings of the index metadata, the indexing objects used, the settings of the attributes of the objects, and index partition descriptions, if any.
You can call this operation as a procedure with an IN OUT CLOB parameter or as a function that returns the report as a CLOB.
Syntax
procedure CTX_REPORT.DESCRIBE_INDEX(
index_name IN VARCHAR2,
report IN OUT NOCOPY CLOB,
report_format IN VARCHAR2 DEFAULT FMT_TEXT
);
function CTX_REPORT.DESCRIBE_INDEX(
index_name IN VARCHAR2,
report_format IN VARCHAR2 DEFAULT FMT_TEXT
) return CLOB;index_name
Specify the name of the index to describe.
report
Specify the CLOB locator to which to write the report.
If report is NULL, a session-duration temporary CLOB will be created and returned. It is the caller’s responsibility to free this temporary CLOB as needed.
The report CLOB will be truncated before report is generated, so any existing contents will be overwritten by this call.
report_format
Specify whether the report should be generated as ‘TEXT’ or as ‘XML’. TEXT is the default. You can also specify the values CTX_REPORT.FMT_TEXT or CTX_REPORT.FMT_XML.
Notes
CTX_REPORT.DESCRIBE_INDEX outputs FILTER BY and ORDER BY column information if the index is created with FILTER BY and/or ORDER BY clauses.