PluggableDatabase¶

class oci.database.models.PluggableDatabase(**kwargs)¶

Bases: object

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.

Attributes:

`DATA_SAFE_STATE_DISABLED`	A constant which can be used with the data_safe_state property of a PluggableDatabase.
`DATA_SAFE_STATE_ENABLED`	A constant which can be used with the data_safe_state property of a PluggableDatabase.
`DATA_SAFE_STATE_FAILED`	A constant which can be used with the data_safe_state property of a PluggableDatabase.
`LIFECYCLE_STATE_AVAILABLE`	A constant which can be used with the lifecycle_state property of a PluggableDatabase.
`LIFECYCLE_STATE_BACKUP_IN_PROGRESS`	A constant which can be used with the lifecycle_state property of a PluggableDatabase.
`LIFECYCLE_STATE_DISABLED`	A constant which can be used with the lifecycle_state property of a PluggableDatabase.
`LIFECYCLE_STATE_FAILED`	A constant which can be used with the lifecycle_state property of a PluggableDatabase.
`LIFECYCLE_STATE_PROVISIONING`	A constant which can be used with the lifecycle_state property of a PluggableDatabase.
`LIFECYCLE_STATE_REFRESHING`	A constant which can be used with the lifecycle_state property of a PluggableDatabase.
`LIFECYCLE_STATE_RELOCATED`	A constant which can be used with the lifecycle_state property of a PluggableDatabase.
`LIFECYCLE_STATE_RELOCATING`	A constant which can be used with the lifecycle_state property of a PluggableDatabase.
`LIFECYCLE_STATE_RESTORE_FAILED`	A constant which can be used with the lifecycle_state property of a PluggableDatabase.
`LIFECYCLE_STATE_RESTORE_IN_PROGRESS`	A constant which can be used with the lifecycle_state property of a PluggableDatabase.
`LIFECYCLE_STATE_TERMINATED`	A constant which can be used with the lifecycle_state property of a PluggableDatabase.
`LIFECYCLE_STATE_TERMINATING`	A constant which can be used with the lifecycle_state property of a PluggableDatabase.
`LIFECYCLE_STATE_UPDATING`	A constant which can be used with the lifecycle_state property of a PluggableDatabase.
`OPEN_MODE_MIGRATE`	A constant which can be used with the open_mode property of a PluggableDatabase.
`OPEN_MODE_MOUNTED`	A constant which can be used with the open_mode property of a PluggableDatabase.
`OPEN_MODE_READ_ONLY`	A constant which can be used with the open_mode property of a PluggableDatabase.
`OPEN_MODE_READ_WRITE`	A constant which can be used with the open_mode property of a PluggableDatabase.
`compartment_id`	[Required] Gets the compartment_id of this PluggableDatabase.
`connection_strings`	Gets the connection_strings of this PluggableDatabase.
`container_database_id`	[Required] Gets the container_database_id of this PluggableDatabase.
`data_safe_state`	Gets the data_safe_state of this PluggableDatabase.
`defined_tags`	Gets the defined_tags of this PluggableDatabase.
`freeform_tags`	Gets the freeform_tags of this PluggableDatabase.
`id`	[Required] Gets the id of this PluggableDatabase.
`is_restricted`	Gets the is_restricted of this PluggableDatabase.
`kms_key_id`	Gets the kms_key_id of this PluggableDatabase.
`kms_key_version_id`	Gets the kms_key_version_id of this PluggableDatabase.
`lifecycle_details`	Gets the lifecycle_details of this PluggableDatabase.
`lifecycle_state`	[Required] Gets the lifecycle_state of this PluggableDatabase.
`open_mode`	[Required] Gets the open_mode of this PluggableDatabase.
`patch_version`	Gets the patch_version of this PluggableDatabase.
`pdb_name`	[Required] Gets the pdb_name of this PluggableDatabase.
`pdb_node_level_details`	Gets the pdb_node_level_details of this PluggableDatabase.
`pluggable_database_management_config`	Gets the pluggable_database_management_config of this PluggableDatabase.
`refreshable_clone_config`	Gets the refreshable_clone_config of this PluggableDatabase.
`system_tags`	Gets the system_tags of this PluggableDatabase.
`time_created`	[Required] Gets the time_created of this PluggableDatabase.

Methods:

__init__(**kwargs)

Initializes a new PluggableDatabase object with values from keyword arguments.

DATA_SAFE_STATE_DISABLED = 'DISABLED'¶: A constant which can be used with the data_safe_state property of a PluggableDatabase. This constant has a value of “DISABLED”

DATA_SAFE_STATE_ENABLED = 'ENABLED'¶: A constant which can be used with the data_safe_state property of a PluggableDatabase. This constant has a value of “ENABLED”

DATA_SAFE_STATE_FAILED = 'FAILED'¶: A constant which can be used with the data_safe_state property of a PluggableDatabase. This constant has a value of “FAILED”

LIFECYCLE_STATE_AVAILABLE = 'AVAILABLE'¶: A constant which can be used with the lifecycle_state property of a PluggableDatabase. This constant has a value of “AVAILABLE”

LIFECYCLE_STATE_BACKUP_IN_PROGRESS = 'BACKUP_IN_PROGRESS'¶: A constant which can be used with the lifecycle_state property of a PluggableDatabase. This constant has a value of “BACKUP_IN_PROGRESS”

LIFECYCLE_STATE_DISABLED = 'DISABLED'¶: A constant which can be used with the lifecycle_state property of a PluggableDatabase. This constant has a value of “DISABLED”

LIFECYCLE_STATE_FAILED = 'FAILED'¶: A constant which can be used with the lifecycle_state property of a PluggableDatabase. This constant has a value of “FAILED”

LIFECYCLE_STATE_PROVISIONING = 'PROVISIONING'¶: A constant which can be used with the lifecycle_state property of a PluggableDatabase. This constant has a value of “PROVISIONING”

LIFECYCLE_STATE_REFRESHING = 'REFRESHING'¶: A constant which can be used with the lifecycle_state property of a PluggableDatabase. This constant has a value of “REFRESHING”

LIFECYCLE_STATE_RELOCATED = 'RELOCATED'¶: A constant which can be used with the lifecycle_state property of a PluggableDatabase. This constant has a value of “RELOCATED”

LIFECYCLE_STATE_RELOCATING = 'RELOCATING'¶: A constant which can be used with the lifecycle_state property of a PluggableDatabase. This constant has a value of “RELOCATING”

LIFECYCLE_STATE_RESTORE_FAILED = 'RESTORE_FAILED'¶: A constant which can be used with the lifecycle_state property of a PluggableDatabase. This constant has a value of “RESTORE_FAILED”

LIFECYCLE_STATE_RESTORE_IN_PROGRESS = 'RESTORE_IN_PROGRESS'¶: A constant which can be used with the lifecycle_state property of a PluggableDatabase. This constant has a value of “RESTORE_IN_PROGRESS”

LIFECYCLE_STATE_TERMINATED = 'TERMINATED'¶: A constant which can be used with the lifecycle_state property of a PluggableDatabase. This constant has a value of “TERMINATED”

LIFECYCLE_STATE_TERMINATING = 'TERMINATING'¶: A constant which can be used with the lifecycle_state property of a PluggableDatabase. This constant has a value of “TERMINATING”

LIFECYCLE_STATE_UPDATING = 'UPDATING'¶: A constant which can be used with the lifecycle_state property of a PluggableDatabase. This constant has a value of “UPDATING”

OPEN_MODE_MIGRATE = 'MIGRATE'¶: A constant which can be used with the open_mode property of a PluggableDatabase. This constant has a value of “MIGRATE”

OPEN_MODE_MOUNTED = 'MOUNTED'¶: A constant which can be used with the open_mode property of a PluggableDatabase. This constant has a value of “MOUNTED”

OPEN_MODE_READ_ONLY = 'READ_ONLY'¶: A constant which can be used with the open_mode property of a PluggableDatabase. This constant has a value of “READ_ONLY”

OPEN_MODE_READ_WRITE = 'READ_WRITE'¶: A constant which can be used with the open_mode property of a PluggableDatabase. This constant has a value of “READ_WRITE”

__init__(**kwargs)¶

Initializes a new PluggableDatabase object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters

id (str) – The value to assign to the id property of this PluggableDatabase.
container_database_id (str) – The value to assign to the container_database_id property of this PluggableDatabase.
pdb_name (str) – The value to assign to the pdb_name property of this PluggableDatabase.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this PluggableDatabase. Allowed values for this property are: “PROVISIONING”, “AVAILABLE”, “TERMINATING”, “TERMINATED”, “UPDATING”, “FAILED”, “RELOCATING”, “RELOCATED”, “REFRESHING”, “RESTORE_IN_PROGRESS”, “RESTORE_FAILED”, “BACKUP_IN_PROGRESS”, “DISABLED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
lifecycle_details (str) – The value to assign to the lifecycle_details property of this PluggableDatabase.
time_created (datetime) – The value to assign to the time_created property of this PluggableDatabase.
connection_strings (oci.database.models.PluggableDatabaseConnectionStrings) – The value to assign to the connection_strings property of this PluggableDatabase.
open_mode (str) – The value to assign to the open_mode property of this PluggableDatabase. Allowed values for this property are: “READ_ONLY”, “READ_WRITE”, “MOUNTED”, “MIGRATE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
is_restricted (bool) – The value to assign to the is_restricted property of this PluggableDatabase.
compartment_id (str) – The value to assign to the compartment_id property of this PluggableDatabase.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this PluggableDatabase.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this PluggableDatabase.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this PluggableDatabase.
pluggable_database_management_config (oci.database.models.PluggableDatabaseManagementConfig) – The value to assign to the pluggable_database_management_config property of this PluggableDatabase.
kms_key_id (str) – The value to assign to the kms_key_id property of this PluggableDatabase.
kms_key_version_id (str) – The value to assign to the kms_key_version_id property of this PluggableDatabase.
refreshable_clone_config (oci.database.models.PluggableDatabaseRefreshableCloneConfig) – The value to assign to the refreshable_clone_config property of this PluggableDatabase.
pdb_node_level_details (list[oci.database.models.PluggableDatabaseNodeLevelDetails]) – The value to assign to the pdb_node_level_details property of this PluggableDatabase.
patch_version (str) – The value to assign to the patch_version property of this PluggableDatabase.
data_safe_state (str) – The value to assign to the data_safe_state property of this PluggableDatabase. Allowed values for this property are: “ENABLED”, “DISABLED”, “FAILED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

property compartment_id¶

[Required] Gets the compartment_id of this PluggableDatabase. The OCID of the compartment.

Returns: The compartment_id of this PluggableDatabase.
Return type: str

property connection_strings¶

Gets the connection_strings of this PluggableDatabase.

Returns: The connection_strings of this PluggableDatabase.
Return type: oci.database.models.PluggableDatabaseConnectionStrings

property container_database_id¶

[Required] Gets the container_database_id of this PluggableDatabase. The OCID of the CDB.

Returns: The container_database_id of this PluggableDatabase.
Return type: str

property data_safe_state¶

Gets the data_safe_state of this PluggableDatabase. The Data Safe status of the pluggable database.

Allowed values for this property are: “ENABLED”, “DISABLED”, “FAILED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns: The data_safe_state of this PluggableDatabase.
Return type: str

property defined_tags¶

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

Returns: The defined_tags of this PluggableDatabase.
Return type: dict(str, dict(str, object))

property freeform_tags¶

Gets the freeform_tags of this PluggableDatabase. 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: {“Department”: “Finance”}

Returns: The freeform_tags of this PluggableDatabase.
Return type: dict(str, str)

property id¶

[Required] Gets the id of this PluggableDatabase. The OCID of the pluggable database.

Returns: The id of this PluggableDatabase.
Return type: str

property is_restricted¶

Gets the is_restricted of this PluggableDatabase. 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.

Returns: The is_restricted of this PluggableDatabase.
Return type: bool

property kms_key_id¶

Gets the kms_key_id of this PluggableDatabase. The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.

Returns: The kms_key_id of this PluggableDatabase.
Return type: str

property kms_key_version_id¶

Gets the kms_key_version_id of this PluggableDatabase. The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions. If none is specified, the current key version (latest) of the Key Id is used for the operation. Autonomous AI Database Serverless does not use key versions, hence is not applicable for Autonomous AI Database Serverless instances.

Returns: The kms_key_version_id of this PluggableDatabase.
Return type: str

property lifecycle_details¶

Gets the lifecycle_details of this PluggableDatabase. Detailed message for the lifecycle state.

Returns: The lifecycle_details of this PluggableDatabase.
Return type: str

property lifecycle_state¶

[Required] Gets the lifecycle_state of this PluggableDatabase. The current state of the pluggable database.

Allowed values for this property are: “PROVISIONING”, “AVAILABLE”, “TERMINATING”, “TERMINATED”, “UPDATING”, “FAILED”, “RELOCATING”, “RELOCATED”, “REFRESHING”, “RESTORE_IN_PROGRESS”, “RESTORE_FAILED”, “BACKUP_IN_PROGRESS”, “DISABLED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns: The lifecycle_state of this PluggableDatabase.
Return type: str

property open_mode¶

[Required] Gets the open_mode of this PluggableDatabase. Deprecated. Use pluggable_database_node_level_details() 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).

Allowed values for this property are: “READ_ONLY”, “READ_WRITE”, “MOUNTED”, “MIGRATE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns: The open_mode of this PluggableDatabase.
Return type: str

property patch_version¶

Gets the patch_version of this PluggableDatabase. The patch version of the pluggable database.

Returns: The patch_version of this PluggableDatabase.
Return type: str

property pdb_name¶

[Required] Gets the pdb_name of this PluggableDatabase. 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.

Returns: The pdb_name of this PluggableDatabase.
Return type: str

property pdb_node_level_details¶

Gets the pdb_node_level_details of this PluggableDatabase. Pluggable Database Node Level Details. Example: [{“nodeName” : “node1”, “openMode” : “READ_WRITE”}, {“nodeName” : “node2”, “openMode” : “READ_ONLY”}]

Returns: The pdb_node_level_details of this PluggableDatabase.
Return type: list[oci.database.models.PluggableDatabaseNodeLevelDetails]

property pluggable_database_management_config¶

Gets the pluggable_database_management_config of this PluggableDatabase.

Returns: The pluggable_database_management_config of this PluggableDatabase.
Return type: oci.database.models.PluggableDatabaseManagementConfig

property refreshable_clone_config¶

Gets the refreshable_clone_config of this PluggableDatabase.

Returns: The refreshable_clone_config of this PluggableDatabase.
Return type: oci.database.models.PluggableDatabaseRefreshableCloneConfig

property system_tags¶

Gets the system_tags of this PluggableDatabase. System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

Returns: The system_tags of this PluggableDatabase.
Return type: dict(str, dict(str, object))

property time_created¶

[Required] Gets the time_created of this PluggableDatabase. The date and time the pluggable database was created.

Returns: The time_created of this PluggableDatabase.
Return type: datetime