MySQL DB Backups Functions

Package: DBMS_CLOUD_OCI_MS_DB_BACKUPS

CHANGE_BACKUP_COMPARTMENT Function

Moves a DB System Backup into a different compartment. When provided, If-Match is checked against ETag values of the Backup.

Syntax

FUNCTION change_backup_compartment (
  backup_id varchar2,
  change_backup_compartment_details dbms_cloud_oci_mysql_change_backup_compartment_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ms_db_backups_change_backup_compartment_response_t;

Parameters

Parameter	Description
`backup_id`	(required) The OCID of the Backup
`change_backup_compartment_details`	(required) Target compartment for a DB System Backup.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `If-Match` header to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) Customer-defined unique identifier for the request. If you need to contact Oracle about a specific request, please provide the request ID that you supplied in this header with the request.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://mysql.{region}.ocp.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CREATE_BACKUP Function

Create a backup of a DB System.

Syntax

FUNCTION create_backup (
  create_backup_details dbms_cloud_oci_mysql_create_backup_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ms_db_backups_create_backup_response_t;

Parameters

Parameter	Description
`create_backup_details`	(required) Create a Backup of a DB System.
`opc_request_id`	(optional) Customer-defined unique identifier for the request. If you need to contact Oracle about a specific request, please provide the request ID that you supplied in this header with the request.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://mysql.{region}.ocp.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

DELETE_BACKUP Function

Delete a Backup.

Syntax

FUNCTION delete_backup (
  backup_id varchar2,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ms_db_backups_delete_backup_response_t;

Parameters

Parameter	Description
`backup_id`	(required) The OCID of the Backup
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `If-Match` header to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) Customer-defined unique identifier for the request. If you need to contact Oracle about a specific request, please provide the request ID that you supplied in this header with the request.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://mysql.{region}.ocp.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_BACKUP Function

Get information about the specified Backup

Syntax

FUNCTION get_backup (
  backup_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  if_none_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ms_db_backups_get_backup_response_t;

Parameters

Parameter	Description
`backup_id`	(required) The OCID of the Backup
`opc_request_id`	(optional) Customer-defined unique identifier for the request. If you need to contact Oracle about a specific request, please provide the request ID that you supplied in this header with the request.
`if_none_match`	(optional) For conditional requests. In the GET call for a resource, set the `If-None-Match` header to the value of the ETag from a previous GET (or POST or PUT) response for that resource. The server will return with either a 304 Not Modified response if the resource has not changed, or a 200 OK response with the updated representation.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://mysql.{region}.ocp.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_BACKUPS Function

Get a list of DB System backups.

Syntax

FUNCTION list_backups (
  compartment_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  backup_id varchar2 DEFAULT NULL,
  lifecycle_state varchar2 DEFAULT NULL,
  db_system_id varchar2 DEFAULT NULL,
  display_name varchar2 DEFAULT NULL,
  creation_type varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ms_db_backups_list_backups_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) The compartment OCID.
`opc_request_id`	(optional) Customer-defined unique identifier for the request. If you need to contact Oracle about a specific request, please provide the request ID that you supplied in this header with the request.
`backup_id`	(optional) Backup OCID
`lifecycle_state`	(optional) Backup Lifecycle State
`db_system_id`	(optional) The DB System OCID.
`display_name`	(optional) A filter to return only the resource matching the given display name exactly.
`creation_type`	(optional) Backup creationType
`sort_by`	(optional) The field to sort by. Only one sort order may be provided. Time fields are default ordered as descending. Allowed values are: 'timeCreated', 'timeUpdated', 'displayName'
`sort_order`	(optional) The sort order to use (ASC or DESC). Allowed values are: 'ASC', 'DESC'
`limit`	(optional) The maximum number of items to return in a paginated list call. For information about pagination, see List Pagination.
`page`	(optional) The value of the `opc-next-page` or `opc-prev-page` response header from the previous list call. For information about pagination, see List Pagination.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://mysql.{region}.ocp.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

UPDATE_BACKUP Function

Update the metadata of a Backup. Metadata such as the displayName or description

Syntax

FUNCTION update_backup (
  backup_id varchar2,
  update_backup_details dbms_cloud_oci_mysql_update_backup_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ms_db_backups_update_backup_response_t;

Parameters

Parameter	Description
`backup_id`	(required) The OCID of the Backup
`update_backup_details`	(required) Request to update a Backup's metadata.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `If-Match` header to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) Customer-defined unique identifier for the request. If you need to contact Oracle about a specific request, please provide the request ID that you supplied in this header with the request.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://mysql.{region}.ocp.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

Oracle Cloud Infrastructure Documentation

CHANGE_BACKUP_COMPARTMENT Function

CREATE_BACKUP Function

DELETE_BACKUP Function

GET_BACKUP Function

LIST_BACKUPS Function

UPDATE_BACKUP Function