Oracle Cloud Infrastructure Documentation

Manage the Handles for External Database

This topic provides information about managing external database handles using the OCI Console and API.

Required IAM Policy

To use Oracle Cloud Infrastructure, you must be granted security access in a policy by an administrator. This access is required whether you're using the Console or the REST API with an SDK, CLI, or other tool. If you get a message that you don't have permission or are unauthorized, verify with your administrator what type of access you have and which compartment to work in.

For administrators: The policy in Let database admins manage Oracle Cloud external database resources lets the specified group do everything with databases and related database resources.

If you're new to policies, see Getting Started with Policies and Common Policies. For more information about writing policies for databases, see Policy Details for External Database.

Move an OCI External Database Handle to Another Compartment

Perform the following steps to move an external database handle to another compartment.

  1. Open the navigation menu. Select Oracle Database, and then select External Database.
  2. Under External Database, select either Pluggable Databases, Container Databases, or Non-Container Databases depending on the type of external database you are using.
  3. Select your Compartment. A list of external databases is displayed.
  4. In the list of external databases, click the name of the database you want to move. Details of the external database you selected are displayed.
  5. On the External database details page, click Move resource.
  6. In the Move resource dialog, select the Destination compartment where you want the resource to be moved.
  7. Click Move resource.

Delete an External Database Handle

Perform the following steps to delete an external database handle.

Note

  • If your external database handle has an associated database connection resources, you must first delete the connections before you can delete the external database handle.
  • For external container databases, you cannot delete the OCI handle until all of the external pluggable database handles in the container database handle have first been deleted.
  1. Open the navigation menu. Select Oracle Database, and then select External Database.
  2. Under External Database, select either Pluggable Databases, Container Databases, or Non-Container Databases depending on the type of external database you are using.
  3. Select your Compartment. A list of external databases is displayed.
  4. In the list of external databases, click the name of the database you want to delete. Details of the external database you selected are displayed.
  5. On the External database details page, click Delete.
  6. In the Delete external database dialog, provide the external database name to confirm the deletion.
  7. Click Delete.

Scan an External Container Database for Pluggable Databases

Perform the following steps to scan an external container database for pluggable databases.

  1. Open the navigation menu. Select Oracle Database, and then select External Database.
  2. Under External Database, select Container Databases.
  3. Select your Compartment. A list of external databases is displayed.
  4. In the list of external databases, click the name of the database you want to scan. Details of the external database you selected are displayed.
  5. On the External container database details page, click Scan for pluggable databases.
  6. The Scan for pluggable databases window appears.
  7. Select an external database connector from the drop-down list.
  8. Click Scan databases.

If any pluggable databases are discovered that are not connected to OCI, the connection details for these databases are listed in the work requests generated by the scan operation. For more information about work requests, see Work Requests.

Use the API

For information about using the API and signing requests, see REST APIs and Security Credentials. For information about SDKs, see Software Development Kits and Command Line Interface.

Use these API operations to manage external container database resources:

  • ListExternalContainerDatabases
  • GetExternalContainerDatabase
  • ChangeExternalContainerDatabaseCompartment
  • ScanExternalContainerDatabasePluggableDatabases
  • UpdateExternalContainerDatabase
  • DeleteExternalContainerDatabase

Use these API operations to manage external pluggable database resources:

  • ListExternalPluggableDatabases
  • GetExternalPluggableDatabase
  • ChangeExternalPluggableDatabaseCompartment
  • UpdateExternalPluggableDatabase
  • DeleteExternalPluggableDatabase

Use these API operations to manage external non-container database resources:

  • ListExternalNonContainerDatabases
  • GetExternalNonContainerDatabase
  • ChangeExternalNonContainerDatabaseCompartment
  • UpdateExternalNonContainerDatabase
  • DeleteExternalNonContainerDatabase

For the complete list of APIs for the Database service, see Database Service API.