Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace PluggableDatabase

A pluggable database (PDB) is portable collection of schemas, schema objects, and non-schema objects that appears to an Oracle client as a non-container database. To use a PDB, it needs to be plugged into a CDB. To use any of the API operations, you must be authorized in an IAM policy. If you are not authorized, talk to a tenancy administrator. If you are an administrator who needs to write policies to give users access, see Getting Started with Policies.

*Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API.

Properties

compartmentId

compartmentId: string

The OCID of the compartment.

Optional connectionStrings

connectionStrings: model.PluggableDatabaseConnectionStrings

containerDatabaseId

containerDatabaseId: string

The OCID of the CDB.

Optional definedTags

definedTags: undefined | object

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

Optional freeformTags

freeformTags: undefined | 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.

Example: {@code {\"Department\": \"Finance\"}}

id

id: string

The OCID of the pluggable database.

Optional isRestricted

isRestricted: undefined | false | true

The restricted mode of the pluggable database. If a pluggable database is opened in restricted mode, the user needs both create a session and have restricted session privileges to connect to it.

Optional lifecycleDetails

lifecycleDetails: undefined | string

Detailed message for the lifecycle state.

lifecycleState

lifecycleState: LifecycleState

The current state of the pluggable database.

openMode

openMode: OpenMode

Deprecated. Use {@link #pluggableDatabaseNodeLevelDetails(PluggableDatabaseNodeLevelDetailsRequest) pluggableDatabaseNodeLevelDetails} for OpenMode details. The mode that pluggable database is in. Open mode can only be changed to READ_ONLY or MIGRATE directly from the backend (within the Oracle Database software).

pdbName

pdbName: string

The name for the pluggable database (PDB). The name is unique in the context of a Database. The name must begin with an alphabetic character and can contain a maximum of thirty alphanumeric characters. Special characters are not permitted. The pluggable database name should not be same as the container database name.

Optional pdbNodeLevelDetails

Pluggable Database Node Level Details. Example: [{"nodeName" : "node1", "openMode" : "READ_WRITE"}, {"nodeName" : "node2", "openMode" : "READ_ONLY"}]

Optional pluggableDatabaseManagementConfig

pluggableDatabaseManagementConfig: model.PluggableDatabaseManagementConfig

Optional refreshableCloneConfig

refreshableCloneConfig: model.PluggableDatabaseRefreshableCloneConfig

timeCreated

timeCreated: Date

The date and time the pluggable database was created.

Functions

getDeserializedJsonObj

getJsonObj