Managing a Configuration

You can edit a custom configuration, copy a configuration, update the configuration of a DB system, or compare two configurations.

Editing a Custom Configuration

You can edit the name, description, and tags of a custom configuration. You cannot edit a default configuration.

Using the Console
Using the REST API, run the UpdateConfiguration operation.

Using the Console

Use the Console to edit a custom configuration.

On the Configuration list page, select the configuration that you want to work with. If you need help finding the list page or the configuration, see Listing Configuration - Using the Console.

The details page opens and displays information about the configuration.
Select the Details tab.
Select Edit in the Name or Description field.
In the Edit configuration dialog box, edit the configuration name and description.
Select Save changes.

Related Topics

Copying a Configuration

You can copy either an existing custom configuration or a default configuration, and create a new custom configuration.

The new custom configuration inherits the shape from the copied configuration. If you want to create a custom configuration that supports high availability DB systems, you must copy from an existing configuration that supports high availability. For example, if you want to create a custom configuration for the MySQL.8 shape that supports high availability, you can copy from the MySQL.8.HA configuration.

Use the Console or a command-line interface to copy a configuration.

Using the Console
Using the CLI
Using the REST API, run the CreateConfiguration operation with the parentConfigurationId attribute.

Using the Console

Use the Console to copy a configuration.

On the Configuration list page, select the configuration that you want to work with. If you need help finding the list page or the configuration, see Listing Configuration - Using the Console.

The details page opens and displays information about the configuration.
Select Copy configuration at the top of the page.
In the Provide basic information for the configuration section, enter the following information:
- Name: Specify a user-friendly display name for the configuration. The name does not need to be unique. A unique Oracle Cloud Identifier (OCID) is generated to identify the configuration.
- Description: (Optional) Specify a description for the configuration.
In the Configure placement and hardware section, enter the following information:
- Select a Compartment: If you want to create the configuration in a different compartment, select the required compartment.
- Select a shape: The shape cannot be changed in Copy configuration.
In the Initialization variables section, you can select Ignore case in table and schema names to disable table and schema names case sensitivity. See Initialization Variables.
In the User variables (read/write) section, select the variable you want to edit in Variable name drop down list, and enter or select the Variable value. To delete a variable from the configuration, select the cross (X) at the end of the row. To add another variable to your configuration, select +Another variable.
Every configuration has a set of default user variables. If you do not select any variable, Oracle adds these default variables to the Configuration. See User Variables.

Note

The Console rounds large integer values that it reads from the Configuration to 16 significant digits. For example, 9223372036854775807 is rounded to 9223372036854776000. You need to correct the rounded value of existing variables that exceed the maximum value.
The System variables (read-only) section shows non-editable system variables. See System Variables.
(Optional) Select Show advanced options to expand the Tags section. You can add a tag by selecting a Tag namespace and enter a Tag key and its Tag value. If you want to add another tag, select Add tag to create another row.
(Optional) To save the resource definition as a Terraform configuration, select Save as stack. See Creating a Stack from a Resource Creation Page.
To copy the configuration, select Create.

Note

Once you create the configuration, you cannot edit the variables defined on the configuration. To edit variables, create a new configuration with the desired variables, or copy an existing configuration, edit the variables, and edit the DB system to use the new configuration. See Updating the Configuration of a DB System.

Related Topics

Creating a Custom Configuration

Using the CLI

Use the command-line interface to copy a configuration.

This task requires the following:

The Oracle Cloud Identifier (OCID) of your compartment.
The OCID of an existing configuration to copy from.
A policy that permits you to create configurations in the compartment or tenancy.
If you are copying from a custom configuration, a policy that permits you to read the custom configuration.
A properly configured CLI installation and the requisite SSH keys. See Command Line Interface.

Copy a configuration to create a new custom configuration using the CLI:

Open a command prompt and run the following command:
```
oci mysql configuration create 
     --compartment-id <CompartmentOCID>
     --parent-configuration-id <ConfigurationOCID>
     --description <Description>
     --display-name <DisplayName> 
     --shape-name <ShapeName> 
     --variables <JSONObject>
```
- compartment-id: Specify the OCID of the compartment used to create the new configuration.
- parent-configuration-id: Specify the OCID of the configuration to be copied from.
- description: (Optional) Specify a brief description of the configuration.
- display-name: (Optional) Specify the display name of the configuration. If you do not define a display name, Oracle generates one for you in the mysqlconfigurationYYYYMMDDHHMMSS format.
- shape-name: Specify the name of the shape. For example, MySQL.4.
  Note
  
  The shape must be the same as the shape of the parent configuration.
- variables: (Optional) Specify the variables and their corresponding values as key value pairs in a JSON object, for example:
```
{ "autocommit": true, "connectTimeout": 20 } 
```

If the command validates and runs successfully, you get a response similar to the following, which summarizes the request and creates the configuration:

{
  "data": {
    "compartment-id": "ocid1.compartment.oc1..longAlphanumericString",
    "defined-tags": {
      "Oracle-Tags": {
        "CreatedBy": "userName",
        "CreatedOn": "2024-07-11T00:51:53.856Z"
      }
    },
    "description": "This is a user defined descrption",
    "display-name": "ConfigName",
    "freeform-tags": {},
    "id": "ocid1.mysqlconfiguration.oc1.longAlphanumericString",
    "init-variables": {
      "lower-case-table-names": "CASE_SENSITIVE"
    },
    "lifecycle-state": "ACTIVE",
    "parent-configuration-id": "ocid1.mysqlconfiguration.oc1.longAlphanumericString",
    "shape-name": "MySQL.2",
    "time-created": "2024-07-11T00:51:53.866000+00:00",
    "time-updated": "2024-07-11T00:51:53.866000+00:00",
    "type": "CUSTOM",
    "variables": {
      "autocommit": true,
      "big-tables": null,
      "binlog-expire-logs-seconds": 3600,
      "binlog-row-metadata": null,
      "binlog-row-value-options": "PARTIAL_JSON",
      "binlog-transaction-compression": null,
      "completion-type": null,
      "connect-timeout": 20,
      "connection-memory-chunk-size": null,
      "connection-memory-limit": null,
      "cte-max-recursion-depth": null,
      "default-authentication-plugin": null,
      "foreign-key-checks": null,
      "generated-random-password-length": null,
      "global-connection-memory-limit": null,
      "global-connection-memory-tracking": null,
      "group-replication-consistency": "BEFORE_ON_PRIMARY_FAILOVER",
      "information-schema-stats-expiry": null,
      "innodb-buffer-pool-dump-pct": null,
      "innodb-buffer-pool-instances": 4,
      "innodb-buffer-pool-size": 9126805504,
      "innodb-ddl-buffer-size": null,
      "innodb-ddl-threads": null,
      "innodb-ft-enable-stopword": null,
      "innodb-ft-max-token-size": null,
      "innodb-ft-min-token-size": null,
      "innodb-ft-num-word-optimize": null,
      "innodb-ft-result-cache-limit": 33554432,
      "innodb-ft-server-stopword-table": null,
      "innodb-lock-wait-timeout": null,
      "innodb-log-writer-threads": null,
      "innodb-max-purge-lag": null,
      "innodb-max-purge-lag-delay": 300000,
      "innodb-stats-persistent-sample-pages": null,
      "innodb-stats-transient-sample-pages": null,
      "interactive-timeout": null,
      "local-infile": true,
      "mandatory-roles": "public",
      "max-allowed-packet": null,
      "max-binlog-cache-size": 4294967296,
      "max-connect-errors": null,
      "max-connections": 1000,
      "max-execution-time": null,
      "max-heap-table-size": null,
      "max-prepared-stmt-count": null,
      "mysql-firewall-mode": null,
      "mysql-zstd-default-compression-level": null,
      "mysqlx-connect-timeout": null,
      "mysqlx-deflate-default-compression-level": null,
      "mysqlx-deflate-max-client-compression-level": null,
      "mysqlx-document-id-unique-prefix": null,
      "mysqlx-enable-hello-notice": null,
      "mysqlx-idle-worker-thread-timeout": null,
      "mysqlx-interactive-timeout": null,
      "mysqlx-lz4-default-compression-level": null,
      "mysqlx-lz4-max-client-compression-level": null,
      "mysqlx-max-allowed-packet": null,
      "mysqlx-min-worker-threads": null,
      "mysqlx-read-timeout": null,
      "mysqlx-wait-timeout": null,
      "mysqlx-write-timeout": null,
      "mysqlx-zstd-default-compression-level": null,
      "mysqlx-zstd-max-client-compression-level": null,
      "net-read-timeout": null,
      "net-write-timeout": null,
      "parser-max-mem-size": null,
      "query-alloc-block-size": null,
      "query-prealloc-size": null,
      "regexp-time-limit": null,
      "sort-buffer-size": null,
      "sql-mode": null,
      "sql-require-primary-key": true,
      "sql-warnings": null,
      "thread-pool-dedicated-listeners": null,
      "thread-pool-max-transactions-limit": null,
      "time-zone": "UTC",
      "tmp-table-size": null,
      "transaction-isolation": null,
      "wait-timeout": null
    }
  },
  "etag": "longAlphanumericString"
}

Updating the Configuration of a DB System

You can update the configuration of a DB system to an existing configuration or a newly created configuration to change the variable settings of the DB system.

If all the changed variables are dynamic, the DB system does not require a restart and no downtime is incurred.

If one or more non-dynamic variables are changed, the DB system needs to be restarted.

A standalone DB system incurs a downtime during the restart.
A high availability DB system incurs a brief downtime and a change in the current primary placement as it performs a rolling restart. The rolling restart shortens the downtime and causes a change in the current primary placement of the high availability DB system.
If the DB system has an active HeatWave cluster attached to it, the data in the HeatWave cluster is reloaded automatically.

Use the Console of a command-line interface to update the configuration of a DB system:

Using the Console
Using the CLI
Using the REST API, run the UpdateDbSystem operation with the configurationId attribute.

Using the Console

Use the Console to update the configuration of a DB system.

Do the following to update the configuration of a DB system:

(Optional) Create a new configuration. See Creating a Custom Configuration.
Edit the DB system to update the configuration. See Editing a DB System.
Note

You cannot update the configuration if there is an active channel connected to the DB system. Stop the channel to update the configuration.

Related Topics

Creating a Custom Configuration

Using the CLI

Use the command-line interface to update the configuration of a DB system.

This task requires the following:

A DB system Oracle Cloud Identifier (OCID).
A HeatWave configuration OCID.
A properly configured CLI installation and the requisite SSH keys. See Command Line Interface.

(Optional) Create a new configuration. See Creating a Custom Configuration.
Open a command prompt and run the following command:
```
oci mysql db-system update 
     --db-system-id <DBSystemOCID>
     --configuration-id <ConfigurationOCID>
```
- db-system-id: Specify the OCID of the DB system you want to update.
- configuration-id: Specify the OCID of the configuration with which you want to replace the existing configuration.

Comparing Configurations

Compare the shapes, initialization variables, and user variables of two configurations.

Note

This is a Console only feature, there is no equivalent CLI or REST API command. You can view the details of both configurations and compare the output.

Using the Console

Use the Console to compare two configurations.

On the Configurations list page, select two configurations that you want to compare. If you need help finding the list page or the configuration, see Listing Configurations - Using the Console.
From the Actions menu at the top of the configuration list, select Compare.
In the Compare configurations panel, select either of the following option buttons:
- Show configuration differences: Displays the differences in the shapes, initialization variables, and user variables.
- Show all configuration information: Displays all information related to shapes, initialization variables, and user variables of the two configurations.
Select Close.

Related Topics

Viewing Configuration Details

Deleting a Configuration

You can delete a custom configuration that is not currently used by any DB system.

Use the Console, a command-line interface, or the REST API to delete a configuration.

Using the Console
Using the CLI
Using the REST API, run the DeleteConfiguration operation.

Using the Console

Use the Console to delete a custom configuration.

This task requires the following:

The custom configuration that you want to delete is not being used by any DB system.
A policy that permits you to delete configurations in the compartment or tenancy.

Do the following to delete a custom configuration using the console:

On the Configurations list page, find the configuration that you want to work with. If you need help finding the list page or the configuration, see Listing Configurations - Using the Console.
From the Actions menu for the configuration, select Delete.
When prompted, confirm the deletion.

Using the CLI

Use the command-line interface to delete a configuration.

This task requires the following:

The OCID of a HeatWave configuration that is not being used by any DB system.
A policy that permits you to delete configurations in the compartment or tenancy.
A properly configured CLI installation and the requisite SSH keys. See Command Line Interface.

Delete a configuration using the CLI:

Open a command prompt and run the following command:
```
oci mysql configuration delete 
     --configuration-id <ConfigurationOCID>
```
- configuration-id: Specify the OCID of the configuration which you want to delete.

Oracle Cloud Infrastructure Documentation