external_pluggable_databases

Creates, updates, deletes, gets or lists an external_pluggable_databases resource.

Overview

Name	external_pluggable_databases
Type	Resource
Id	oci.database.external_pluggable_databases

Fields

The following fields are returned by SELECT queries:

get

The [external pluggable database](#/en/database/latest/datatypes/CreateExternalPluggableDatabaseDetails).<br />resource.<br />

Name	Datatype	Description
id	string	The [OCID](/Content/General/Concepts/identifiers.htm) of the Oracle Cloud Infrastructure external database resource.
characterSet	string	The character set of the external database.
compartmentId	string	The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment.
databaseConfiguration	string	The Oracle Database configuration (RAC, SINGLE_INSTANCE)
databaseEdition	string	The Oracle Database Edition that applies to all the databases on the DB system. Exadata DB systems and 2-node RAC DB systems require ENTERPRISE_EDITION_EXTREME_PERFORMANCE. (STANDARD_EDITION, ENTERPRISE_EDITION, ENTERPRISE_EDITION_HIGH_PERFORMANCE, ENTERPRISE_EDITION_EXTREME_PERFORMANCE, ENTERPRISE_EDITION_DEVELOPER)
databaseManagementConfig	object	The configuration of the Database Management service.
databaseVersion	string	The Oracle Database version.
dbId	string	The Oracle Database ID, which identifies an Oracle Database located outside of Oracle Cloud.
dbPacks	string	The database packs licensed for the external Oracle Database.
dbUniqueName	string	The DB_UNIQUE_NAME of the external database.
definedTags	object	Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).
displayName	string	The user-friendly name for the external database. The name does not have to be unique.
externalContainerDatabaseId	string	The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the [external container database](#/en/database/latest/datatypes/CreateExternalContainerDatabaseDetails) that contains the specified [external pluggable database](#/en/database/latest/datatypes/CreateExternalPluggableDatabaseDetails) resource.
freeformTags	object	Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: {"Department": "Finance"}
lifecycleDetails	string	Additional information about the current lifecycle state.
lifecycleState	string	The current state of the Oracle Cloud Infrastructure external database resource. (PROVISIONING, NOT_CONNECTED, AVAILABLE, UPDATING, TERMINATING, TERMINATED, FAILED)
ncharacterSet	string	The national character of the external database.
operationsInsightsConfig	object	The configuration of Operations Insights for the external database
sourceId	string	The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the the non-container database that was converted to a pluggable database to create this resource.
stackMonitoringConfig	object	The configuration of Stack Monitoring for the external database.
systemTags	object	System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).
timeCreated	string (date-time)	The date and time the database was created.
timeZone	string	The time zone of the external database. It is a time zone offset (a character type in the format '[+|-]TZH:TZM') or a time zone region name, depending on how the time zone value was specified when the database was created / last altered.

list

An Oracle Cloud Infrastructure resource that allows you to manage an external pluggable database.<br />

Name	Datatype	Description
id	string	The [OCID](/Content/General/Concepts/identifiers.htm) of the Oracle Cloud Infrastructure external database resource.
characterSet	string	The character set of the external database.
compartmentId	string	The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment.
databaseConfiguration	string	The Oracle Database configuration (RAC, SINGLE_INSTANCE)
databaseEdition	string	The Oracle Database Edition that applies to all the databases on the DB system. Exadata DB systems and 2-node RAC DB systems require ENTERPRISE_EDITION_EXTREME_PERFORMANCE. (STANDARD_EDITION, ENTERPRISE_EDITION, ENTERPRISE_EDITION_HIGH_PERFORMANCE, ENTERPRISE_EDITION_EXTREME_PERFORMANCE, ENTERPRISE_EDITION_DEVELOPER)
databaseManagementConfig	object	The configuration of the Database Management service.
databaseVersion	string	The Oracle Database version.
dbId	string	The Oracle Database ID, which identifies an Oracle Database located outside of Oracle Cloud.
dbPacks	string	The database packs licensed for the external Oracle Database.
dbUniqueName	string	The DB_UNIQUE_NAME of the external database.
definedTags	object	Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).
displayName	string	The user-friendly name for the external database. The name does not have to be unique.
externalContainerDatabaseId	string	The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the [external container database](#/en/database/latest/datatypes/CreateExternalContainerDatabaseDetails) that contains the specified [external pluggable database](#/en/database/latest/datatypes/CreateExternalPluggableDatabaseDetails) resource.
freeformTags	object	Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: {"Department": "Finance"}
lifecycleDetails	string	Additional information about the current lifecycle state.
lifecycleState	string	The current state of the Oracle Cloud Infrastructure external database resource. (PROVISIONING, NOT_CONNECTED, AVAILABLE, UPDATING, TERMINATING, TERMINATED, FAILED)
ncharacterSet	string	The national character of the external database.
operationsInsightsConfig	object	The configuration of Operations Insights for the external database
sourceId	string	The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the the non-container database that was converted to a pluggable database to create this resource.
stackMonitoringConfig	object	The configuration of Stack Monitoring for the external database.
systemTags	object	System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).
timeCreated	string (date-time)	The date and time the database was created.
timeZone	string	The time zone of the external database. It is a time zone offset (a character type in the format '[+|-]TZH:TZM') or a time zone region name, depending on how the time zone value was specified when the database was created / last altered.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	externalPluggableDatabaseId, region	opc-request-id	Gets information about a specific<br />[external pluggable database](#/en/database/latest/datatypes/CreateExternalPluggableDatabaseDetails) resource.<br />
list	select	compartmentId, region	opc-request-id, externalContainerDatabaseId, limit, page, sortBy, sortOrder, lifecycleState, displayName	Gets a list of the [ExternalPluggableDatabase](#/en/database/latest/datatypes/CreateExternalPluggableDatabaseDetails)<br />resources in the specified compartment.<br />
create	insert	region, compartmentId, displayName, externalContainerDatabaseId	opc-retry-token, opc-request-id	Registers a new [ExternalPluggableDatabase](#/en/database/latest/datatypes/CreateExternalPluggableDatabaseDetails)<br />resource.<br />
update	update	externalPluggableDatabaseId, region, displayName	if-match, opc-request-id	Updates the properties of an<br />[external pluggable database](#/en/database/latest/datatypes/CreateExternalPluggableDatabaseDetails) resource,<br />such as the display name.<br />
delete	delete	externalPluggableDatabaseId, region	opc-request-id, if-match	Deletes the [external pluggable database](#/en/database/latest/datatypes/CreateExternalPluggableDatabaseDetails).<br />resource.<br />
change_compartment	exec	externalPluggableDatabaseId, region, compartmentId	opc-retry-token, opc-request-id, if-match	Move the [external pluggable database](#/en/database/latest/datatypes/CreateExternalPluggableDatabaseDetails) and<br />its dependent resources to the specified compartment.<br />For more information about moving external pluggable databases, see<br />[Moving Database Resources to a Different Compartment](/Content/Database/Concepts/databaseoverview.htm#moveRes).<br />

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
compartmentId	string	The compartment [OCID](/Content/General/Concepts/identifiers.htm).
externalPluggableDatabaseId	string	The ExternalPluggableDatabaseId [OCID](/Content/General/Concepts/identifiers.htm).
region	string	OCI region identifier (e.g. us-ashburn-1, ap-sydney-1); resolves from OCI_REGION when not supplied in the query. (default: us-ashburn-1, x-stackQL-envVar: OCI_REGION)
displayName	string	A filter to return only resources that match the entire display name given. The match is not case sensitive.
externalContainerDatabaseId	string	The ExternalContainerDatabase [OCID](/Content/General/Concepts/identifiers.htm).
if-match	string	For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
lifecycleState	string	A filter to return only resources that match the specified lifecycle state.
limit	integer	The maximum number of items to return per page.
opc-request-id	string	Unique identifier for the request.
opc-retry-token	string	A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
page	string	The pagination token to continue listing from.
sortBy	string	The field to sort by. You can provide one sort order (sortOrder). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive.
sortOrder	string	The sort order to use, either ascending (ASC) or descending (DESC).

SELECT examples

get

Gets information about a specific<br />[external pluggable database](#/en/database/latest/datatypes/CreateExternalPluggableDatabaseDetails) resource.<br />

SELECT
id,
characterSet,
compartmentId,
databaseConfiguration,
databaseEdition,
databaseManagementConfig,
databaseVersion,
dbId,
dbPacks,
dbUniqueName,
definedTags,
displayName,
externalContainerDatabaseId,
freeformTags,
lifecycleDetails,
lifecycleState,
ncharacterSet,
operationsInsightsConfig,
sourceId,
stackMonitoringConfig,
systemTags,
timeCreated,
timeZone
FROM oci.database.external_pluggable_databases
WHERE externalPluggableDatabaseId = '{{ externalPluggableDatabaseId }}' -- required
AND region = '{{ region }}' -- required
AND opc-request-id = '{{ opc-request-id }}'
;

list

Gets a list of the [ExternalPluggableDatabase](#/en/database/latest/datatypes/CreateExternalPluggableDatabaseDetails)<br />resources in the specified compartment.<br />

SELECT
id,
characterSet,
compartmentId,
databaseConfiguration,
databaseEdition,
databaseManagementConfig,
databaseVersion,
dbId,
dbPacks,
dbUniqueName,
definedTags,
displayName,
externalContainerDatabaseId,
freeformTags,
lifecycleDetails,
lifecycleState,
ncharacterSet,
operationsInsightsConfig,
sourceId,
stackMonitoringConfig,
systemTags,
timeCreated,
timeZone
FROM oci.database.external_pluggable_databases
WHERE compartmentId = '{{ compartmentId }}' -- required
AND region = '{{ region }}' -- required
AND opc-request-id = '{{ opc-request-id }}'
AND externalContainerDatabaseId = '{{ externalContainerDatabaseId }}'
AND limit = '{{ limit }}'
AND page = '{{ page }}'
AND sortBy = '{{ sortBy }}'
AND sortOrder = '{{ sortOrder }}'
AND lifecycleState = '{{ lifecycleState }}'
AND displayName = '{{ displayName }}'
;

INSERT examples

create

Registers a new [ExternalPluggableDatabase](#/en/database/latest/datatypes/CreateExternalPluggableDatabaseDetails)<br />resource.<br />

INSERT INTO oci.database.external_pluggable_databases (
compartmentId,
definedTags,
displayName,
freeformTags,
externalContainerDatabaseId,
sourceId,
region,
opc-retry-token,
opc-request-id
)
SELECT 
'{{ compartmentId }}' /* required */,
'{{ definedTags }}',
'{{ displayName }}' /* required */,
'{{ freeformTags }}',
'{{ externalContainerDatabaseId }}' /* required */,
'{{ sourceId }}',
'{{ region }}',
'{{ opc-retry-token }}',
'{{ opc-request-id }}'
RETURNING
id,
characterSet,
compartmentId,
databaseConfiguration,
databaseEdition,
databaseManagementConfig,
databaseVersion,
dbId,
dbPacks,
dbUniqueName,
definedTags,
displayName,
externalContainerDatabaseId,
freeformTags,
lifecycleDetails,
lifecycleState,
ncharacterSet,
operationsInsightsConfig,
sourceId,
stackMonitoringConfig,
systemTags,
timeCreated,
timeZone
;

Manifest

# Description fields are for documentation purposes
- name: external_pluggable_databases
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the external_pluggable_databases resource.
  - name: compartmentId
    value: "{{ compartmentId }}"
    description: |
      The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment.
  - name: definedTags
    value: "{{ definedTags }}"
    description: |
      Defined tags for this resource. Each key is predefined and scoped to a namespace.
      For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).
  - name: displayName
    value: "{{ displayName }}"
    description: |
      The user-friendly name for the external database. The name does not have to be unique.
  - name: freeformTags
    value: "{{ freeformTags }}"
    description: |
      Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
      For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).
      Example: `{"Department": "Finance"}`
  - name: externalContainerDatabaseId
    value: "{{ externalContainerDatabaseId }}"
    description: |
      The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the
      [external container database](#/en/database/latest/datatypes/CreateExternalContainerDatabaseDetails) that contains
      the specified [external pluggable database](#/en/database/latest/datatypes/CreateExternalPluggableDatabaseDetails) resource.
  - name: sourceId
    value: "{{ sourceId }}"
    description: |
      The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the the non-container database that was converted
      to a pluggable database to create this resource.
  - name: opc-retry-token
    value: "{{ opc-retry-token }}"
    description: A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected). 
    description: A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected). 
  - name: opc-request-id
    value: "{{ opc-request-id }}"
    description: Unique identifier for the request. 
    description: Unique identifier for the request. 

UPDATE examples

update

Updates the properties of an<br />[external pluggable database](#/en/database/latest/datatypes/CreateExternalPluggableDatabaseDetails) resource,<br />such as the display name.<br />

UPDATE oci.database.external_pluggable_databases
SET 
definedTags = '{{ definedTags }}',
displayName = '{{ displayName }}',
freeformTags = '{{ freeformTags }}'
WHERE 
externalPluggableDatabaseId = '{{ externalPluggableDatabaseId }}' --required
AND region = '{{ region }}' --required
AND displayName = '{{ displayName }}' --required
AND if-match = '{{ if-match}}'
AND opc-request-id = '{{ opc-request-id}}'
RETURNING
id,
characterSet,
compartmentId,
databaseConfiguration,
databaseEdition,
databaseManagementConfig,
databaseVersion,
dbId,
dbPacks,
dbUniqueName,
definedTags,
displayName,
externalContainerDatabaseId,
freeformTags,
lifecycleDetails,
lifecycleState,
ncharacterSet,
operationsInsightsConfig,
sourceId,
stackMonitoringConfig,
systemTags,
timeCreated,
timeZone;

DELETE examples

delete

Deletes the [external pluggable database](#/en/database/latest/datatypes/CreateExternalPluggableDatabaseDetails).<br />resource.<br />

DELETE FROM oci.database.external_pluggable_databases
WHERE externalPluggableDatabaseId = '{{ externalPluggableDatabaseId }}' --required
AND region = '{{ region }}' --required
AND opc-request-id = '{{ opc-request-id }}'
AND if-match = '{{ if-match }}'
;

Lifecycle Methods

change_compartment

Move the [external pluggable database](#/en/database/latest/datatypes/CreateExternalPluggableDatabaseDetails) and<br />its dependent resources to the specified compartment.<br />For more information about moving external pluggable databases, see<br />[Moving Database Resources to a Different Compartment](/Content/Database/Concepts/databaseoverview.htm#moveRes).<br />

EXEC oci.database.external_pluggable_databases.change_compartment 
@externalPluggableDatabaseId='{{ externalPluggableDatabaseId }}' --required, 
@region='{{ region }}' --required, 
@opc-retry-token='{{ opc-retry-token }}', 
@opc-request-id='{{ opc-request-id }}', 
@if-match='{{ if-match }}' 
@@json=
'{
"compartmentId": "{{ compartmentId }}"
}'
;