22 Oracle Data Studio Family of Packages

To use the Data Studio DBMS_CATALOG, DBMS_DATA_TOOLS_JOBS and DBMS_LIVE_FEED packages, you must complete certain tasks.

Starting with Oracle AI Database 26ai (23.26.2), you can install Data Studio packages with installation scripts deployed with Oracle AI Database. These packages are not preinstalled. You must manually install these packages, and also configure users or roles to use these packages.

Parent topic: Other Utilities

22.1 Installing the Oracle Data Services Data Studio Packages

Learn how to install and validate Data Studio and DBMS_CATALOG packages for your On Premises container database (CDB) and pluggable databases (PDBs).

To proceed with Data Studio installation, you must first have installed and validated the DBMS_CLOUD family of packages. as described here:

DBMS_CLOUD Family of Packages

For customer-managed Oracle AI Databases, you are required to install the Data Studio functionality and DBMS_CATALOG family of packages manually. Installation consists of installing a user and schema, called C##ADP$SERVICE, that contains the support packages. The schema is locked by default so that no connections are directly made as this user.

When you update to a release update (RU) that has a new Data Studio deployment, you must rerun the installation procedure on top of your existing procedure on the PDBs where you want to access the Data Studio or DBMS_CATALOG. The installation is written-idempotent, so you do not have to uninstall and reinstall Data Studio, but the user you create to administer this installation can connect to the schema.

To ensure correct installation of Data Studio and DBMS_CATALOG into any existing and future PDBs, install the packages using the catcon.pl utility that is located in the directory Oracle home/rdbms/admin/. The code and installation scripts for Data Studio and DBMS_CATALOG are part of the Oracle distribution. The main script is data_studio_install.sql. Do not modify this script. It performs the following functions:
  • Creates the schema C##ADP$SERVICE with the necessary privileges
  • Installs Data Studio and the DBMS_CLOUD packages in schema C##ADP$SERVICE

Complete the following procedure:

  1. Log in to the CDB where you want to install the Data Studio and DBMS_CATALOG packages, and use catcon.pl to perform the installation.

    In the following example, the DBMS_CLOUD packages are installed, and the log files are configured to be created in the /tmp directory with the prefix data_ studio_install:

    $ORACLE_HOME/perl/bin/perl $ORACLE_HOME/rdbms/admin/catcon.pl -u sys/your-password -force_pdb_mode 'READ WRITE' - b data_studio_install -d $ORACLE_HOME/rdbms/admin/ -l /tmp data_studio_install.sql

  2. After the installation is complete, check the log files for any errors.

    You should see the packages DBMS_LIVE_FEED and DBMS_CATALOG are created and valid in both CDB$ROOT and any PDB where you want to deploy Data Studio.

    For example, log in to SQL and run the following check:

    select con_id, owner, object_name, status, sharing, oracle_maintained from cdb_objects where object_name in ( 'DBMS_LIVE_FEED', 'DBMS_CATALOG' );

    To see the packages in a PDB, log in to SQL and run the following check:

    select owner, object_name, status, sharing, oracle_maintained from dba_objects where object_name object_name in ( 'DBMS_LIVE_FEED', 'DBMS_CATALOG' );

    Note:

    The installation will force all pluggable database to be open for the installation, but the prior stage of a PDB will be retained after installation. Accordingly, these query checks will only show and work for open pluggable databases.

  3. If the install logs show any error, or if you have any invalid objects owned by C##ADP$SERVICE, then you must analyze and correct these issues.

Parent topic: Oracle Data Studio Family of Packages