Oracle CTX_REPORT
Version 26ai

General Information
Library Note Morgan's Library Page Header
The best Oracle News for FY2026

Oracle Database 26ai will be available on generic Linux platforms in January and soon on AIX and Windows
Purpose Undocumented
AUTHID CURRENT_USER
Constants
Name Data Type Value
 General
FMT_TEXT VARCHAR2(10) 'TEXT'
FMT_XML VARCHAR2(10) 'XML'
 Token Types
TOKEN_TYPE_TEXT NUMBER 0
TOKEN_TYPE_THEME NUMBER 1
TOKEN_TYPE_ZONE_SEC NUMBER 2
TOKEN_TYPE_ATTR_TEXT NUMBER 4
TOKEN_TYPE_ATTR_SEC NUMBER 5
TOKEN_TYPE_PREFIX NUMBER 6
TOKEN_TYPE_PATH_SEC NUMBER 7
TOKEN_TYPE_PATH_ATTR NUMBER 8
TOKEN_TYPE_STEM NUMBER 9
TOKEN_TYPE_ATTR_TXT_PFIX NUMBER 604
TOKEN_TYPE_ATTR_TXT_STEM NUMBER 904
Data Types TYPE query_record IS RECORD(
times NUMBER,
query VARCHAR2(4000));

TYPE query_table IS TABLE OF query_record
INDEX BY BINARY_INTEGER;
Dependencies
DBMS_ASSERT DRIREP DRVDISP
DBMS_LOB DRIREPM DRVIMR
DBMS_STANDARD DRIREPZ DRVUTL
DRIDISP DRISGP DRVXMD
DRIG DRIUTL DR_DEF
DRILIST DRIXMD PLITBLM
DRILOAD DRUE  
Documented Yes: Packages and Types Reference
First Available Not known
Pragma PRAGMA SUPPLEMENTAL_LOG_DATA(DEFAULT, NONE);
Security Model Owned by SYS with EXECUTE granted to MDSYS and PUBLIC
Source {ORACLE_HOME}/rdbms/admin/dr0repor.pkh
{ORACLE_HOME}/rdbms/admin/dr0repor.plb
Subprograms
CREATE_INDEX_SCRIPT QUERY_LOG_SUMMARY
CREATE_POLICY_SCRIPT RESOLVE_PATTERN
DESCRIBE_INDEX SHOW_TOKENS
DESCRIBE_POLICY TOKEN_INFO
INDEX_HEALTH_STATISTICS TOKEN_TYPE
INDEX_SIZE VALIDATE_INDEX
INDEX_STATS WILDCARD_INDEX_FRAGMENTATION
OFFSET_INFO  
 
CREATE_INDEX_SCRIPT
Creates a SQL*Plus script to create a text index that duplicates the named text index

Overload 1		 ctx_report.create_index_script(
index_name      IN            VARCHAR2,
report          IN OUT NOCOPY CLOB,
prefname_prefix IN            VARCHAR2 DEFAULT NULL);
TBD
Overload 2 ctx_report.create_index_script(
index_name     IN VARCHAR2,
prefname_prefix IN VARCHAR2 DEFAULT NULL)
RETURN CLOB;
TBD
 
CREATE_POLICY_SCRIPT
Creates a SQL*Plus script to create a text policy that duplicates the named text policy

Overload 1		 ctx_report.create_policy_script(
policy_name     IN            VARCHAR2,
report          IN OUT NOCOPY CLOB,
prefname_prefix IN            VARCHAR2 DEFAULT NULL);
TBD
Overload 2 ctx_report.create_policy_script(
policy_name     IN VARCHAR2,
prefname_prefix IN VARCHAR2 DEFAULT NULL)
RETURN CLOB;
TBD
 
DESCRIBE_INDEX
Creates a report describing an index including index meta-data settings, indexing objects used, object attribute  settings and index partition descriptions

Overload 1		 ctx_report.describe_index(
index_name    IN            VARCHAR2,
report        IN OUT NOCOPY CLOB,
report_format IN            VARCHAR2 DEFAULT FMT_TEXT);
TBD
Overload 2 ctx_report.describe_index(
index_name    IN VARCHAR2,
report_format IN VARCHAR2 DEFAULT FMT_TEXT)
RETURN CLOB;
TBD
 
DESCRIBE_POLICY
Creates a report describing a policy including policy metadata settings,  indexing objects used, and object attributes settings

Overload 1		 ctx_report.describe_policy(
 policy_name  IN            VARCHAR2,
report        IN OUT NOCOPY CLOB,
report_format IN            VARCHAR2 DEFAULT FMT_TEXT);
TBD
Overload 2 ctx_report.describe_policy(
policy_name   IN VARCHAR2,
report_format IN VARCHAR2 DEFAULT FMT_TEXT)
RETURN CLOB;
TBD
 
INDEX_HEALTH_STATISTICS (new 23ai)
Undocumented ctx_report.index_health_statistics(
index_name IN VARCHAR2,
part_name  IN VARCHAR2,
topn_frag  IN NUMBER)
RETURN CLOB;
TBD
 
INDEX_SIZE
Create a report showing the internal objects of a text index or text index partition, and their tablespaces, allocated, and used sizes

Overload 1		 ctx_report.index_size(
index_name    IN            VARCHAR2,
report        IN OUT NOCOPY CLOB,
part_name     IN            VARCHAR2 DEFAULT NULL,
report_format IN            VARCHAR2 DEFAULT FMT_TEXT);
TBD
Overload 2 ctx_report.index_size(
index_name    IN VARCHAR2,
part_name     IN VARCHAR2 DEFAULT NULL,
report_format IN VARCHAR2 DEFAULT FMT_TEXT)
RETURN CLOB;
TBD
 
INDEX_STATS
Create a report showing  calculated text index statistics ctx_report.index_stats(
index_name    IN            VARCHAR2,
report        IN OUT NOCOPY CLOB,
part_name     IN            VARCHAR2 DEFAULT NULL,
frag_stats    IN            BOOLEAN  DEFAULT TRUE,
list_size     IN            NUMBER   DEFAULT 100,
report_format IN            VARCHAR2 DEFAULT FMT_TEXT,
stat_type     IN            VARCHAR2 DEFAULT NULL);
TBD
 
OFFSET_INFO
Undocumented ctx_report.offset_info(
index_name    IN VARCHAR2,
docid         IN VARCHAR2,
token_type    IN NUMBER,
part_name     IN VARCHAR2 DEFAULT NULL,
raw_info      IN VARCHAR2 DEFAULT 'N',
decoded_info  IN VARCHAR2 DEFAULT 'Y',
report_format IN VARCHAR2 DEFAULT FMT_TEXT)
RETURN CLOB;
TBD
 
QUERY_LOG_SUMMARY
Returns the most(least) frequent queries from the query log file ctx_report.query_log_summary(
logfile      IN            VARCHAR2,
indexname    IN            VARCHAR2 DEFAULT NULL,
result_table IN OUT NOCOPY query_table,
row_num      IN            NUMBER   DEFAULT 50,
most_freq    IN            BOOLEAN  DEFAULT true,
has_hit      IN            BOOLEAN  DEFAULT TRUE);
TBD
 
RESOLVE_PATTERN
Undocumented ctx_report.resolve_pattern(
p_policy_id        IN NUMBER,
p_regular_expr     IN VARCHAR2,
p_index_name       IN VARCHAR2,
p_regexpr_maxterms IN NUMBER)
RETURN CLOB;
TBD
 
SHOW_TOKENS (new 23ai)
Undocumented ctx_report.show_tokens(
index_name    IN VARCHAR2,
part_name     IN VARCHAR2,
report_format IN VARCHAR2,
types         IN BOOLEAN,
docid_counts  IN BOOLEAN,
docid_ranges  IN BOOLEAN,
frag_counts   IN BOOLEAN)
RETURN CLOB;
TBD
 
TOKEN_INFO
Creates a report showing decoded token information

Overload 1		 ctx_report.token_info(
index_name    IN            VARCHAR2,
report        IN OUT NOCOPY CLOB,
token         IN            VARCHAR2,
token_type    IN            NUMBER,
part_name     IN            VARCHAR2 DEFAULT NULL,
raw_info      IN            BOOLEAN  DEFAULT FALSE,
decoded_info  IN            BOOLEAN  DEFAULT TRUE,
report_format IN            VARCHAR2 DEFAULT FMT_TEXT);
TBD
Overload 2 ctx_report.token_info(
index_name    IN VARCHAR2,
token         IN VARCHAR2,
token_type    IN NUMBER,
part_name     IN VARCHAR2 DEFAULT NULL,
raw_info      IN VARCHAR2 DEFAULT 'N',
decoded_info  IN VARCHAR2 DEFAULT 'Y',
report_format IN VARCHAR2 DEFAULT FMT_TEXT)
RETURN CLOB;
TBD
 
TOKEN_TYPE
Helper function translates an English name into a numeric token type for use with token_info, or any other CTX API that takes IN a token_type ctx_report.token_type(
index_name IN VARCHAR2,
type_name   IN VARCHAR2)
RETURN NUMBER;
TBD
 
VALIDATE_INDEX
Validates an index and writes corrupt tokens to log file ctx_report.validate_index(
index_name IN VARCHAR2,
part_name  IN VARCHAR2 DEFAULT NULL);
TBD
 
WILDCARD_INDEX_FRAGMENTATION
Undocumented ctx_report.wildcard_index_fragmentation(
index_name IN VARCHAR2,
part_name  IN VARCHAR2 DEFAULT NULL)
RETURN NUMBER;
TBD

Related Topics
Built-in Functions
Built-in Packages
Database Security
CTX_ADM
CTX_ANL
CTX_CATSEARCH
CTX_CLS
CTX_CONTAINS
CTX_DDL
CTX_DOC
CTX_ENTITY
CTX_MATCHES
CTX_OUTPUT
CTX_QUERY
CTX_THES
CTX_TREE
CTX_ULEXER
CTX_XPCONTAINS
DBMS_SEARCH
What's New In 21c
What's New In 26ai

Morgan's Library Page Footer
This site is maintained by Daniel Morgan. Last Updated: This site is protected by copyright and trademark laws under U.S. and International law. © 1998-2026 Daniel A. Morgan All Rights Reserved