Oracle | DBMS_CLOUD_ADMIN

Oracle DBMS_CLOUD_ADMIN Version 26ai

General Information

Library Note

Morgan's Library Page Header

The best Oracle News for FY2026

Oracle Database 26ai is now availble. If you haven't you downloaded already: Why?

Purpose Administrative procedures for actions in the Oracle Autonomous Cloud Database environment.

AUTHID DEFINER

Constants

Name	Data Type	Value
KMS Constants
CUSTOMER_MANAGED_KEY	DBMS_ID	'CUSTOMER_MANAGED'
ORACLE_MANAGED_KEY	DBMS_ID	'ORACLE_MANAGED'
??AWS ARN Credential
AWS_ARN_CRED	DBMS_ID	'"AWS$ARN"'
OCI Resource Principal Credential
OCI_RPST_CRED	DBMS_ID	'"OCI$RESOURCE_PRINCIPAL"'

Dependencies (not based on Autonomous Database)

DBA_DATA_FILES	DBMS_CLOUD_DBLINK	JSON_ELEMENT_T
DBMS_ASSERT	DBMS_CLOUD_INTERNAL	JSON_OBJECT_T
DBMS_CLOUD	DBMS_CLOUD_REQUEST	UTL_ENCODE
DBMS_CLOUD_ADMIN_INTERNAL	DBMS_CLOUD_TYPES	UTL_HTTP
DBMS_CLOUD_CAPABILITY	DBMS_LOCK	UTL_RAW
DBMS_CLOUD_CORE	DBMS_STANDARD	V$ENCRYPTION_KEYS

Documented No

Exceptions

Error Code	Reason
ORA-20001	invalid_service
ORA-20002	service_not_exist
ORA-20003	default_service
ORA-20998	OCI NATIVE CREDENTIAL capability is not enabled

First Available 21c

Security Model Owned by SYS with no privileges granted

Source {ORACLE_HOME}/rdbms/admin/dbms_cloud_admin.sql
{ORACLE_HOME}/rdbms/admin/prvt_cloud_admin_body.plb

-- prerequisites
{ORACLE_HOME}/rdbms/admin/dbms_cloud_task_catalog.sql
{ORACLE_HOME}/rdbms/admin/dbms_cloud_task_views.sql
{ORACLE_HOME}/rdbms/admin/prvt_cloud_body.plb

Subprograms

CHANGE_CHARACTER_SET	ENABLE_APP_CONT
CHANGE_NATIONAL_CHARACTER_SET	ENABLE_AWS_ARN
CREATE_DATABASE_LINK	ENABLE_RESOURCE_PRINCIPAL
DISABLE_APP_CONT	GRANT_TABLESPACE_QUOTA
DISABLE_AWS_ARN	ROTATE_ENCRYPTION_KEY
DISABLE_RESOURCE_PRINCIPAL	SWITCH_TO_ORACLE_MANAGED_KEY
DROP_DATABASE_LINK

CHANGE_CHARACTER_SET

Changes the database character set in a pluggable database, provided there are no user objects created yet. It does not intend to convert user data dbms_cloud_admin_internal.change_character_set(name IN VARCHAR2);

SELECT parameter, value

      FROM v$nls_parameters

      WHERE parameter LIKE '%LANG%'

      ORDER BY 1;

      

      PARAMETER          VALUE

      ------------------ ---------

      NLS_DATE_LANGUAGE AMERICAN

      NLS_LANGUAGE      AMERICAN

      

      exec dbms_cloud_admin.change_character_set('AMERICAN');

      

      PL/SQL procedure successfully completed.

CHANGE_NATIONAL_CHARACTER_SET

Changes the national character set in a pluggable database, provided there are no user objects created yet. It does not intend to convert user data dbms_cloud_admin.change_national_character_set(name IN VARCHAR2);

exec dbms_cloud_admin.change_national_character_set('AL16UTF16');

      

      PL/SQL procedure successfully completed.

CREATE_DATABASE_LINK

Creates a database link in the current database to the target database identified by hostname, port, service_name, etc. dbms_cloud_admin.create_database_link( db_link_name IN VARCHAR2, hostname IN VARCHAR2, port IN NUMBER, service_name IN VARCHAR2, ssl_server_cert_dn IN VARCHAR2, credential_name IN VARCHAR2, directory_name IN VARCHAR2 DEFAULT 'DATA_PUMP_DIR', gateway_link IN BOOLEAN DEFAULT FALSE, public_link IN BOOLEAN DEFAULT FALSE);

TBD

DISABLE_APP_CONT

Disables application continuity for a given database service name dbms_cloud_admin.disable_app_cont(service_name IN VARCHAR2);

exec dbms_cloud_admin.disable_app_cont('pdbdev.morganslibrary.com');

      

      PL/SQL procedure successfully completed.

DISABLE_AWS_ARN

Disables users to create Amazon Resource Name credential objects in the database dbms_cloud_admin.disable_aws_arn(username IN VARCHAR2 DEFAULT NULL);

exec dbms_cloud_admin.disable_aws_arn('C##DBUSER');

      

      PL/SQL procedure successfully completed.

DISABLE_RESOURCE_PRINCIPAL

Disables users to access resource principal credential in the database dbms_cloud_admin.disable_resource_principal(username IN VARCHAR2 DEFAULT NULL);

exec dbms_cloud_admin.disable_resource_principal('C##UWCLASS');

      

      PL/SQL procedure successfully completed.

DROP_DATABASE_LINK

Drops a given database link in the current database dbms_cloud_admin.drop_database_link( db_link_name IN VARCHAR2, public_link IN BOOLEAN DEFAULT FALSE);

exec dbms_cloud_drop.create_database_link('DBMS_CLRDBLINK', FALSE);

      

      PL/SQL procedure successfully completed.

ENABLE_APP_CONT

Enables application continuity for a given database service name dbms_cloud_admin.enable_app_cont(service_name IN VARCHAR2);

exec dbms_cloud_admin.enable_app_cont('pdbdev.morganslibrary.com');

      

      PL/SQL procedure successfully completed.

ENABLE_AWS_ARN

Enables users to create an Amazon Resource Name credential objects in the database dbms_cloud_admin.enable_aws_arn(username IN VARCHAR2 DEFAULT NULL);

exec dbms_cloud_admin.enable_aws_arn('C##UWCLASS');

      

      PL/SQL procedure successfully completed.

ENABLE_RESOURCE_PRINCIPAL

Enables users to access resource principal credentials in the database dbms_cloud_admin.enable_resource_principal(username IN VARCHAR2 DEFAULT NULL);

exec dbms_cloud_admin.enable_resource_principal('C##UWCLASS');

           *

      ORA-20998: OCI NATIVE CREDENTIAL capability is not enabled

GRANT_TABLESPACE_QUOTA

Grants tablespace quota to PDB users dbms_cloud_admin.grant_tablespace_quota( username IN VARCHAR2, tablespace_quota IN VARCHAR2);

exec dbms_cloud_admin.grant_tablespace_quota('C##UWCLASS', '2 128 G');

      

      PL/SQL procedure successfully completed.

ROTATE_ENCRYPTION_KEY

Allows setting a custom key as encryption key for the database using a master key pre-created in cloud key management service, and then generates a master encryption key for the database dbms_cloud_admin.rotate_encryption_key( credential_name IN VARCHAR2 DEFAULT NULL, crypto_endpoint IN VARCHAR2 DEFAULT NULL, master_key_id IN VARCHAR2 DEFAULT NULL, vault_id IN VARCHAR2 DEFAULT NULL);

BEGIN

        dbms_cloud_admin.rotate_encryption_key(

          credential_name => 'NATIVE_CRED',

          crypto_endpoint => 'https://...crypto.oraclecloud.com',

          master_key_id => 'ocid1.key...');

      END;

      /

      

      PL/SQL procedure successfully completed.

SWITCH_TO_ORACLE_MANAGED_KEY

Switches the key to Oracle Managed dbms_cloud_admin.switch_to_oracle_managed_key;

exec dbms_cloud_admin.switch_to_oracle_managed_key;

      

      PL/SQL procedure successfully completed.