MySQL Replicas Functions

CREATE_REPLICA Function

Creates a DB System read replica.

Syntax

FUNCTION create_replica (
  create_replica_details dbms_cloud_oci_mysql_create_replica_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_replicas_create_replica_response_t;

Parameters

Parameter	Description
`create_replica_details`	(required) The parameters of the request to create the read replica.
`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_REPLICA Function

Deletes the specified read replica.

Syntax

FUNCTION delete_replica (
  replica_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_replicas_delete_replica_response_t;

Parameters

Parameter	Description
`replica_id`	(required) The Replica OCID.
`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_REPLICA Function

Gets the full details of the specified read replica.

Syntax

FUNCTION get_replica (
  replica_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_replicas_get_replica_response_t;

Parameters

Parameter	Description
`replica_id`	(required) The Replica 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.
`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_REPLICAS Function

Lists all the read replicas that match the specified filters.

Syntax

FUNCTION list_replicas (
  compartment_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  display_name varchar2 DEFAULT NULL,
  db_system_id varchar2 DEFAULT NULL,
  lifecycle_state varchar2 DEFAULT NULL,
  replica_id varchar2 DEFAULT NULL,
  configuration_id varchar2 DEFAULT NULL,
  is_up_to_date number DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ms_replicas_list_replicas_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.
`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.
`display_name`	(optional) A filter to return only the resource matching the given display name exactly.
`db_system_id`	(optional) The DB System OCID.
`lifecycle_state`	(optional) The LifecycleState of the read replica.
`replica_id`	(optional) The read replica OCID.
`configuration_id`	(optional) The requested Configuration instance.
`is_up_to_date`	(optional) Filter instances if they are using the latest revision of the Configuration they are associated with.
`sort_by`	(optional) The field to sort by. You can sort by one field only. By default, the Time field is sorted in descending order and the Display Name field in ascending order. Allowed values are: 'timeCreated', 'displayName'
`sort_order`	(optional) The sort order to use (ASC or DESC). Allowed values are: 'ASC', 'DESC'
`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_REPLICA Function

Updates the properties of the specified read replica.

Syntax

FUNCTION update_replica (
  replica_id varchar2,
  update_replica_details dbms_cloud_oci_mysql_update_replica_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_replicas_update_replica_response_t;

Parameters

Parameter	Description
`replica_id`	(required) The Replica OCID.
`update_replica_details`	(required) The parameters of the request to update the read replica.
`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 Try Free Tier

CREATE_REPLICA Function 🔗

DELETE_REPLICA Function 🔗

GET_REPLICA Function 🔗

LIST_REPLICAS Function 🔗

UPDATE_REPLICA Function 🔗

Oracle Cloud Infrastructure Documentation
Try Free Tier

CREATE_REPLICA Function

DELETE_REPLICA Function

GET_REPLICA Function

LIST_REPLICAS Function

UPDATE_REPLICA Function