Search Results xdb_datastore_proc

Overview

The XDB.DBMS_XDBT package is a database-resident PL/SQL utility delivered as part of the Oracle XML DB (XDB) component widely deployed in Oracle E-Business Suite 12.1.1 and 12.2.2 environments. Its principal business function is to create, populate, and maintain Oracle Text (ConText) indexes over the XDB repository, which stores XML documents, configuration files, and other hierarchical content generated or consumed by EBS applications. Because EBS relies on the XDB repository for several internal services, including XML Gateway processing and certain Oracle Applications Framework components, the ability to search repository content efficiently is essential to overall system responsiveness. DBMS_XDBT encapsulates the low-level Oracle Text administrative calls into a coherent workflow, allowing a DBA to build and sustain a searchable index without manually orchestrating each CTX_DDL step. In the ETRM classification the package is registered under owner XDB with an API classification of OTHER, reflecting its role as an infrastructure utility rather than an application-facing business API.

Key Procedures and Functions

The package exposes seventeen documented procedures, organized around a well-defined lifecycle. The configuration procedures DROPPREFERENCES and CREATEPREFERENCES establish the Oracle Text index preferences required for XDB content. Supporting these are specialized preference builders: CREATEDATASTOREPREF, CREATESTORAGEPREF, CREATESECTIONGROUPPREF, CREATEFILTERPREF, CREATELEXERPREF, CREATESTOPLISTPREF, and CREATEWORDLISTPREF, each responsible for a discrete aspect of index behavior such as filtering, lexical analysis, stopwords, and word list generation. The CREATEINDEX procedure performs the actual index build. Maintenance is handled by SYNCINDEX, SETSYNCTIMEOUT, and OPTIMIZEINDEX, which synchronise pending rows and reclaim fragmented index storage. Automation is provided through CONFIGUREAUTOSYNC together with the helper procedures AUTOSYNCJOBBYCOUNT and AUTOSYNCJOBBYTIME, which schedule background synchronisation via DBMS_JOB either by document count or elapsed time. Finally, XDB_DATASTORE_PROC serves as the datastore callback invoked during indexing.

Tables Accessed

The package references several dictionary and runtime objects through APPS synonyms. CTX_DDL is the primary Oracle Text DDL package used for preference and index management, while CTX_DOC supports document-level text operations and CTX_STOPWORDS supplies stopword definitions. CTX_USER_PENDING tracks rows awaiting synchronisation, providing the queue that SYNCINDEX and the auto-sync jobs consume. DBMS_JOB underpins job scheduling, DBMS_LOB handles large object manipulation, DBMS_ASSERT validates identifiers, and PLITBLM and UTL_GDK supply supporting utilities.

Usage Notes

The package is normally invoked by a DBA or with elevated privileges rather than from application forms or concurrent programs, since it manipulates database-level Oracle Text configuration. The prescribed sequence is to drop existing preferences, recreate them, build the index, verify success through CTX_USER_INDEX_ERRORS, and then configure auto-sync. Customisation is achieved either by setting package variables through a PL/SQL wrapper or by editing a private copy of the package body. Administrators must ensure the LOG_DIRECTORY parameter is set via CTX_ADM.SET_PARAMETER or that rowid logging is disabled, and that MAX_INDEX_MEMORY is at least 128 MB. The package is referenced by one other database package, confirming its role as a shared infrastructure dependency.