Database

class oci.database.models.Database(**kwargs)

Bases: object

Database model.

LIFECYCLE_STATE_AVAILABLE = 'AVAILABLE'

A constant which can be used with the lifecycle_state property of a Database. 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 Database. This constant has a value of "BACKUP_IN_PROGRESS"

LIFECYCLE_STATE_FAILED = 'FAILED'

A constant which can be used with the lifecycle_state property of a Database. This constant has a value of "FAILED"

LIFECYCLE_STATE_PROVISIONING = 'PROVISIONING'

A constant which can be used with the lifecycle_state property of a Database. This constant has a value of "PROVISIONING"

LIFECYCLE_STATE_RESTORE_FAILED = 'RESTORE_FAILED'

A constant which can be used with the lifecycle_state property of a Database. This constant has a value of "RESTORE_FAILED"

LIFECYCLE_STATE_TERMINATED = 'TERMINATED'

A constant which can be used with the lifecycle_state property of a Database. This constant has a value of "TERMINATED"

LIFECYCLE_STATE_TERMINATING = 'TERMINATING'

A constant which can be used with the lifecycle_state property of a Database. This constant has a value of "TERMINATING"

LIFECYCLE_STATE_UPDATING = 'UPDATING'

A constant which can be used with the lifecycle_state property of a Database. This constant has a value of "UPDATING"

__init__(**kwargs)

Initializes a new Database 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 Database.
  • compartment_id (str) -- The value to assign to the compartment_id property of this Database.
  • character_set (str) -- The value to assign to the character_set property of this Database.
  • ncharacter_set (str) -- The value to assign to the ncharacter_set property of this Database.
  • db_home_id (str) -- The value to assign to the db_home_id property of this Database.
  • db_name (str) -- The value to assign to the db_name property of this Database.
  • pdb_name (str) -- The value to assign to the pdb_name property of this Database.
  • db_workload (str) -- The value to assign to the db_workload property of this Database.
  • db_unique_name (str) -- The value to assign to the db_unique_name property of this Database.
  • lifecycle_details (str) -- The value to assign to the lifecycle_details property of this Database.
  • lifecycle_state (str) -- The value to assign to the lifecycle_state property of this Database. Allowed values for this property are: "PROVISIONING", "AVAILABLE", "UPDATING", "BACKUP_IN_PROGRESS", "TERMINATING", "TERMINATED", "RESTORE_FAILED", "FAILED", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.
  • time_created (datetime) -- The value to assign to the time_created property of this Database.
  • db_backup_config (DbBackupConfig) -- The value to assign to the db_backup_config property of this Database.
  • freeform_tags (dict(str, str)) -- The value to assign to the freeform_tags property of this Database.
  • defined_tags (dict(str, dict(str, object))) -- The value to assign to the defined_tags property of this Database.
  • connection_strings (DatabaseConnectionStrings) -- The value to assign to the connection_strings property of this Database.
character_set

Gets the character_set of this Database. The character set for the database.

Returns:The character_set of this Database.
Return type:str
compartment_id

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

Returns:The compartment_id of this Database.
Return type:str
connection_strings

Gets the connection_strings of this Database. The Connection strings used to connect to the Oracle Database.

Returns:The connection_strings of this Database.
Return type:DatabaseConnectionStrings
db_backup_config

Gets the db_backup_config of this Database.

Returns:The db_backup_config of this Database.
Return type:DbBackupConfig
db_home_id

Gets the db_home_id of this Database. The OCID of the database home.

Returns:The db_home_id of this Database.
Return type:str
db_name

[Required] Gets the db_name of this Database. The database name.

Returns:The db_name of this Database.
Return type:str
db_unique_name

[Required] Gets the db_unique_name of this Database. A system-generated name for the database to ensure uniqueness within an Oracle Data Guard group (a primary database and its standby databases). The unique name cannot be changed.

Returns:The db_unique_name of this Database.
Return type:str
db_workload

Gets the db_workload of this Database. The database workload type.

Returns:The db_workload of this Database.
Return type:str
defined_tags

Gets the defined_tags of this Database. 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 Database.
Return type:dict(str, dict(str, object))
freeform_tags

Gets the freeform_tags of this Database. 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 Database.
Return type:dict(str, str)
id

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

Returns:The id of this Database.
Return type:str
lifecycle_details

Gets the lifecycle_details of this Database. Additional information about the current lifecycleState.

Returns:The lifecycle_details of this Database.
Return type:str
lifecycle_state

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

Allowed values for this property are: "PROVISIONING", "AVAILABLE", "UPDATING", "BACKUP_IN_PROGRESS", "TERMINATING", "TERMINATED", "RESTORE_FAILED", "FAILED", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.

Returns:The lifecycle_state of this Database.
Return type:str
ncharacter_set

Gets the ncharacter_set of this Database. The national character set for the database.

Returns:The ncharacter_set of this Database.
Return type:str
pdb_name

Gets the pdb_name of this Database. The name of the pluggable database. The name must begin with an alphabetic character and can contain a maximum of eight alphanumeric characters. Special characters are not permitted. Pluggable database should not be same as database name.

Returns:The pdb_name of this Database.
Return type:str
time_created

Gets the time_created of this Database. The date and time the database was created.

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