MySQL
Learn the required and optional properties of creating a MySQL Connection, Credential, Read Connector, and Write Connector.
Prerequisites
- MySQL Server
- Access Credentials
Connection Properties
The following table describes the fields available when creating a new MySQL Connection. Create a connection using the information below and these step-by-step instructions.
| Field | Required | Description |
|---|---|---|
| Access Type | Required | This connection type is Read-Only, Write-Only, or Read-Write. |
| Connection Name | Required | Input your desired name. |
| Host | Required | IP or the hostname of the MySQL. |
| Port | Optional | Host server port number. |
| Database Name | Required | Name of the database. |
| Custom Connection Properties | Optional | Formatted as key=value pair. Include additional properties you'd like to store within the Connection. |
| Requires Credentials | Optional | Check this box to create a new credential or select an existing credential. |
Credential Properties
The following table describes the fields available when creating a new MySQL credential.
| Field | Required | Description |
|---|---|---|
| Credential Name | Required | The name to identify this credential with. This credential will be available as a selection for future use. |
| Credential Type | Required | This field will automatically populate with MySQL. |
| User | Required | MySQL server username to connect with. |
| Password | Optional | MySQL server password to connect with. Not required if you are connecting to a public server. |
| Connect Using SSL | Optional | Enforce SSL usage when connecting to MySQL. Requires server certificate, client public key certificate, or client private key. See Configuring MySQL to Use Encrypted Connections. |
Read Connector Properties
The following table describes the fields available when creating a new MySQL Read Connector. Create a new Read Connector using the information below and these step-by-step instructions.
Change Data Capture (CDC) with MySQL
See CDC with Ascend to learn more about how to implement CDC with MySQL.
| Field | Required | Description |
|---|---|---|
| Name | Required | Provide a name for your connector. We recommend using lowercase with underscores in place of spaces. |
| Description | Optional | Describes the connector. We recommend providing a description if you are ingesting information from the same source multiple times for different reasons. |
| Table Name | Required | Name of the table being ingested. This can either be supplied manually or selected in Step 2 of Create a Read Connector. |
| Replication Strategy | Optional | Full Resync, Full Resync in Parallel, Incremental Column, Table Snapshot, Table Snapshot in Parallel, or Change Data Capture. See Database Reading Strategies for more information. |
| Data Version | Optional | Assign a Data Version. A change to Data Version results in no longer using data previously ingested by this Connector, and a complete ingest of new data. |
Write Connector Properties
The following table describes the fields available when creating a new MySQL Write Connector. Create a new Write Connector using the information below and these step-by-step instructions.
| Field Name | Required | Description |
|---|---|---|
| Name | Required | Provide a name for your connector. We recommend using lowercase with underscores in place of spaces. |
| Description | Optional | Describes the connector. We recommend providing a description if you are ingesting information from the same source multiple times for different reasons. |
| Upstream | Required | The name of the previous connector the Write Connector will pull data from. |
| Table Name | Required | The name of the table that will be written to {connection type name}. |
| Write Strategy | Required | The strategy to copy data into {connection type name}. The Full Load strategy will replace the entire table's contents each time that the upstream transform has changed. If the upstream data set contains multiple Ascend partitions and not all partitions are expected to change on each update, then the Incremental By Partition strategy allows for Ascend to only update/insert/delete the partitions of the MySQL table that have changed in Ascend. |
| Max Number of Parallel Ascend Partitions | Optional | Ascend can write partitions in parallel. Ex.: If a transform has 2000 partitions and you set the max parallel to 100, Ascend will write partitions 100 at a time. |
| A SQL Statement for Ascend to Execute Before Writing | Optional | Here, the user has the option to execute a pre-processing script before writing to final table. |
| A SQL Statement for Ascend to Execute After Writing | Optional | Here, the user has the option to execute a pre-processing script after writing to final table. |
| Schema Name | Optional | The name of the schema to match. |
| On Schema Mismatch | Optional | Select what to do if the schema from the upstream component does not match the schema of the table name. Options are as follows: - Skip schema check - Stop and display error - Recreate table - Alter table |
| Data Version | Optional | Assign a Data Version. A change to Data Version results in no longer using data previously ingested by this Connector, and a complete ingest of new data. |
Updated 10 months ago