MySQL MySQLaaS Functions

CREATE_CONFIGURATION Function

Creates a new Configuration.

Syntax

FUNCTION create_configuration (
  create_configuration_details dbms_cloud_oci_mysql_create_configuration_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_mysqlaas_create_configuration_response_t;

Parameters

Parameter	Description
`create_configuration_details`	(required) Request to create a Configuration.
`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_CONFIGURATION Function

Deletes a Configuration. The Configuration must not be in use by any DB Systems.

Syntax

FUNCTION delete_configuration (
  configuration_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_mysqlaas_delete_configuration_response_t;

Parameters

Parameter	Description
`configuration_id`	(required) The OCID of the Configuration.
`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_CONFIGURATION Function

Get the full details of the specified Configuration, including the list of MySQL Variables and their values.

Syntax

FUNCTION get_configuration (
  configuration_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_mysqlaas_get_configuration_response_t;

Parameters

Parameter	Description
`configuration_id`	(required) The OCID of the Configuration.
`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_CONFIGURATIONS Function

Lists the Configurations available when creating a DB System. This may include DEFAULT configurations per Shape and CUSTOM configurations. The default sort order is a multi-part sort by: - shapeName, ascending - DEFAULT-before-CUSTOM - displayName ascending

Syntax

FUNCTION list_configurations (
  compartment_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  configuration_id varchar2 DEFAULT NULL,
  lifecycle_state varchar2 DEFAULT NULL,
  l_type dbms_cloud_oci_mysql_varchar2_tbl DEFAULT NULL,
  display_name varchar2 DEFAULT NULL,
  shape_name 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_mysqlaas_list_configurations_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.
`configuration_id`	(optional) The requested Configuration instance.
`lifecycle_state`	(optional) Configuration Lifecycle State
`l_type`	(optional) The requested Configuration types. Allowed values are: 'DEFAULT', 'CUSTOM'
`display_name`	(optional) A filter to return only the resource matching the given display name exactly.
`shape_name`	(optional) The requested Shape name.
`sort_by`	(optional) The field to sort by. Only one sort order may be provided. Time fields are default ordered as descending. Display name is default ordered as ascending. Allowed values are: 'displayName', 'shapeName', 'timeCreated', 'timeUpdated'
`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.

LIST_SHAPES Function

Gets a list of the shapes you can use to create a new MySQL DB System. The shape determines the resources allocated to the DB System: CPU cores and memory for VM shapes; CPU cores, memory and storage for non-VM (or bare metal) shapes.

Syntax

FUNCTION list_shapes (
  compartment_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  is_supported_for dbms_cloud_oci_mysql_varchar2_tbl DEFAULT NULL,
  availability_domain varchar2 DEFAULT NULL,
  name varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ms_mysqlaas_list_shapes_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.
`is_supported_for`	(optional) Return shapes that are supported by the service feature. Allowed values are: 'DBSYSTEM', 'HEATWAVECLUSTER'
`availability_domain`	(optional) The name of the Availability Domain.
`name`	(optional) Name
`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_VERSIONS Function

Get a list of supported and available MySQL database major versions. The list is sorted by version family.

Syntax

FUNCTION list_versions (
  compartment_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ms_mysqlaas_list_versions_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.
`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_CONFIGURATION Function

Updates the Configuration details.

Syntax

FUNCTION update_configuration (
  configuration_id varchar2,
  update_configuration_details dbms_cloud_oci_mysql_update_configuration_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_mysqlaas_update_configuration_response_t;

Parameters

Parameter	Description
`configuration_id`	(required) The OCID of the Configuration.
`update_configuration_details`	(required) Request to update a Configuration.
`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_CONFIGURATION Function 🔗

DELETE_CONFIGURATION Function 🔗

GET_CONFIGURATION Function 🔗

LIST_CONFIGURATIONS Function 🔗

LIST_SHAPES Function 🔗

LIST_VERSIONS Function 🔗

UPDATE_CONFIGURATION Function 🔗

Oracle Cloud Infrastructure Documentation
Try Free Tier

CREATE_CONFIGURATION Function

DELETE_CONFIGURATION Function

GET_CONFIGURATION Function

LIST_CONFIGURATIONS Function

LIST_SHAPES Function

LIST_VERSIONS Function

UPDATE_CONFIGURATION Function