MySQL HeatWave

This connector lets you materialize data from your Estuary collections directly into Oracle MySQL HeatWave instances.

Prerequisites

To use this materialization connector, you’ll need the following:

A MySQL HeatWave database and the appropriate user credentials.
At least one Estuary collection.

Configuration

Select one or more of your Estuary collections to start using this connector. The configuration properties below will help you to materialize your collections into tables in MySQL HeatWave.

Properties

Endpoint

Property	Title	Description	Type	Required/Default
`/address`	Address	Host and port of the database. If only the host is specified, the port will default to `3306`.	string	Required
`/database`	Database	Name of the logical database to send data to.	string	Required
`/user`	User	Username for authentication.	string	Required
`/password`	Password	Password for authentication.	string	Required
`/timezone`	Timezone	Timezone to use when materializing datetime columns. Should normally be left blank to use the database's 'time_zone' system variable. Only required if the 'time_zone' system variable cannot be read.	string
`/hardDelete`	Hard Delete	If enabled, items deleted in the source will also be deleted from the destination. By default, deletions are tracked via `_meta/op` (soft delete).	boolean	`false`
`/advanced/no_flow_document`	Exclude Flow Document	When enabled, the root document will not be required for standard updates. See excluding flow_document with standard updates for details.	boolean	`false`

Advanced: SSL Mode

Configuring the SSL mode strengthens security when transferring data to Oracle MySQL HeatWave. Here are the possible values for SSL mode:

disabled: Establishes an unencrypted connection with the server.
preferred: Initiates the SSL connection only if prompted by the server.
required: Establishes an SSL connection but doesn’t verify the server’s certificate.
verify_ca: Connects via SSL connection and verifies the server’s certificate against the provided SSL Server CA, without validating the server's hostname. SSL Server CA is mandatory for this mode.
verify_identity: Ensures an SSL connection, and verifies both the server's certificate and hostname. This is the highest level of security. SSL Server CA is required for this mode.

Bindings

Property	Title	Description	Type	Required/Default
`/table`	Table	The name of the table to send data to.	string	Required
`/additional_table_create_sql`	Additional Table Create SQL	Additional SQL statement(s) to be run after the table is created.	string

Sample

materializations:
  ${PREFIX}/${MAT_NAME}:
    endpoint:
      connector:
        image: ghcr.io/estuary/materialize-mysql-heatwave:v2
        config:
          database: flow
          address: localhost:5432
          password: secret
          user: flow
    bindings:
      - resource:
          table: ${TABLE_NAME}
        source: ${PREFIX}/${COLLECTION_NAME}

MySQL HeatWave on Oracle Cloud Infrastructure

This connector supports cloud-based MySQL HeatWave instances hosted on Oracle Cloud Infrastructure (OCI).

SSH Tunneling (Required)

You are also required to configure SSH tunneling by providing the following:

SSH Endpoint: Enter the endpoint of the remote SSH server that supports tunneling (formatted as ssh://user@hostname[:port]).
SSH Private Key: Input the full RSA Private Key for SSH connection.

Prerequisites​

Configuration​

Properties​

Endpoint​

Advanced: SSL Mode​

Bindings​

Sample​

MySQL HeatWave on Oracle Cloud Infrastructure​

SSH Tunneling (Required)​