Movatterモバイル変換

[0]ホーム
URL:

DOCS >INTEGRATIONS >DATABASES >MICROSOFT AZURE MYSQL (V1)
  1. version 1 (Deprecated)

Get started with a free trial today

Already have an account? Sign in

Microsoft Azure MySQL (v1)

Microsoft Azure MySQL extraction is supported by Stitch
This integration is powered bySinger's MySQL tap and certified by Stitch.Check out and contribute to the repo on GitHub.

For support, contactSupport.

Microsoft Azure MySQL feature snapshot

A high-level look at Stitch's Microsoft Azure MySQL (v1) integration, including release status, useful links, and the features supported in Stitch.

STITCH
Release status

Deprecated on November 8, 2021

Supported by

Stitch

Stitch plan

Standard

Supported versions
API availability

Not available

Singer GitHub repository

singer-io/tap-mysql

CONNECTION METHODS
SSH connections

Supported

SSL connections

Supported

REPLICATION SETTINGS
Anchor Scheduling

Supported

Advanced Scheduling

Supported

Table-level reset

Supported

Configurable Replication Methods

Supported

REPLICATION METHODS
Log-based Replication

Supported

Key-based Replication

Supported

Full Table Replication

Supported

DATA SELECTION
Table selection

Supported

Column selection

Supported

View replication

Supported

Select all

Supported, with prerequisites

TRANSPARENCY
Extraction Logs

Supported

Loading Reports

Supported

Connecting Microsoft Azure MySQL

Microsoft Azure MySQL setup requirements

To set up Microsoft Azure MySQL in Stitch, you need:

  • TheCREATE USER orINSERT privilege (for themysql database). TheCREATE USER privilege is required to create a database user for Stitch.

  • TheGRANT OPTION privilege in Microsoft Azure MySQL. TheGRANT OPTION privilege is required to grant the necessary privileges to the Stitch database user.

  • If using Log-based Incremental Replication:, you’ll need:

    1. Privileges in Microsoft Azure that allow you to modify server parameters.
    2. A master server that adheres toMicrosoft’s requirements.
    3. A MySQL database running MySQL version 5.6.2 or newer.

Step 1: Verify your Stitch account's data pipeline region

First, you’ll log into Stitch and verify the data pipeline region your account is using. Later in this guide, you’ll need to grant Stitch access by whitelisting our IP addresses.

The IP addresses you’ll whitelist depend on theData pipeline region your account is in.

  1. Sign into your Stitch account, if you haven’t already.
  2. ClickUser menu (your icon) > Edit User Settings and locate theData pipeline region section to verify your account’s region.

  3. Locate the list of IP addresses for your region:

Keep this list handy - you’ll need it later.

Step 2: Configure database connection settings

In this step, you’ll configure the database server to allow traffic from Stitch to access it. There are two ways to connect your database:

  • A direct connection will work if your database is publicly accessible.
  • An SSH tunnel is required if your database isn’t publicly accessible. This method uses a publicly accessible instance, or an SSH server, to act as an intermediary between Stitch and your database. The SSH server will forward traffic from Stitch through an encrypted tunnel to the private database.

Click the option you’re using below and follow the instructions.

For the connection from Stitch to be successful, you’ll need to configure the firewall for your instance to allow access from IP addresses for yourStitch data pipeline region.

  1. Sign into yourMicrosoft Azure portal.

  2. Locate and open the database you want to connect to Stitch.

  3. ClickSettings > Connection security.

  4. For each of the IP addresses you retrieved inStep 1 for your Stitch data pipeline region, create a rule:
    • Rule name: Enter a name for the rule. For example:Stitch<number>
    • Start IP: Paste one of the Stitch data pipeline region IP addresses.
    • End IP: Paste the same IP address.
  5. Click the three dots to the right of theEnd IP field to add the rule.

  6. Repeat steps 4 and 5 until there is a rule for each IP address for your Stitch data pipeline region. Below is an example of what this might look like using Stitch’s North America IP addresses:

    IP address rules for Stitch's North America IP addresses in Microsoft Azure firewall settings

    Note: You may also want to add your own IP address(es) to this list. This ensures that you’ll also be able to connect to the database as needed.

  7. ClickSave.
  1. Follow the steps in theSetting up an SSH Tunnel for a Microsoft Azure database guide to set up an SSH tunnel for Microsoft Azure MySQL.
  2. Complete the steps in this guide after the SSH setup is complete.

Step 3: Configure Log-based Incremental Replication

Note: Skip this step if you’re not planning to use Log-based Incremental Replication.Click to skip ahead.

Important:Requirements for configuring binlog replication

To use binlog replication, your Microsoft Azure MySQL database must be running MySQL version 5.6.2 or greater.

Additionally, setting up binlog replication requires rebooting your database to ensure parameter changes take effect. To minimize disruptions, we recommend performing the reboot during non-peak usage hours.

While Log-based Incremental Replication is the most accurate and efficient method of replication, using this replication method may, at times, require manual intervention or impact the source database’s performance. Refer to theLog-based Incremental Replication documentation for more info.

You can also use one of Stitch’s otherReplication Methods, which don’t require any database configuration. Replication Methods can be changed at any time.

Step 3.1: Configure server settings

  1. In yourAzure portal, locate and open theAzure Database for MySQL database you want to connect to Stitch.
  2. ClickSettings > Server Parameters.

  3. Define the following server settings:

    • binlog_row_image -FULL

    • binlog_expire_logs_seconds -604800

    • log_slave_updates -1

    Refer to theServer settings list tab for more info about these settings.

  4. ClickSave when finished.
  5. When finished, restart your MySQL server to ensure the changes take effect.

In the table below are the names, required values, and descriptions of the server settings you must define.

SettingValueDescription
binlog_row_imageFULL

Note: This setting is available on Microsoft Azure MySQL databases running version 5.6.2 or greater.

Defines how row images are written to the binary log. AFULL value ensures that all columns in a row are logged in the before and after images of a change, enabling Stitch to accurately capture all changes made to a record.

binlog_expire_logs_seconds604800

Specifies the amount of time, in seconds, before the automatic removal of binary log files. Stitch recommends a retention period of7 days, but a minimum of3 days will also work.

Note: This variable is available on MySQL versions 8.0.1+.

log_slave_updates1

Indicates whether updates received by a read replica from a master server should be logged to the replica’s own binary log.

Note: This is applicable when using a read replica.

Step 3.2: Retrieve server IDs

Required for Log-based Replication

This step is required if using Log-based Replication and any of the following are true:

  1. You’re connecting a read replica to Stitch
  2. You’re connecting multiple databases to Stitch, all of which are on the same Microsoft Azure MySQL server. These can be read replicas, or databases on the master instance.
  3. You’re adding a new Microsoft Azure MySQL Stitch integration, and the database is on the same server as other previously-connected databases.

When Stitch connects to your database and uses Log-based Replication, a unique server ID will be required. This ID ensures that the integration - or integrations, if you’re connecting multiple databases - will not encounter conflicts during the replication process.

To avoid conflicts, you’ll check which server IDs are currently in use and then define a new, unqiue ID in Stitch.

  1. Log into the MySQL server that acts as the replication master.

  2. Run the following statement:

    mysql>SHOWSLAVEHOSTS;

  3. TheSHOW SLAVE HOSTS statement will return information about servers that are or have been connected as replication slaves:

    +------------+-------------+------+-----------+------------+|Server_id|Host|Port|Master_id|Slave_UUID|+------------+-------------+------+-----------+------------+|192168010|stitch_prod|3306|192168011|<UUID>||1921680101|stitch_dev|3306|192168011|<UUID>|+------------+-------------+------+-----------+------------+

When you complete the setup in Stitch, you’ll define a unique server ID for your Stitch Microsoft Azure MySQL integration to use.

Step 4: Create a Stitch database user

Note: You must have theCREATE USER andGRANT OPTION privileges to complete this step.

Next, you’ll create a dedicated database user for Stitch. This will ensure Stitch is visible in any logs or audits, and allow you to maintain your privilege hierarchy.

  1. Log into your database as a user withCREATE USER andGRANT OPTION privileges.

  2. Run the following command to create the Stitch database user:

    CREATEUSER'<stitch_username>'@'localhost'IDENTIFIEDBY'<password>';

    Replace<password> with a secure password. If using SSH, this can be different than the SSH password.

  3. Grant the Stitch userSELECT privileges by running this command for every table you want to replicate:

    GRANTSELECTON'<database_name>'.'<table_name>'to'<stitch_username>'@'localhost';

    Limiting access to only the tables you want to replicate ensures that the integration can complete discovery (a structure sync) in a timely manner. If you encounter issues in Stitch where tables aren’t displaying, try limiting the Stitch database user’s table access.

    Note: Column-level permissions are not supported for use with Log-based Incremental Replication. Restricting access to columns will cause replication issues.

Important:Using Log-based Incremental Replication

Additionally, if you want to use Log-based Incremental Replication, you’ll also need to grant the Stitch user replication privileges:

GRANTREPLICATIONCLIENT,REPLICATIONSLAVEON*.*TO'<stitch_username>'@'localhost';

See thePrivileges list tab for an explanation of why these permissions are required by Stitch.

In the table below are the database user privileges Stitch requires to connect to and replicate data from a Microsoft Azure MySQL database.

Privilege nameReason for requirement
SELECT

Required to select rows from tables in a database.

REPLICATION CLIENT

Required for binlog replication. Required to useSHOW BINARY LOGS, which determines that a binary log exists.

REPLICATION SLAVE

Required for binlog replication. Required to useSHOW MASTER STATUS, which fetches the current binlog file and position on the server.

Step 5: Connect Stitch

In this step, you’ll complete the setup by entering the database’s connection details and defining replication settings in Stitch:

Step 5.1: Locate connection details

In this step, you’ll retrieve the server address for the Microsoft Azure MySQL you want to connect to Stitch.

This is the value you’ll enter in theHost field in Stitch in the next step.

  1. From your Azure dashboard, clickAzure Database for MySQL Server.
  2. On the page that displays, click the name of the database you want to connect to Stitch.

  3. The details page for the database will display. On this page, locate theServer name field, which is highlighted below:

    The Server name field for an Azure database, highlighted

Step 5.2: Define the database connection details

  1. If you aren’t signed into your Stitch account,sign in now.

  2. On the Stitch Dashboard page, click theAdd Integration button.

  3. Locate and click theMySQL icon.

  4. Fill in the fields as follows:

    • Integration Name: Enter a name for the integration. This is the name that will display on the Stitch Dashboard for the integration; it’ll also be used to create the schema in your destination.

      For example, the name “Stitch Microsoft Azure MySQL” would create a schema calledstitch_microsoft_azure_mysql in the destination.Note: The schema name cannot be changed after the integration is saved.

    • Integration Name: Paste theServer name you retrieved in theprevious step. This should be similar to<database-name>.mysql.database.azure.com.

    • Port: Enter the port used by the Microsoft Azure MySQL instance. The default is3306.

    • Username: Enter the Stitch Microsoft Azure MySQL database user’s username.

    • Password: Enter the password for the Stitch Microsoft Azure MySQL database user.

Step 5.3: Define the SSH connection details

Note: Skip this step if you’re not using SSH to connect to Stitch.

If you’re using an SSH tunnel to connect your Microsoft Azure MySQL database to Stitch, you’ll also need to define the SSH settings. Refer to theSetting up an SSH Tunnel for a Microsoft Azure database guide for assistance with completing these fields.

  1. Click theSSH Tunnel checkbox.

  2. Fill in the fields as follows:

    • SSH Host: Enter the public IP address or hostname of the server Stitch will SSH into.

    • SSH Port: Enter the SSH port on your server. (22 by default)

    • SSH User: Enter the Stitch Linux (SSH) user’s username.

Step 5.4: Define the SSL connection details

Note: Skip this step if you’re not using SSL to connect to Stitch.

  1. Check theConnect using SSL checkbox.Note: The database must support and allow SSL connections for this setting to work correctly.

  2. Fill in the fields as follows:

    • SSL Certificate: The certificate (typically a CA or server certificate) Stitch should verify the SSL connection against. The connection will succeed only if the server’s certifcate verifies against the certificate provided.

      Note: Providing a certifcate via this property isn’t required to use SSL. This is only if Stitch should verify the connection against a specific certificate.

    • Use an SSL client key: If SSL client authentication should be used, check this box. This will display theClient Certificate andClient Key fields, which are both required when using client authentication.

    • Client Certificate: If using SSL client authentication, paste the client certificate Stitch should use into this field.Note: You must also provide aClient Key for the connection to be successful.

    • Client Key: If using SSL client authentication, paste the client key Stitch should use into this field.Note: You must also provide aClient Certificate for the connection to be successful.

Step 5.5: Define the Log-based Replication setting

In theLog-based Replication section, you can set this as the integration’s default Replication Method.

When enabled, tables that are set to replicate will useLog-based Incremental Replication by default. If you don’t want a table to use Log-based Incremental Replication, you can change it in the Table Settings page for that table.

If this setting isn’t enabled, you’ll have to select aReplication Method for each table you set to replicate.

Step 5.6: Create a replication schedule

Replication schedules affect the time Extraction begins, not the time to data loaded. Refer to theReplication Scheduling documentation for more information.

In theReplication Frequency section, you’ll create the integration’sreplication schedule. An integration’s replication schedule determines how often Stitch runs a replication job, and the time that job begins.

Microsoft Azure MySQL integrations support the following replication scheduling methods:

To keep your row usage low, consider setting the integration to replicate less frequently. See theUnderstanding and Reducing Your Row Usage guide for tips on reducing your usage.

Step 5.7: Save the integration

When finished, clickCheck and Save.

Stitch will perform a connection test to the Microsoft Azure MySQL database; if successful, aSuccess! message will display at the top of the screen.Note: This test may take a few minutes to complete.

Step 6: Select data to replicate

Is an object missing or not replicating? Verify that the object meets the requirements forselection andreplication.

The last step is to select the tables and columns you want to replicate.

Note: If a replication job is currently in progress, new selections won’t be used until the next job starts.

For Microsoft Azure MySQL integrations, you can select:

  1. Individual tables and columns

  2. All tables and columns (except views)

  3. Database views

Click the tabs to view instructions for each selection method.

  1. In the Integration Details page, click theTables to Replicate tab.
  2. Locate a table you want to replicate.

  3. Click thecheckbox next to the table’s name. A blue checkmark means the table is set to replicate.

  4. After you set a table to replicate, a page with the table’s columns will display. De-select columns if needed.

  5. Next, you’ll define the table’s Replication Method. Click theTable Settings button.
  6. In theTable Settings page:

    1. Define the table’sReplication Method, or skip this step if you want to use theintegration’s default method.

    2. If usingKey-based Incremental Replication, select aReplication Key.

    3. When finished, clickUpdate Settings.

  7. Repeat this process for every table you want to replicate.

  8. Click theFinalize Your Selections button at the bottom of the page to save your data selections.

Important: Before using this feature, note that:

  1. Using theSelect All feature will overwrite any previous selections. However, selections aren’t final untilFinalize Your Selections is clicked. ClickingCancel will restore your previous selections.

  2. Log-based Incremental Replication must be enabled and set as the default Replication Method to use the Select All feature.

Refer to theSelect All guide for more info about this feature.

  1. Click into the integration from the Stitch Dashboard page.

  2. Click theTables to Replicate tab.

  3. Navigate to the table level, selecting any databases and/or schemas that contain tables you want to replicate.

  4. In the list of tables, click the box next to theTable Names column.

  5. In the menu that displays, clickTrack AllTables and Fields (Except Views):

    The Track AllTables and Fields (Except Views) menu in the Tables to Replicate tab

  6. Click theFinalize Your Selections button at the bottom of the page to save your data selections.

Setting a database view to replicate is similar to selecting a table, with a few differences. Refer to theReplicating Database Views guide for detailed instructions.

At a high level, you’ll need to complete the following to select a database view:

  1. Verify the database user’s permissions
  2. Select the view
  3. Optional:Define the view’s Primary Key
  4. Define the view’s Replication Method
  5. Save the view’s settings

Initial and historical replication jobs

After you finish setting up Microsoft Azure MySQL, itsSync Status may show asPending on either the Stitch Dashboard or in the Integration Details page.

For a new integration, aPending status indicates that Stitch is in the process of scheduling the initial replication job for the integration.This may take some time to complete.

Initial replication jobs with Anchor Scheduling

If using Anchor Scheduling, an initial replication job may not kick off immediately. This depends on the selected Replication Frequency and Anchor Time. Refer to theAnchor Scheduling documentation for more information.

Free historical data loads

The first seven days of replication, beginning when data is first replicated, are free. Rows replicated from the new integration during this time won’t count towards your quota. Stitch offers this as a way of testing new integrations, measuring usage, and ensuring historical data volumes don’t quickly consume your quota.

Replication will continue after the seven days are over. If you’re no longer interested in this source, be sure topause ordelete the integration to prevent unwanted usage.
RelatedTroubleshooting
Questions? Feedback?

Did this article help? If you have questions or feedback, feel free tosubmit a pull request with your suggestions,open an issue on GitHub, orreach out to us.

[8]ページ先頭
©2009-2026 Movatter.jp