Managing a DB System

Checking the DB System State Using the Console

Use the Console to check the state of a MySQL DB system.

  1. Open the navigation menu, and select Databases. Under MySQL, click DB Systems.
  2. Choose your compartment from the List Scope.
  3. In the list of DB systems, find your DB system, and check the icon in the DB System State column. The color of the icon and the associated text indicate the status of the DB system. See DB System States.

DB System States

Check the icon in the DB System State column to view the state of your DB system.

Table 8-1 DB System States

Icon DB System State Description
Grey Inactive The DB system is powered off by the stop or reboot action in the Console or API.
Note

The automatic backup schedule continues to backup your DB system even when it is in an inactive state. Also, you can create a manual backup of an inactive DB system.
Red Deleted The DB system is deleted and is no longer available.
Failed An error condition prevented the creation or continued operation of the DB system.
Yellow Creating The DB system is reserving resources, booting, and creating the initial database. Provisioning can take several minutes. You cannot use the system yet.
Updating The DB system is starting, stopping, restarting, or updating a replication channel associated with the DB system.
Deleting The DB system is being deleted by the terminate action in the Console or API.
Green Active The DB system is successfully created.

Starting, Stopping, or Restarting a DB System Using the Console

Use the Console to start, stop, or restart a DB system.

  1. Open the navigation menu, and select Databases. Under MySQL, click DB Systems.
  2. Choose your compartment from the List Scope.
  3. In the list of DB systems, find the DB system you want to start, stop, or restart, and do one of the following:
    • Choose the DB system by selecting the check box. Click the Actions button at the top of the page.
    • Click the Actions menu present on the same line as your DB system.
    • Click the name of the DB system to open the DB System Details page.
  4. Click one of the following:
    • Start: Start a stopped DB system. After the DB system is started, the Stop action is enabled, and the Start option is disabled.
    • Stop: Stop a running DB system. After the DB system is powered off, the Start action is enabled.
    • Restart: Shut down a DB system, and restart it.
      Note

      Starting, stopping, or restarting a  DB system affects the attached HeatWave cluster. When a HeatWave cluster is stopped as a result of a stop or restart action on the DB system, the data loaded in the HeatWave cluster is lost and must be reloaded manually when the HeatWave cluster is restarted. The HeatWave recovery mechanism does not automatically reload data.
  5. If you click Stop or Restart, the Stop (or Restart) DB System dialog box is displayed. Select one of the following shutdown types:
    • Fast: Flush dirty pages before shutting down the DB System. The DB system performs some flush operation during the next startup, increasing the duration of the startup.
    • Slow: Flush dirty pages and purge undo log pages for older transactions. The shutdown itself can take longer, but the subsequent startup is faster.
    • Immediate: Does not flush dirty pages and does not purge any undo log pages. It stops MySQL DB System immediately. Page flushing and log purging happen during the next startup, increasing the duration of the startup.
  6. Click the Stop or Restart button, depending on the intended action.

Editing a DB System Using the Console

Use the Console to edit your MySQL DB system.

  1. Open the navigation menu, and select Databases. Under MySQL, click DB Systems.
  2. Choose your compartment from the List Scope.
  3. In the list of DB systems, find the DB system you want to edit and do one of the following:
    • Click the name of the DB system to open the DB System Details page.
    • Click the Actions menu present on the same line as your DB system.
    The Edit DB System is displayed.
  4. Click Edit.
  5. In the Edit DB System panel, edit the following information:
    • Name: Specify a user-friendly display name for the DB system. The name need not be unique as the Oracle Cloud Identifier (OCID) uniquely identifies the DB system.
    • Description: Specify a brief description of the DB system and its purpose.
    • Select a Shape: Click Change Shape to change the shape of the DB system.
      Note

      Changing the shape restarts the database.
    • Select a Configuration: Click Change Configuration to change the configuration of the DB system. You can see the difference in the variables of the existing and the selected configuration under Compare configurations.
    • Show advanced options: Click the option to view the advanced options such as Deletion Plan, Configuration, Management, and Tags.
  6. (Optional) Select the Navigate to the DB System details page after closing the dialog check box to open the DB System Details page after closing the Edit DB System dialog box. If you do not select the check box, you return to the list of the DB systems.
    Note

    The Navigate to the DB System details page after closing the dialog check box is available only if you choose Edit from the Actions menu.
  7. Click Save Changes.
    Note

    The DB system restarts only when you select a new configuration and not when you edit the Name or Description.

Deleting a DB System Using the Console

Use the Console to delete a DB system permanently.

  1. Open the navigation menu, and select Databases. Under MySQL, click DB Systems.
  2. Choose your compartment from the List Scope.
  3. (Optional) If you have enabled Delete Protected on your DB system, click the name of the DB system to open the DB System Details page. Under Deletion Plan, click Disable present in front of the Delete Protected field.
  4. In the list of DB systems, find the DB system you want to delete, and do one of the following:
    • Choose the DB system by selecting the check box, and click the Actions button at the top of the page.
    • Click the Actions menu present on the same line as your DB system.
    • Click the name of the DB system to open the DB System Details page, ánd click the More Actions button present at the top of the page.
  5. Click Delete.
  6. In the Delete DB Systems dialog box, select the Delete DB Systems permanently check box, and click Delete DB Systems.
  • Deleting a DB system permanently deletes the automatic backups associated with it. However, if you have selected Retains automatic backups in the Deletion Plan tab, your automatic backups are retained.
  • Your manual backups are retained for the defined retention period.
  • If you have selected Require final backup in the Deletion Plan tab, a final backup is created before deleting the DB system.

Checking and Increasing DB System Storage

MySQL Database Service tracks storage space utilization for a DB system and can warn you if there is a shortage of space on the disk. If you see these warnings, or know your storage needs will soon increase, take action to increase the storage space.

MySQL Health Monitor automatically sends warning messages if the free disk space for a DB system falls below 20%, 10%, and 5% of the available storage. If the DB system spends too long with too little free disk space or falls below its critical threshold, Health Monitor puts the MySQL server into a read-only fallback mode, which requires a reset. See Overview of Health Monitor.

You can also set up a custom alarm using the MySQL Database Service metric DbVolumeUtilization. The alarm sends a notification when disk space utilization reaches the level you set. See MySQL Database Service Metrics.

You can check the amount of disk space that is currently in use by these methods:

You can increase the amount of storage available to the DB system by these methods:

Increasing the Storage of a DB System Using the Console

You can increase storage using the Update Storage Size console action for the DB system.

This task requires the following:

You can increase the storage size of DB systems with initial storage of 400 GB or less to 32 TB, and DB systems with initial storage greater than 400 GB to 64 TB.

Do the following to increase the storage of a DB system:

  1. Open the navigation menu, and select Databases, and under MySQL select DB Systems.
  2. Do one of the following:
    • Click the Actions menu present on the same line as your DB system, and click Update Storage Size.
    • Click the name of the DB system to open the DB System Details page.Click More Actions present at the top of the page, and click Update Storage Size.
    • Click the name of the DB system to open the DB System Details page. Click Edit present adjacent to Storage Size under DB System Configuration field.
  3. In the Update Storage Size dialog box, enter the required storage. You can only increase the storage size.
  4. Click Update.

Increasing the Storage of a DB System by Backup and Restore Using the Console

You can increase the storage of a DB system by creating a backup of the DB system using the Console, and restoring the backup to a new DB system with a larger storage size.

This task requires the following:
  • A running DB system.
Do the following to increase the storage of a DB system:
  1. Create a backup of the DB system. See Creating a Manual Backup Using the Console.
  2. Restore the backup to a new DB system that has a larger storage size. See Restoring From a Backup to a New DB System Using the Console.

Managing Tags Using the Console

Use the Console to manage tags on DB systems and resources.

  1. Open the navigation menu, and select Databases. Under MySQL, select the resource you want to manage.
  2. Choose your compartment from the List Scope.
  3. In the list of resources, find the resource for which you want to manage tags, and do one of the following:
    • Choose the resource by selecting the check box. Click the Actions button at the top of the page.
    • Click the Actions menu present on the same line as your resource.
    • Click the name of the resource to open the Details page. For DB systems and channels, click More Actions present at the top of the page.
  4. Click Add Tags.
  5. On the Add Tags dialog box, specify the Tag Namespace, Tag Key, and Tag Value.
  6. (Optional) If you want to add more tags, click +Another Tag.
  7. Click Add Tags.

Editing High Availability Using the Console

Use the Console to enable or disable high availability on your DB system.

Enabling High Availability on a DB System Using the Console

Use the Console to enable high availability on a standalone DB system.

This task requires the following:
  • A running standalone DB System using a compatible shape (*.VM.Standard.E3.*).
  • Primary keys exist on every table in the database. See Prerequisites.
  • Any active inbound replication channel on the DB System must be stopped for the duration of this task. See Enabling or Disabling a Channel. You cannot enable high availability while an active channel is connected to the DB system.
    Note

    This is required only if the configuration used by the DB System is not compatible with high availability. If the DB System is using a compatible configuration, it is not necessary to stop the inbound replication channel to enable high availaibility. Changing the configuration of a DB System requires a restart of the DB System.
  • Crash recovery is enabled. You cannot enable high availability on a DB System if crash recovery is disabled. See Crash Recovery.
  • MySQL version must be 8.0.24 or higher. You cannot enable high availability on earlier versions of MySQL. If your DB System uses a version older than 8.0.24, you must upgrade before enabling high availability.
  • If you intend to configure an inbound replication channel on this DB System, you must import your data before enabling high availability, and configure your channel after high availabilty is enabled.

See Limitations.

  1. To enable High Availability on a DB System, open the Enable High Availability dialog from one of the following locations:
    • The Enable High Availability menu item from the More Actions (3-dot) menu on the DB Systems list page
    • The Enable High Availability menu item from the More Actions drop-down menu on the DB System Details page.
    • The Enable link adjacent the High Availability label on the DB System Details page.
    The Enable High Availability dialog is displayed.
  2. Click Enable.
    If your DB System is not using a high availability-compatible configuration, you must select one from the Configuration drop-down list.
  3. Select the HA-compatible configuration and click Enable.
    The configuration is updated.
    Note

    If you select a configuration which is not high availability-compatible, the selection is accepted and your DB System is updated to use the new configuration, but the process of enabling high availability will again request that you select a compatible configuration. Ensure you select the correct configuration.
The DB System enters the UPDATING state. The selected configuration is applied to the DB System and the secondary instances are cloned from the primary instance.
Note

If the updating process fails, the DB System returns to a standalone state. Check the work request for information.

Disabling High Availability Using the Console

Use the Console to disable high availability on your DB system.

This task requies the following:
  • A running DB system with high availability enabled.
To disable high availability, do the following:
  1. Open the Disable high availability dialog from one of the following locations:
    • The Disable high availability menu item from the More Actions (3-dot) menu on the DB Systems list page
    • The Disable high availability menu item from the More Actions drop-down menu on the DB System Details page.
    • The Disable link adjacent the High Availability label on the DB System Details page.
    The Disable High Availability dialog is displayed.
  2. Click Disable.
The DB System enters the UPDATING state and high availability is disabled.
Note

The high availability-compatible configuration is retained on the DB System.

Editing Crash Recovery Using the Console

Use the Console to enable or disable crash recovery on a DB system.

This task requires the following:
  • A running DB system.
  • You have created a full backup before disabling crash recovery.
  • Automatic backups are disabled on the DB system.
  1. To disable crash recovery on a DB system, do the following:
    1. Open the Disable crash recovery dialog box from one of the following locations:
      • The Disable crash recovery menu item from the More Actions menu on the DB systems list page.
      • The Disable crash recovery menu item from the More Actions drop-down menu on the DB system Details page.
      • The Disable link adjacent the crash recovery label on the DB system Details page. This link is only displayed if automatic backups are disabled.
      The Disable crash recovery dialog is displayed.
    2. Click Disable to disable crash recovery.
      The DB system enters the UPDATING state and crash recovery is disabled.
  2. To enable crash recovery on a DB system, do the following:
    1. Open the Enable crash recovery dialog box from one of the following locations:
      • The Enable crash recovery menu item from the More Actions (3-dot) menu on the DB systems list page.
      • The Enable crash recovery menu item from the More Actions drop-down menu on the DB system Details page.
      • The Enable link adjacent the crash recovery label on the DB system Details page.
      The Enable crash recovery dialog is displayed.
    2. Click Enable to enable crash recovery.
      The DB system enters the UPDATING state and crash recovery is enabled.
      Note

      Automatic backups are not automatically enabled. You must enable them manually.

Retrieving DB System Details Using the CLI

Use the command-line interface to view the details of a DB system.

This task requires the following:
  • A DB system Oracle Cloud Identifier (OCID).
  • A properly configured CLI installation and the requisite SSH keys. See Command Line Interface.
  1. Open a command prompt and run the following command:
    oci mysql db-system get --db-system-id <DBSystemOCID>
If the oci mysql db-system get command validates and runs successfully, you get a response similar to the following, which retreives your DB system details:
{
  "data": {
    "availability-domain": "fblN:US-ASHBURN-AD-2",
    "backup-policy": {
      "is-enabled": true,
      "retention-in-days": 7,
      "window-start-time": "00:00",
      "pitr-policy": {   
        "is-enabled": true
      },
    "compartment-id": "ocid1.compartment.oc1...<AlphaNumericString>",
    "configuration-id": "ocid1.mysqlconfiguration.oc1...<AlphaNumericString>",
    "data-storage-size-in-gbs": 50,
    "defined-tags": {
      "Oracle-Tags": {
        "CreatedBy": "userName",
        "CreatedOn": "2020-06-24T16:20:02.957Z"
      }
    },
    "description": "This is my DBSystem",
    "display-name": "MyDBSystem",
    "endpoints": [
      {
        "hostname": null,
        "ip-address": "10.0.1.15",
        "modes": [
          "READ",
          "WRITE"
        ],
        "port": 3306,
        "port-x": 33060,
        "status": "ACTIVE",
        "status-details": null
      }
    ],
    "fault-domain": "FAULT-DOMAIN-1",
    "freeform-tags": {
      "prod": "doc"
    },
    "hostname-label": null,
    "id": "ocid1.mysqldbsystem.oc1...<AlphaNumericString>",
    "ip-address": "10.0.1.28",
    "lifecycle-details": null,
    "lifecycle-state": "ACTIVE",
    "maintenance": {
      "window-start-time": "SUNDAY 13:40"
    },
    "mysql-version": "8.0.21",
    "point-in-time-recovery-details": {  
      "time-earliest-recovery-point": "2022-06-30T05:45:01+00:00",      
      "time-latest-recovery-point": "2022-06-30T06:30:01+00:00"
    },
    "port": 3306,
    "port-x": 33060,
    "shape-name": "VM.Standard.E2.1",
    "source": null,
    "subnet-id": "ocid1.subnet.oc1.iad...<AlphaNumericString>",
    "time-created": "2020-06-24T16:20:04.683000+00:00",
    "time-updated": "2020-07-05T13:56:15.851000+00:00"
  }
}

MySQL Database Service Events

MySQL Database Service events enables you to create rules that send a notification whenever the state of a resource (such as DB system, backup, channel, configuration, and HeatWave) changes in your tenancy.

MySQL Database: Backup Event Types

MySQL Database backups emit the backup events.

Table 8-2 MySQL Database: Backup Event Types

Friendly Name Event Type
MySQL - Create Backup Begin com.oraclecloud.mysqlaas.createbackup.begin
MySQL - Create Backup End com.oraclecloud.mysqlaas.createbackup.end
MySQL - Delete Backup Begin com.oraclecloud.mysqlaas.deletebackup.begin
MySQL - Delete Backup End com.oraclecloud.mysqlaas.deletebackup.end
MySQL - Update Backup com.oraclecloud.mysqlaas.updatebackup
Backup Event Example

This is a reference event for backups.

{
  "id": "ocid1.eventschema.oc1.phx.abyhqljrbev33v3gwkdhs5amcfrmps36useiwlgm64qz4kz3wuvudocd3iyq",
  "exampleEvent": {
    "cloudEventsVersion": "0.1",
    "eventID": "3e74a48c-be5c-4002-8b3e-2196fa215528",
    "eventType": "com.oraclecloud.mysqlaas.createbackup.begin",
    "source": "Mysqlaas",
    "eventTypeVersion": "2.0",
    "eventTime": "2020-12-11T19:03:00.009Z",
    "contentType": "application/json",
    "extensions": {
      "compartmentId": "ocid1.compartment.oc1...<UniqueID>"
    },
    "data": {
      "compartmentId": "ocid1.compartment.oc1...<UniqueID>",
      "compartmentName": "my_compartment_name",
      "resourceName": "my_backup",
      "resourceId": "ocid1.mysqlbackup.oc1.iad...<UniqueID>",
      "availabilityDomain": "AD2",
      "freeFormTags": {},
      "definedTags": {},
      "additionalDetails": {
        "timeCreated": "2021-01-03T22:45:15.986Z",
        "timeUpdated": "2021-01-03T22:45:15.986Z",
        "lifecycleState": "CREATING",
        "lifecycleDetails": "details message",
        "backupType": "FULL",
        "creationType": "MANUAL",
        "dbSystemId": "ocid1.mysqldbsystem.oc1.iad...<UniqueID>"
      }
    }
  }

MySQL Database: Channel Event Types

MySQL Database channels emit the channel events.

Table 8-3 MySQL Database: Channel Event Types

Friendly Name Event Type
MySQL - Create Channel Begin com.oraclecloud.mysqlaas.createchannel.begin
MySQL - Create Channel End com.oraclecloud.mysqlaas.createchannel.end
MySQL - Delete Channel Begin com.oraclecloud.mysqlaas.deletechannel.begin
MySQL - Delete Channel End com.oraclecloud.mysqlaas.deletechannel.end
MySQL - Reset Channel Begin com.oraclecloud.mysqlaas.resetchannel.begin
MySQL - Reset Channel End com.oraclecloud.mysqlaas.resetchannel.end
MySQL - Resume Channel Begin com.oraclecloud.mysqlaas.resumechannel.begin
MySQL - Resume Channel End com.oraclecloud.mysqlaas.resumechannel.end
MySQL - Update Channel Begin com.oraclecloud.mysqlaas.updatechannel.begin
MySQL - Update Channel End com.oraclecloud.mysqlaas.updatechannel.end
Channel Event Example

This is a reference event for channels.

{
  "id": "ocid1.eventschema.oc1.phx.abyhqljrt6kqt63chc77x4xqtpaaaub6il5w7mjnd5mybvnt5rfc54gtaeca",
  "exampleEvent": {
    "cloudEventsVersion": "0.1",
    "eventID": "68c6cef7-2f26-4e76-b7cb-ad4ba34f97dc",
    "eventType": "com.oraclecloud.mysqlaas.createchannel.begin",
    "source": "Mysqlaas",
    "eventTypeVersion": "2.0",
    "eventTime": "2021-01-06T19:12:00.009Z",
    "contentType": "application/json",
    "extensions": {
      "compartmentId": "ocid1.compartment.oc1...<UniqueID>"
    },
    "data": {
      "compartmentId": "ocid1.compartment.oc1...<UniqueID>",
      "compartmentName": "my_compartment_name",
      "resourceName": "my_channel",
      "resourceId": "ocid1.mysqlchannel.oc1.iad...<UniqueID>",
      "availabilityDomain": "AD1",
      "freeFormTags": {},
      "definedTags": {},
      "additionalDetails": {
        "lifecycleState": "CREATING",
        "lifecycleDetails": "details message",
        "timeCreated": "2021-01-06T19:12:00.009Z",
        "timeUpdated": "2021-01-06T19:12:00.009Z",
        "isEnabled": false,
        "dbSystemId": "ocid1.mysqldbsystem.oc1.iad...<UniqueID>"
      }
    }
  }

MySQL Database: Configuration Event Types

MySQL Database configuration emit the configuration events.

Table 8-4 MySQL Database: Configuration Event Types

Friendly Name Event Type
MySQL - Create Configuration com.oraclecloud.mysqlaas.createconfiguration
MySQL - Delete Configuration com.oraclecloud.mysqlaas.deleteconfiguration
Configuration Event Example

This is a reference event for configuration.

{
  "id": "ocid1.eventschema.oc1.phx.abyhqljrhxtbyw736z5vyafba3sonhtd6jplirofn56eoikda6jpovgtd2oa",
  "exampleEvent": {
    "cloudEventsVersion": "0.1",
    "eventID": "3e74a48c-be5c-4002-8b3e-2196fa215528",
    "eventType": "com.oraclecloud.mysqlaas.createconfiguration",
    "source": "Mysqlaas",
    "eventTypeVersion": "2.0",
    "eventTime": "2020-12-11T19:03:00.009Z",
    "contentType": "application/json",
    "extensions": {
      "compartmentId": "ocid1.compartment.oc1...<UniqueID>"
    },
    "data": {
      "compartmentId": "ocid1.compartment.oc1...<UniqueID>",
      "compartmentName": "my_compartment_name",
      "resourceName": "my_configuration",
      "resourceId": "ocid1.mysqlconfiguration.oc1.iad...<UniqueID>",
      "availabilityDomain": "AD2",
      "freeFormTags": {},
      "definedTags": {},
      "additionalDetails": {
        "shapeName": "MySQL.VM.Standard.E3.1.8GB",
        "timeCreated": "2021-01-03T22:45:15.986Z",
        "timeUpdated": "2021-01-03T22:45:15.986Z",
        "lifecycleState": "ACTIVE",
        "lifecycleDetails": "details message"
      }
    }
  }

MySQL Database: DB System Event Types

MySQL Database DB systems emit the DB systems events.

Table 8-5 MySQL Database: DB System Event Types

Friendly Name Event Type
MySQL - Create DB System Begin com.oraclecloud.mysqlaas.createdbsystem.begin
MySQL - Create DB System End com.oraclecloud.mysqlaas.createdbsystem.end
MySQL - Delete DB System Begin com.oraclecloud.mysqlaas.deletedbsystem.begin
MySQL - Delete DB System End com.oraclecloud.mysqlaas.deletedbsystem.end
MySQL - Restart DB System Begin com.oraclecloud.mysqlaas.restartdbsystem.begin
MySQL - Restart DB System End com.oraclecloud.mysqlaas.restartdbsystem.end
MySQL - Start DB System Begin com.oraclecloud.mysqlaas.startdbsystem.begin
MySQL - Start DB System End com.oraclecloud.mysqlaas.startdbsystem.end
MySQL - Stop DB System Begin com.oraclecloud.mysqlaas.stopdbsystem.begin
MySQL - Stop DB System End com.oraclecloud.mysqlaas.stopdbsystem.end
MySQL - Update DB System Begin com.oraclecloud.mysqlaas.updatedbsystem.begin
MySQL - Update DB System End com.oraclecloud.mysqlaas.updatedbsystem.end
DB System Event Example

This is a reference event for DB systems.

{
  "id": "ocid1.eventschema.oc1.phx.abyhqljrxqkzl5e7oxhcpirxvtfkjczhgjxi7b7fb36r2clncm5nkrmhvcqq",
  "exampleEvent": {
    "cloudEventsVersion": "0.1",
    "eventID": "3e74a48c-be5c-4002-8b3e-2196fa215528",
    "eventType": "com.oraclecloud.mysqlaas.createdbsystem.begin",
    "source": "Mysqlaas",
    "eventTypeVersion": "2.0",
    "eventTime": "2020-12-11T19:03:00.009Z",
    "contentType": "application/json",
    "extensions": {
      "compartmentId": "ocid1.compartment.oc1...<UniqueID>"
    },
    "data": {
      "compartmentId": "ocid1.compartment.oc1...<UniqueID>",
      "compartmentName": "my_compartment_name",
      "resourceName": "my_dbsystem",
      "resourceId": "ocid1.mysqldbsystem.oc1.iad...<UniqueID>",
      "availabilityDomain": "AD1",
      "freeFormTags": {},
      "definedTags": {},
      "additionalDetails": {
        "lifecycleState": "CREATING",
        "lifecycleDetails": "details message",
        "timeCreated": "2020-12-11T19:03:00.009Z",
        "timeUpdated": "2020-12-11T19:03:00.009Z",
        "configurationId": "ocid1.compartment.oc1...<UniqueID>",
        "shapeName": "VM.Standard.E2.1"
      }
    }
  }

MySQL Database: HeatWave Event Types

MySQL Database HeatWave clusters emit the HeatWave events.

Table 8-6 MySQL Database: HeatWave Cluster Event Types

Friendly Name Event Type
MySQL - Add HeatWave Cluster Begin com.oraclecloud.mysqlaas.addheatwavecluster.begin
MySQL - Add HeatWave Cluster End com.oraclecloud.mysqlaas.addheatwavecluster.end
MySQL - Delete HeatWave Cluster Begin com.oraclecloud.mysqlaas.deleteheatwavecluster.begin
MySQL - Delete HeatWave Cluster End com.oraclecloud.mysqlaas.deleteheatwavecluster.end
MySQL - Restart HeatWave Cluster Begin com.oraclecloud.mysqlaas.restartheatwavecluster.begin
MySQL - Restart HeatWave Cluster End com.oraclecloud.mysqlaas.restartheatwavecluster.end
MySQL - Start HeatWave Cluster Begin com.oraclecloud.mysqlaas.startheatwavecluster.begin
MySQL - Start HeatWave Cluster End com.oraclecloud.mysqlaas.startheatwavecluster.end
MySQL - Stop HeatWave Cluster Begin com.oraclecloud.mysqlaas.stopheatwavecluster.begin
MySQL - Stop HeatWave Cluster End com.oraclecloud.mysqlaas.stopheatwavecluster.end
MySQL - Update HeatWave Cluster Begin com.oraclecloud.mysqlaas.updateheatwavecluster.begin
MySQL - Update HeatWave Cluster End com.oraclecloud.mysqlaas.updateheatwavecluster.end
HeatWave Event Example

This is a reference event for HeatWave.

{
  "id": "ocid1.eventschema.oc1.phx.abyhqljrn7utc6clova6m54dwncjv22ceii2qags7no72lxk3c4qw4yrhxsa",
  "exampleEvent": {
    "cloudEventsVersion": "0.1",
    "eventID": "18718a59-6b39-4066-97e9-bb98cd8df29a",
    "eventType": "com.oraclecloud.mysqlaas.addheatwavecluster.begin",
    "source": "Mysqlaas",
    "eventTypeVersion": "2.0",
    "eventTime": "2020-12-11T19:03:00.009Z",
    "contentType": "application/json",
    "extensions": {
      "compartmentId": "ocid1.compartment.oc1...<UniqueID>"
    },
    "data": {
      "compartmentId": "ocid1.compartment.oc1...<UniqueID>",
      "compartmentName": "my_compartment_name",
      "resourceName": "my_dbsystem",
      "resourceId": "ocid1.mysqldbsystem.oc1.iad...<UniqueID>",
      "availabilityDomain": "AD1",
      "freeFormTags": {},
      "definedTags": {},
      "additionalDetails": {
        "lifecycleState": "CREATING",
        "lifecycleDetails": "details message",
        "timeCreated": "2021-01-06T22:40:00.009Z",
        "timeUpdated": "2020-12-11T19:03:00.009Z",
        "dbSystemId": "ocid1.mysqldbsystem.oc1.iad...<UniqueID>",
        "shapeName": "BM.Standard.E2.64",
        "clusterSize": 2
      }
    }
  },

DB System Details

Use the DB System Details page to see information about the DB system and the resources associated with it. You can get to this page by clicking the name of the DB system in the list of DB systems. To see the list, open the navigation menu, and select Databases, and under MySQL, click DB Systems. Choose your compartment from the List Scope.

Table 8-7 Elements of the DB System Details page

Name Description
DB System Information Summary information about this DB system and its configuration. See DB System Information.
Tags Details about the tags present on this DB system. See Managing Tags Using the Console.
Resources
  • Metrics: Measurements such as the number of connections to this DB system, and its CPU and memory utilization. See DB System Metrics.
  • Endpoints: Details of the endpoint for MySQL clients and connectors to access this DB system, and its availability status. See Endpoints.
  • HeatWave: Details of any HeatWave cluster for which this DB system is the node. See HeatWave Cluster Information.
  • Backups: The backup plan for this DB system and a list of the backups already made for it. See Backups.
  • Channels: The replication channels that are configured for this DB system. See Channels.
  • Work Requests: Activity logs for ongoing and recent operations on the DB system. Work requests are retained for 12 hours. See Work Requests.

DB System Information

Use the DB System Information section of the DB System Details page to see an overview of the DB system's configuration and resources.

Table 8-8 DB System Information

Field Description
General Information
  • OCID: The unique identifier of the DB system.
  • Description: A user-defined description of the DB system.
  • Compartment: The name of the compartment in which the DB System is created. To see the OCID of the compartment, click the compartment name.
  • Created: The date and time the DB system was created.
DB System Configuration
  • Shape: the resource template applied to the DB System.
  • OCPU Count: the number of OCPUs allocated to the DB System. For Highly Available systems, this also provides a breakdown of OCPUs used per instance.
  • Memory: amount of RAM allocated to the DB System. For Highly Available systems, this also provides a breakdown of RAM allocated per instance.
  • Storage Size: the amount of storage available to the DB System. For Highly Available systems, this also provides a breakdown of storage allocated per instance. Click Edit to open the Update Storage Size dialog box. See Increasing the Storage of a DB System Using the Console.
  • MySQL Version: the version of MySQL contained by the DB System. Click Edit to increase the amount of storage available to your DB System. See Increasing the Storage of a DB System Using the Console.
  • Configuration: the name of the MySQL configuration used in the DB System and a link to that configuration's details page.
  • Crash Recovery: whether crash recovery is enabled or disabled. See Crash Recovery.
Backup
  • Automatic Backups: Displays automatic backup status. Enabled or Disabled
  • Backup Window: Displays the time at which the automatic backup window starts.
  • Retention Days: Displays the number of days the automatic backups are retained.
  • Point In Time Restore: Displays whether the point in time restore feature is enabled or disabled.
Deletion Plan
  • Delete Protected: Displays whether delete protection is enabled or disabled on your DB system. See Deleting a DB System Using the Console.
  • Automatic Backup Retention: Displays whether the automatic backups are retained or deleted after you delete your DB system. By default, automatic backups are deleted when you delete the DB system.
  • Final backup: Displays whether a final backup is created or skipped before deleting the DB system. By default, the final backup is skipped, that is, not created.
Maintenance
  • Maintenance Window Start: the time at which the maintenance window starts. Required maintenance of the DB System, such as Operating System or MySQL Server patching or maintenance, is performed during a window which starts at this time.
HeatWave
  • HeatWave Cluster: displays HeatWave cluster status for this DB System. Enabled or Disabled. If the DB System is using the correct shape, an active link to Enable HeatWave Cluster is also displayed. This opens the Add HeatWave Cluster dialog. See Adding a HeatWave Cluster.
  • HeatWave State: displays the current state of the HeatWave Cluster; Active or Inactive.
  • HeatWave Nodes: displayed only if HeatWave is enabled. Displays the number of HeatWave nodes in the cluster.
  • HeatWave Capacity: displayed only if HeatWave is enabled. Displays the amount of storage available to the HeatWave cluster.
High Availability
  • High Availability: displays the High Availability status for this DB System. Enabled or Disabled.
  • High Availability Type: one of the following:
    • Multi-AD: the MySQL instances are placed in different availability domains.
    • Multi-FD: the MySQL instances are placed in different fault domains in a single availability domain.
Networking
  • Virtual Cloud Network: the network on which the DB System was created.
  • Subnet: the subnet to which the DB System is attached.
  • Subnet Type: the type of subnet. Regional or AD-specific.
Endpoint
  • Private IP Address: the IP address of the DB System. This address is not accessible from the internet.
  • Internal FQDN: the Fully Qualified Domain Name of your DB System. This value is populated only if you defined a hostname.
  • Availability Domain: the availability domain the DB System is in. For more information, see Regions and Availability Domains.
  • Fault Domain: the fault domain within the Availability Domain. For more information, see Fault Domains
  • Preferred Availability Domain: (High Availability only) the selected location of the primary instance. If a failover has occurred, and the MySQL instances are in different availability domains, a message is displayed here, stating that the current primary is not in the preferred location.
  • Preferred Fault Domain: (High Availability only) the selected location of the primary instance. If a failover has occurred, and the MySQL instances are in different fault domains, a message is displayed here, stating that the current primary is not in the preferred location.
  • MySQL Port: the port on which the server listens.
  • MySQL X Protocol Port: the port on which the server listens for clients using the MySQL X Protocol, such as MySQL Shell.
Inbound Replication Channel Displayed only if a channel is associated with the DB System.
  • Replication Channel: whether the channel is enabled or disabled.
  • Channel State: the lifecycle state of the channel.

Metrics

The Metrics resource on the DB System Details page shows measurements of resource utilization in the DB system, such as its CPU and memory utilization and disk activity.

Table 8-9 DB System Metrics

Field Description
Start/End Time Specify a time range for the metric display.
Quick Selects Select a predefined range.
Metric graphs For more information on the DB System metrics, see MySQL Database Service Metrics.
Filters: Metrics Data Displayed only for DB Systems with HeatWave clusters attached. Filters the metric data. The following selections are possible:
  • All: display DB System and HeatWave cluster metrics data.
  • DB System: display DB System metric data, only.
  • HeatWave: display HeatWave metric data, only.
Aggregated HeatWave Metrics Data Displays the aggregated metric data for the HeatWave cluster attached to the DB System.
  • Disabled: the data is displayed for each of the cluster's nodes. The relevant metric graphs display a line for each node.
  • Enabled: the node data is aggregated and displayed as a single line.

Endpoints

The Endpoints resource on the DB System Details page shows the details and current state of the DB system's read/write endpoint, which clients and connectors can use to connect to the MySQL instance.

Table 8-10 Endpoints Overview

Field Description
Hostname The hostname of the endpoint. This is the hostname you defined when specifying the network information in the Create DB System page. If you did not define a hostname, this field is left blank.
Status Current state:
  • CREATING: Resources are being reserved for the DB system, the system is booting, and the initial database is being created. Creating can take several minutes. The system is not ready to use yet.
  • ACTIVE: The DB system was successfully created.
  • UPDATING: The DB system is in the process of starting, stopping, or restarting.
  • INACTIVE: The DB system is powered off.
  • DELETING: The DB system is being deleted.
  • DELETED: The DB system has been deleted and is no longer available.
  • FAILED: An error condition prevented the creation or continued operation of the DB system.
Address The IP address of the endpoint.
MySQL Port The classic MySQL protocol port of the endpoint. Default is 3306.
MySQL X Protocol Port The MySQL X Protocol port of the endpoint.
Modes One of the following values:
  • READ,WRITE
  • READ_ONLY

Backups

The Backups resource on the DB System Details page shows the details of the backup plan for the DB system, and lists all backups of the DB system.

Table 8-11 Backups Overview

Field Description
Create Manual Backup Opens the Create Manual Backup dialog.
Name Name of the backup
State State of the backup
Retention Days Retention period of the backup.
Size The size of the backup.
Created The date the backup was created.
Actions (three dot) menu
The actions (three dot) menu contains the following:
  • View Backup Details: opens the Backup Details page. For more information, see Backup Details
  • Restore to New DB System: opens the Restore to a new DB System page. For more information, see Restoring From a Backup to a New DB System Using the Console.
  • Edit: opens the Edit Backup dialog. You can edit the Display Name and Description of the backup.
  • Copy OCID: copies the backup OCID to the clipboard.
  • Add Tags: opens the Add One or more Tags to this Resource dialog. Enabling you to add tags to the backup.
  • View Tags: displays the tags applied to the backup.
  • Delete: opens the Delete Backup dialog. Follow the prompts to delete the backup.

Channels

The Channels resource on the DB System Details page shows the replication channels that are configured for this DB system, and their current status.

Table 8-12 Channels Overview

Field Description
Name The display name of the channel.
Source The IP address or hostname of the MySQL Source.
Target The name of the target DB System.
State Current state:
  • CREATING: Yellow icon. The Channel is being created. Provisioning can take several minutes. The channel is not yet replicating data from the source to the target.

  • ACTIVE: Green icon. The Channel was successfully enabled.

  • UPDATING: Yellow icon. A Channel operation is ongoing.

  • NEEDS_ATTENTION: Yellow icon. This status is displayed for the following reasons:
    • The Channel is not replicating due to an error. The Details column on the Channels page lists why the channel needs attention.
    • The target DB System is INACTIVE. This can also occur if the channel was created or updated while the DB System was in INACTIVE state. Pending actions are applied if the DB System is started.
  • INACTIVE: Yellow icon. The Channel is not replicating because the user disabled it.

  • DELETING: Yellow icon. The Channel is being deleted.

  • DELETED: Grey icon. The Channel has been deleted and is no longer available.

Details Information or errors relating to the current state of the channel.
Enabled Whether the channel is enabled.
Created Date and time the channel was created.
Actions menu The actions (three dot) menu contains the following:
  • View Channel Details: opens the Channel Details page. For more information, see Channel Details.
  • Disable/Enable: click Disable to disable the replication channel. Click Enable to enable the replication channel. For more information, see Enabling or Disabling a Channel.
  • Reset: resets the channel, removing all channel metadata. For more information, see Resetting a Channel.
  • Resume: resumes the channel in the event of an error. For more information, see Resuming a Channel.
  • Copy OCID: copies the OCID of the Channel to the clipboard.
  • View Tags: opens the View Tags dialog, displaying all tags defined on this channel.
  • Add Tags: opens the Add One or More Tag to this Resource dialog, enabling you to define tags for the channel.
  • Delete: opens the Delete Channel dialog. Follow the prompts to delete the channel.

HeatWave Cluster Information

The HeatWave resource on the DB System Details page shows information related to the HeatWave cluster and nodes. You can view and manage the HeatWave cluster attached to this DB system.

Table 8-13 HeatWave Cluster Information

Field Description
Cluster Size The number of nodes in the cluster.
Shape The shape used for HeatWave cluster nodes.
State The state of the HeatWave cluster. See HeatWave States.
Created The date and time the HeatWave cluster was created.
Last Updated The date and time the HeatWave cluster was last updated.

Table 8-14 HeatWave Nodes

Column Description
Node Id The name of the HeatWave node.
State Current state of the HeatWave node. See HeatWave States.
Created The date and time the HeatWave node was created.

Work Requests

The Work Requests resource on the DB System Details page lists the activity logs for ongoing and recent operations on the DB system. Work requests are retained for 12 hours.

Table 8-15 Work Requests

Field Description
Operation One of the following operation names:
  • CREATE_DBSYSTEM
  • UPDATE_DBSYSTEM
  • DELETE_DBSYSTEM
  • START_DBSYSTEM
  • STOP_DBSYSTEM
  • RESTART_DBSYSTEM
  • ADD_ANALYTICS_CLUSTER
  • UPDATE_ANALYTICS_CLUSTER
  • DELETE_ANALYTICS_CLUSTER
  • START_ANALYTICS_CLUSTER
  • STOP_ANALYTICS_CLUSTER
  • RESTART_ANALYTICS_CLUSTER
  • GENERATE_ANALYTICS_CLUSTER_MEMORY_ESTIMATE

For more information on Work Requests, see Work Request Overview.

State Current state:
  • ACCEPTED: The request is in the work request queue to be processed.

  • IN_PROGRESS: A work request record exists for the specified request, but there is no associated WORK_COMPLETED record.

  • SUCCEEDED: A work request record exists for this request and an associated WORK_COMPLETED record has the state SUCCEEDED.

  • FAILED: A work request record exists for this request and an associated WORK_COMPLETED record has the state FAILED.
  • CANCELING: The work request is in the process of canceling.

  • CANCELED: The work request has been canceled.

Progress A progress bar for the work request.
% Complete The percentage completion.
Accepted Date and time the operation was accepted.
Started Date and time the operation started.
Finished Date and time the operation finished.
Action menu (3 dots) Opens the action menu. The following actions are possible:
  • View Work Request: opens the Work Request Details page.

Billing

The billing of the DB system starts at the end of the Creating state, and is billed during the Active, Updating, and Deleting state.

Stopping a DB system stops billing for all OCPUs associated with it. However, billing continues for storage. Billing for OCPUs resumes if you restart the DB system.

If you delete a DB system, the billing stops at the end of the Deleting state. You are not billed when the DB system is in the Inactive, Deleted, or Failed state.