Create a Handle for an External Database
This topic provides information about creating external database handles using the OCI Console and API. The handle functions as a representation within OCI of an Oracle Database instance located outside of the Oracle Cloud.
The following procedures are not used to create an Oracle Database instance outside of Oracle Cloud.
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.
To create a or update a database connection using the TCPS connector, your user-group must have permissions to use secret-family/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.
Create a Handle to an External Pluggable Database
Perform the following steps to create a handle to an external pluggable database.
- Open the navigation menu. Select Oracle Database, and then select External Database.
- Under External databases, select Pluggable databases.
- Select your Compartment. A list of external databases is displayed.
- Click Register external pluggable database. The Register an external pluggable database dialog opens.
- Choose a compartment: By default, the database is created in your current compartment.
- Database display name: Provide a user-friendly name to help you easily identify the resource.
- Select an external container database to house the pluggable database.
- Click Show advanced options to
specify the following options for the database:
- Tags: If you have permissions to create a resource, then you also have permissions to apply free-form tags to that resource. To apply a defined tag, you must have permissions to use the tag namespace. If you are not sure whether to apply tags, skip this option (you can apply tags later) or ask your administrator. For more information, see Resource Tags.
- Click Register.
WHAT NEXT?
- After creating the external pluggable database resource (the handle), you can configure the handle's connection to the external pluggable database instance. For more information, see Create a Connection to an External Pluggable Database.
- After connecting the handle to an external database instance, you can enable associated services including Database Management and Operations Insights. For more information, see Manage the Associated Services for External Database.
Create a Handle to an External Container Database
Perform the following steps to create a handle to an external container database.
- Open the navigation menu. Select Oracle Database, and then select External Database.
- Under External databases, select Container databases.
- Select your Compartment. A list of external databases is displayed.
- Click Register external container database. The Register an external container database dialog opens.
- Choose a compartment: By default, the database is created in your current compartment.
- Database display name: Provide a user-friendly name to help you easily identify the resource.
- Click Show advanced options to
specify the following options for the database:
- Tags: If you have permissions to create a resource, then you also have permissions to apply free-form tags to that resource. To apply a defined tag, you must have permissions to use the tag namespace. If you are not sure whether to apply tags, skip this option (you can apply tags later) or ask your administrator. For more information, see Resource Tags.
- Click Register.
WHAT NEXT?
- After creating the external container database resource (the handle), you can configure the resource's connection to a container database located outside of OCI. For more information, see Create a Connection to an External Container Database.
- After connecting the handle to an external container database, you can perform a scan of the external container database to discover pluggable databases. For more information, see Scan an External Container Database for Pluggable Databases.
- After connecting the handle to an external database instance, you can enable associated services including Database Management and Operations Insights. For more information, see Manage the Associated Services for External Database.
Create a Handle to an External Non-container Database
Perform the following steps to create a handle to an external non-container database.
- Open the navigation menu. Select Oracle Database, and then select External Database.
- Under External databases, select Non-container databases.
- Select your Compartment. A list of external databases is displayed.
- Click Register external non-container database. The Register an external non-container database dialog opens.
- Choose a compartment: By default, the database is created in your current compartment.
- Database display name: Provide a user-friendly name to help you easily identify the resource.
- Click Show advanced options to
specify the following options for the database:
- Tags: If you have permissions to create a resource, then you also have permissions to apply free-form tags to that resource. To apply a defined tag, you must have permissions to use the tag namespace. If you are not sure whether to apply tags, skip this option (you can apply tags later) or ask your administrator. For more information, see Resource Tags.
- Click Register.
WHAT NEXT?
- After creating the external non-container database resource (the handle), you can configure the handle's connection to the external database instance. For more information, see Create a Connection to an External Non-Container Database.
- After connecting the handle to an external database instance, you can enable associated services including Database Management and Operations Insights. For more information, see Manage the Associated Services for External Database.
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 create OCI external database handles:
- CreateExternalContainerDatabase
- CreateExternalPluggableDatabase
- CreateExternalNonContainerDatabase
For the complete list of APIs for the Database service, see Database Service API.