- Support
- Integrations
- MySQL HeatWave
MySQL HeatWave
Oracle Cloud integration · 17 node(s).
00Overview
The MySQL HeatWave integration provisions and manages Oracle Cloud MySQL DB systems — creating, starting, stopping and deleting them, taking and managing backups, tuning configurations, and running the in-memory HeatWave analytics cluster. Most write actions are asynchronous and return a work-request id you poll until the resource settles, and every action runs against a specific compartment.
Every field below is exactly what you see in the Flomation editor. Fields marked ● live picker let you choose from a list pulled live from your account — no IDs to look up.
01Connecting MySQL HeatWave
- Choose how to authenticate. Under Authentication, the default Connect Oracle Cloud uses an Oracle Cloud account you have already connected; to supply signing details by hand, switch to API signing key (advanced).
- Create an API signing key in Oracle Cloud. In the OCI Console, open your user's API keys and add a key pair, then copy the Tenancy OCID, User OCID, Key Fingerprint and home Region from the configuration-file preview.
- Fill the connection fields. Enter the Tenancy OCID, User OCID, Region (a plain identifier such as
uk-london-1) and Key Fingerprint. - Point the action at a compartment. Set the Compartment OCID — required on every action, including reads — along with the DB System OCID or Backup OCID the chosen action needs.
- Store the private key as a secret. Save the full PEM, including the BEGIN and END lines, as a Flomation environment secret and select it in the node's Private Key (PEM) field; add a Private Key Passphrase secret only if the key is encrypted.
| Field | Type | Details | |
|---|---|---|---|
| Authentication | string | Connect Oracle Cloud, API signing key (advanced) | |
| Oracle Cloud connection | credential | Pick a connected Oracle Cloud account | |
| Region | string | e.g. uk-london-1 | |
| Private Key (PEM) | secret | The API signing private key — full PEM, incl. BEGIN/END lines | |
| Private Key Passphrase | secret | Only if the key is encrypted (optional) | |
| Tenancy OCID | string | ocid1.tenancy.oc1..aaaa… | |
| User OCID | string | ocid1.user.oc1..aaaa… | |
| Key Fingerprint | string | aa:bb:cc:… fingerprint of the uploaded API key |
Pick an Environment on your flow (Flow Settings → Environment) so the secret resolves. Secret fields never show the value — they reference ${secrets.your_secret}.
02Backup
OCI MySQL: Create Backup
oracle/mysql/backup_create · Action
Take an on-demand backup of a MySQL HeatWave DB system. Returns the backup in a CREATING state plus a work-request id — poll Get Backup until ACTIVE.
| Field | Type | Details | |
|---|---|---|---|
| Compartment OCID | string | Required | ocid1.compartment.oc1..aaaa… |
| DB System OCID | string | Required | ocid1.mysqldbsystem.oc1..aaaa… |
| Backup Type | string | FULL (default) or INCREMENTAL — choices: Full, Incremental | |
| Display Name | string | A name for the backup (optional) | |
| Retention (days) | string | Number of days to retain this backup (optional) |
Returns: tool_result, backup, id, lifecycle_state, work_request_id, success, error
OCI MySQL: Delete Backup
oracle/mysql/backup_delete · Action
Delete a MySQL HeatWave backup by its OCID. Returns a work-request id — poll the work request until it completes to confirm removal.
| Field | Type | Details | |
|---|---|---|---|
| Compartment OCID | string | Required | ocid1.compartment.oc1..aaaa… |
| Backup OCID | string | Required | ocid1.mysqlbackup.oc1..aaaa… of the backup to delete |
Returns: tool_result, id, work_request_id, success, error
OCI MySQL: Get Backup
oracle/mysql/backup_get · Action
Fetch a single MySQL HeatWave backup by its OCID — its type, source DB system, size and lifecycle state.
| Field | Type | Details | |
|---|---|---|---|
| Compartment OCID | string | Required | ocid1.compartment.oc1..aaaa… |
| Backup OCID | string | Required | ocid1.mysqlbackup.oc1..aaaa… |
Returns: tool_result, backup, id, lifecycle_state, success, error
OCI MySQL: List Backups
oracle/mysql/backup_list · Action
List the MySQL HeatWave backups in a compartment. Optionally filter by DB system, exact display name or lifecycle state. Walks pagination up to a safe cap.
| Field | Type | Details | |
|---|---|---|---|
| Compartment OCID | string | Required | ocid1.compartment.oc1..aaaa… (use the tenancy OCID for the root) |
| DB System OCID | string | Only backups of this DB system (optional) | |
| Display Name Filter | string | Only backups with this exact name (optional) | |
| Lifecycle State | string | Filter by state (optional) — choices: Creating, Active, Inactive, Updating, Deleting, Deleted, Failed, Delete Scheduled | |
| Page Size | string | Max items per API page (optional) |
Returns: tool_result, backups, count, truncated, success, error
03Configuration
OCI MySQL: Get Configuration
oracle/mysql/configuration_get · Action
Fetch a single MySQL HeatWave configuration by its OCID — its shape, type and lifecycle state.
| Field | Type | Details | |
|---|---|---|---|
| Compartment OCID | string | Required | ocid1.compartment.oc1..aaaa… |
| Configuration OCID | string | Required | ocid1.mysqlconfiguration.oc1..aaaa… |
Returns: tool_result, configuration, id, lifecycle_state, success, error
OCI MySQL: List Configurations
oracle/mysql/configuration_list · Action
List the MySQL configurations in a compartment. Optionally filter by exact display name, type (DEFAULT or CUSTOM) or shape name. Walks pagination up to a safe cap.
| Field | Type | Details | |
|---|---|---|---|
| Compartment OCID | string | Required | ocid1.compartment.oc1..aaaa… (use the tenancy OCID for the root) |
| Display Name Filter | string | Only configurations with this exact name (optional) | |
| Type | string | Filter by configuration type (optional) — choices: Default, Custom | |
| Shape Name Filter | string | Only configurations for this shape, e.g. MySQL.VM.Standard.E3.1.8GB (optional) | |
| Page Size | string | Max items per page (optional) |
Returns: tool_result, configurations, count, truncated, success, error
04Db
OCI MySQL: Change DB System Compartment
oracle/mysql/db_system_change_compartment · Action
Attempt to move a MySQL HeatWave DB system to another compartment — reports that OCI provides no such operation for DB systems.
| Field | Type | Details | |
|---|---|---|---|
| Compartment OCID | string | Required | ocid1.compartment.oc1..aaaa… |
| DB System OCID | string | Required | ocid1.mysqldbsystem.oc1..aaaa… (the DB system to move) |
| Destination Compartment OCID | string | Required | ocid1.compartment.oc1..aaaa… (where you want the DB system) |
Returns: tool_result, success, error
OCI MySQL: Create DB System
oracle/mysql/db_system_create · Action
Provision a MySQL HeatWave DB system in a compartment — pick the shape, subnet and admin credentials. Returns a work-request id; the DB system starts in a CREATING state, so poll Get DB System until ACTIVE.
| Field | Type | Details | |
|---|---|---|---|
| Compartment OCID | string | Required | ocid1.compartment.oc1..aaaa… |
| Shape Name | string | Required | e.g. MySQL.2 — from List Shapes |
| Subnet OCID | string | Required | ocid1.subnet.oc1..aaaa… |
| Admin Username | string | Required | The administrative user to create |
| Admin Password | secret | Required | 8–32 chars, incl. upper, lower, number and special |
| Availability Domain | string | e.g. AaBb:UK-LONDON-1-AD-1 (optional) | |
| Display Name | string | A name for the DB system (optional) | |
| Data Storage (GB) | string | Initial data volume size in GBs (optional) |
Returns: tool_result, work_request_id, success, error
OCI MySQL: Delete DB System
oracle/mysql/db_system_delete · Action
Delete a MySQL HeatWave DB system by its OCID. Asynchronous — it moves to DELETING and returns a work-request id to poll.
| Field | Type | Details | |
|---|---|---|---|
| Compartment OCID | string | Required | ocid1.compartment.oc1..aaaa… |
| DB System OCID | string | Required | ocid1.mysqldbsystem.oc1..aaaa… of the DB system to delete |
Returns: tool_result, id, work_request_id, success, error
OCI MySQL: Get DB System
oracle/mysql/db_system_get · Action
Fetch a single MySQL HeatWave DB system by its OCID — its shape, version, endpoints and lifecycle state.
| Field | Type | Details | |
|---|---|---|---|
| Compartment OCID | string | Required | ocid1.compartment.oc1..aaaa… |
| DB System OCID | string | Required | ocid1.mysqldbsystem.oc1..aaaa… |
Returns: tool_result, db_system, id, lifecycle_state, success, error
OCI MySQL: List DB Systems
oracle/mysql/db_system_list · Action
List the MySQL HeatWave DB systems in a compartment. Optionally filter by exact display name or lifecycle state. Walks pagination up to a safe cap.
| Field | Type | Details | |
|---|---|---|---|
| Compartment OCID | string | Required | ocid1.compartment.oc1..aaaa… (use the tenancy OCID for the root) |
| Display Name Filter | string | Only DB systems with this exact name (optional) | |
| Lifecycle State | string | Filter by lifecycle state (optional) — choices: Creating, Active, Inactive, Updating, Deleting, Deleted, Failed |
Returns: tool_result, db_systems, count, truncated, success, error
OCI MySQL: Start DB System
oracle/mysql/db_system_start · Action
Start a stopped MySQL HeatWave DB system by its OCID. Asynchronous — returns a work-request id you can poll until the DB system is ACTIVE.
| Field | Type | Details | |
|---|---|---|---|
| Compartment OCID | string | Required | ocid1.compartment.oc1..aaaa… |
| DB System OCID | string | Required | ocid1.mysqldbsystem.oc1..aaaa… of the DB system to start |
Returns: tool_result, id, work_request_id, success, error
OCI MySQL: Stop DB System
oracle/mysql/db_system_stop · Action
Stop a running MySQL HeatWave DB system by its OCID, choosing the InnoDB shutdown mode. Asynchronous — returns a work-request id you can poll until the DB system is INACTIVE.
| Field | Type | Details | |
|---|---|---|---|
| Compartment OCID | string | Required | ocid1.compartment.oc1..aaaa… |
| DB System OCID | string | Required | ocid1.mysqldbsystem.oc1..aaaa… of the DB system to stop |
| Shutdown Type | string | Required | The InnoDB shutdown mode — choices: Fast (default clean shutdown), Slow (full purge before shutdown), Immediate (skip purge — fastest) |
Returns: tool_result, id, work_request_id, success, error
OCI MySQL: Update DB System
oracle/mysql/db_system_update · Action
Partially update a MySQL HeatWave DB system — change only the display name or description you supply; blank fields are left unchanged. Asynchronous: returns a work-request id to poll.
| Field | Type | Details | |
|---|---|---|---|
| Compartment OCID | string | Required | ocid1.compartment.oc1..aaaa… |
| DB System OCID | string | Required | ocid1.mysqldbsystem.oc1..aaaa… — the DB system to update |
| Display Name | string | New name (leave blank to keep unchanged) | |
| Description | string | New description (leave blank to keep unchanged) |
Returns: tool_result, id, work_request_id, success, error
05Heatwave
OCI MySQL: Add HeatWave Cluster
oracle/mysql/heatwave_add · Action
Attach a HeatWave cluster to a MySQL DB system for in-memory analytics. Returns a work-request id — poll until the cluster is ACTIVE.
| Field | Type | Details | |
|---|---|---|---|
| Compartment OCID | string | Required | ocid1.compartment.oc1..aaaa… |
| DB System OCID | string | Required | ocid1.mysqldbsystem.oc1..aaaa… |
| Cluster Size (nodes) | string | Required | Number of HeatWave nodes to provision, e.g. 1 |
| Shape Name | string | Required | HeatWave node shape, e.g. MySQL.HeatWave.VM.Standard.E3 |
Returns: tool_result, work_request_id, success, error
OCI MySQL: Delete HeatWave Cluster
oracle/mysql/heatwave_delete · Action
Delete the HeatWave cluster attached to a MySQL DB system. Returns a work-request id — poll it until the removal completes.
| Field | Type | Details | |
|---|---|---|---|
| Compartment OCID | string | Required | ocid1.compartment.oc1..aaaa… |
| DB System OCID | string | Required | ocid1.mysqldbsystem.oc1..aaaa… of the DB system whose HeatWave cluster to delete |
Returns: tool_result, id, work_request_id, success, error
OCI MySQL: Get HeatWave Cluster
oracle/mysql/heatwave_get · Action
Fetch the HeatWave cluster attached to a MySQL DB System — its shape, node count and lifecycle state.
| Field | Type | Details | |
|---|---|---|---|
| Compartment OCID | string | Required | ocid1.compartment.oc1..aaaa… |
| DB System OCID | string | Required | ocid1.mysqldbsystem.oc1..aaaa… |
Returns: tool_result, heatwave_cluster, lifecycle_state, success, error
06Notes & Limitations
Behaviours and constraints worth knowing before you build with these nodes.
- Changing a DB system's compartment is not supported and always returns an error explaining the limitation; to move a DB system, create a backup, recreate the DB system from that backup in the destination compartment, and then delete the original.
- The create, delete, start, stop, backup, and HeatWave actions return a work-request ID and leave the resource in a transitional state, so poll until it settles into its final state (ACTIVE for create and start, INACTIVE for stop, and ACTIVE for a completed backup).
- Each DB system supports only one HeatWave cluster and a request to add a second is rejected, so check whether a cluster is already attached before adding one.
- Every action, including get and list reads, requires a compartment OCID.
- List actions return up to 25 pages of results and can be filtered by display name and lifecycle state.