database_upgrade_history_entries

Creates, updates, deletes, gets or lists a database_upgrade_history_entries resource.

Overview

Name	database_upgrade_history_entries
Type	Resource
Id	oci.database.database_upgrade_history_entries

Fields

The following fields are returned by SELECT queries:

get

The database upgrade history.

Name	Datatype	Description
id	string	The [OCID](/Content/General/Concepts/identifiers.htm) of the database upgrade history.
action	string	The database upgrade action. (PRECHECK, UPGRADE, ROLLBACK)
lifecycleDetails	string	Additional information about the current lifecycle state.
lifecycleState	string	Status of database upgrade history SUCCEEDED|IN_PROGRESS|FAILED. (SUCCEEDED, FAILED, IN_PROGRESS)
options	string	Additional upgrade options supported by DBUA(Database Upgrade Assistant). Example: "-upgradeTimezone false -keepEvents"
source	string	The source of the Oracle Database software to be used for the upgrade. - Use DB_HOME to specify an existing Database Home to upgrade the database. The database is moved to the target Database Home and makes use of the Oracle Database software version of the target Database Home. - Use DB_VERSION to specify a generally-available Oracle Database software version to upgrade the database. - Use DB_SOFTWARE_IMAGE to specify a [database software image](/iaas/Content/Database/Concepts/databasesoftwareimage.htm) to upgrade the database. (DB_HOME, DB_VERSION, DB_SOFTWARE_IMAGE)
sourceDbHomeId	string	The [OCID](/Content/General/Concepts/identifiers.htm) of the Database Home.
targetDBVersion	string	A valid Oracle Database version. For a list of supported versions, use the ListDbVersions operation. This cannot be updated in parallel with any of the following: licenseModel, dbEdition, cpuCoreCount, computeCount, computeModel, adminPassword, whitelistedIps, isMTLSConnectionRequired, openMode, permissionLevel, dbWorkload, privateEndpointLabel, nsgIds, isRefreshable, dbName, scheduledOperations, dbToolsDetails, isLocalDataGuardEnabled, or isFreeTier.
targetDatabaseSoftwareImageId	string	the database software image used for upgrading database.
targetDbHomeId	string	The [OCID](/Content/General/Concepts/identifiers.htm) of the Database Home.
timeEnded	string (date-time)	The date and time when the database upgrade ended.
timeStarted	string (date-time)	The date and time when the database upgrade started.

list

The Database service supports the upgrade history of databases.<br /><br />To use any of the API operations, you must be authorized in an IAM policy. If you are not authorized, talk to an administrator. If you are an administrator who needs to write policies to give users access, see [Getting Started with Policies](/Content/Identity/Concepts/policygetstarted.htm).<br /><br />For information about access control and compartments, see<br />[Overview of the Identity Service](/Content/Identity/Concepts/overview.htm).<br /><br />Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.<br />

Name	Datatype	Description
id	string	The [OCID](/Content/General/Concepts/identifiers.htm) of the database upgrade history.
action	string	The database upgrade action. (PRECHECK, UPGRADE, ROLLBACK)
lifecycleDetails	string	Additional information about the current lifecycle state.
lifecycleState	string	Status of database upgrade history SUCCEEDED|IN_PROGRESS|FAILED. (SUCCEEDED, FAILED, IN_PROGRESS)
options	string	Additional upgrade options supported by DBUA(Database Upgrade Assistant). Example: "-upgradeTimezone false -keepEvents"
source	string	The source of the Oracle Database software to be used for the upgrade. - Use DB_HOME to specify an existing Database Home to upgrade the database. The database is moved to the target Database Home and makes use of the Oracle Database software version of the target Database Home. - Use DB_VERSION to specify a generally-available Oracle Database software version to upgrade the database. - Use DB_SOFTWARE_IMAGE to specify a [database software image](/iaas/Content/Database/Concepts/databasesoftwareimage.htm) to upgrade the database. (DB_HOME, DB_VERSION, DB_SOFTWARE_IMAGE)
sourceDbHomeId	string	The [OCID](/Content/General/Concepts/identifiers.htm) of the Database Home.
targetDBVersion	string	A valid Oracle Database version. For a list of supported versions, use the ListDbVersions operation. This cannot be updated in parallel with any of the following: licenseModel, dbEdition, cpuCoreCount, computeCount, computeModel, adminPassword, whitelistedIps, isMTLSConnectionRequired, openMode, permissionLevel, dbWorkload, privateEndpointLabel, nsgIds, isRefreshable, dbName, scheduledOperations, dbToolsDetails, isLocalDataGuardEnabled, or isFreeTier.
targetDatabaseSoftwareImageId	string	the database software image used for upgrading database.
targetDbHomeId	string	The [OCID](/Content/General/Concepts/identifiers.htm) of the Database Home.
timeEnded	string (date-time)	The date and time when the database upgrade ended.
timeStarted	string (date-time)	The date and time when the database upgrade started.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	databaseId, upgradeHistoryEntryId, region	opc-request-id	gets the upgrade history for a specified database.<br />
list	select	databaseId, region	upgradeAction, lifecycleState, sortBy, sortOrder, opc-request-id, limit, page	Gets the upgrade history for a specified database in a bare metal or virtual machine DB system.<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
databaseId	string	The database [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)
upgradeHistoryEntryId	string	The database/db system upgrade History [OCID](/Content/General/Concepts/identifiers.htm).
lifecycleState	string	A filter to return only upgradeHistoryEntries that match the given lifecycle state exactly.
limit	integer	The maximum number of items to return per page.
opc-request-id	string	Unique identifier for the request.
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 ascending.
sortOrder	string	The sort order to use, either ascending (ASC) or descending (DESC).
upgradeAction	string	A filter to return only upgradeHistoryEntries that match the specified Upgrade Action.

SELECT examples

get

gets the upgrade history for a specified database.<br />

SELECT
id,
action,
lifecycleDetails,
lifecycleState,
options,
source,
sourceDbHomeId,
targetDBVersion,
targetDatabaseSoftwareImageId,
targetDbHomeId,
timeEnded,
timeStarted
FROM oci.database.database_upgrade_history_entries
WHERE databaseId = '{{ databaseId }}' -- required
AND upgradeHistoryEntryId = '{{ upgradeHistoryEntryId }}' -- required
AND region = '{{ region }}' -- required
AND opc-request-id = '{{ opc-request-id }}'
;

list

Gets the upgrade history for a specified database in a bare metal or virtual machine DB system.<br />

SELECT
id,
action,
lifecycleDetails,
lifecycleState,
options,
source,
sourceDbHomeId,
targetDBVersion,
targetDatabaseSoftwareImageId,
targetDbHomeId,
timeEnded,
timeStarted
FROM oci.database.database_upgrade_history_entries
WHERE databaseId = '{{ databaseId }}' -- required
AND region = '{{ region }}' -- required
AND upgradeAction = '{{ upgradeAction }}'
AND lifecycleState = '{{ lifecycleState }}'
AND sortBy = '{{ sortBy }}'
AND sortOrder = '{{ sortOrder }}'
AND opc-request-id = '{{ opc-request-id }}'
AND limit = '{{ limit }}'
AND page = '{{ page }}'
;