Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace DatabaseSummary

An Oracle Database on a bare metal or virtual machine DB system. For more information, see Bare Metal and Virtual Machine DB Systems.

To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see [Getting Started with Policies](https://docs.cloud.oracle.com/Content/Identity/Concepts/policygetstarted.htm).

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

Properties

Optional characterSet

characterSet: undefined | string

The character set for the database.

compartmentId

compartmentId: string

The OCID of the compartment.

Optional connectionStrings

connectionStrings: model.DatabaseConnectionStrings

The Connection strings used to connect to the Oracle Database.

Optional databaseManagementConfig

databaseManagementConfig: model.CloudDatabaseManagementConfig

Optional databaseSoftwareImageId

databaseSoftwareImageId: undefined | string

The database software image OCID

Optional dbBackupConfig

dbBackupConfig: model.DbBackupConfig

Optional dbHomeId

dbHomeId: undefined | string

The OCID of the Database Home.

dbName

dbName: string

The database name.

Optional dbSystemId

dbSystemId: undefined | string

The OCID of the DB system.

dbUniqueName

dbUniqueName: string

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.

Optional dbWorkload

dbWorkload: undefined | string

Deprecated. The dbWorkload field has been deprecated for Exadata Database Service on Dedicated Infrastructure, Exadata Database Service on Cloud@Customer, and Base Database Service. Support for this attribute will end in November 2023. You may choose to update your custom scripts to exclude the dbWorkload attribute. After November 2023 if you pass a value to the dbWorkload attribute, it will be ignored.

The database workload type.

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 database.

Optional isCdb

isCdb: undefined | false | true

True if the database is a container database.

Optional keyStoreId

keyStoreId: undefined | string

The OCID of the key store of Oracle Vault.

Optional keyStoreWalletName

keyStoreWalletName: undefined | string

The wallet name for Oracle Key Vault.

Optional kmsKeyId

kmsKeyId: undefined | string

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

Optional kmsKeyVersionId

kmsKeyVersionId: undefined | string

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 Database Serverless does not use key versions, hence is not applicable for Autonomous Database Serverless instances.

Optional lastBackupDurationInSeconds

lastBackupDurationInSeconds: undefined | number

The duration when the latest database backup created. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional lastBackupTimestamp

lastBackupTimestamp: Date

The date and time when the latest database backup was created.

Optional lastFailedBackupTimestamp

lastFailedBackupTimestamp: Date

The date and time when the latest database backup failed.

Optional lifecycleDetails

lifecycleDetails: undefined | string

Additional information about the current lifecycle state.

lifecycleState

lifecycleState: LifecycleState

The current state of the database.

Optional ncharacterSet

ncharacterSet: undefined | string

The national character set for the database.

Optional pdbName

pdbName: undefined | string

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

Optional sidPrefix

sidPrefix: undefined | string

Specifies a prefix for the {@code Oracle SID} of the database to be created.

Optional sourceDatabasePointInTimeRecoveryTimestamp

sourceDatabasePointInTimeRecoveryTimestamp: Date

Point in time recovery timeStamp of the source database at which cloned database system is cloned from the source database system, as described in RFC 3339

Optional timeCreated

timeCreated: Date

The date and time the database was created.

Optional vaultId

vaultId: undefined | string

The OCID of the Oracle Cloud Infrastructure vault. This parameter and {@code secretId} are required for Customer Managed Keys.

Optional vmClusterId

vmClusterId: undefined | string

The OCID of the VM cluster.

Functions

getDeserializedJsonObj

getJsonObj