tap-mysql - Meltano Hub

MySQL/MariaDB

tap-mysql from transferwise

MySQL/MariaDB database extractor

The tap-mysql extractor pulls data from MySQL/MariaDB that can then be sent to a destination using a loader.

Available Variants

singer-io
transferwise (default)

Getting Started

Prerequisites

If you haven't already, follow the initial steps of the Getting Started guide:

Known limitations

Note that this extractor is incompatible with the default datamill-co variants of target-postgres and target-snowflake, because they don't support stream names that include the source schema in addition to the table name: <schema>-<table>, e.g. public-accounts.

Instead, use the transferwise variants that were made to be used with this extractor: target-postgres and target-snowflake.

Installation and configuration

Add the tap-mysql extractor to your project using
```
meltano add
```
:

meltano add extractor tap-mysql

Configure the tap-mysql settings using
```
meltano config
```
:

meltano config tap-mysql set --interactive

Test that extractor settings are valid using

meltano config

meltano config tap-mysql test

Next steps

Follow the remaining steps of the Getting Started guide:

If you run into any issues, learn how to get help.

Capabilities

The current capabilities for tap-mysql may have been automatically set when originally added to the Hub. Please review the capabilities when using this extractor. If you find they are out of date, please consider updating them by making a pull request to the YAML file that defines the capabilities for this extractor.

This plugin has the following capabilities:

catalog
discover
state

You can override these capabilities or specify additional ones in your meltano.yml by adding the capabilities key.

Settings

The tap-mysql settings that are known to Meltano are documented below. To quickly find the setting you're looking for, click on any setting name from the list:

host
port
user
password
database
cursorclass
server_id
filter_dbs
use_gtid
engine
ssl
ssl_ca
ssl_cert
ssl_key
internal_hostname
session_sqls

You can override these settings or specify additional ones in your meltano.yml by adding the settings key.

Please consider adding any settings you have defined locally to this definition on MeltanoHub by making a pull request to the YAML file that defines the settings for this plugin.

Host (host)

Environment variable: TAP_MYSQL_HOST
Default Value: localhost

The MySQL/MariaDB hostname.

Port (port)

Environment variable: TAP_MYSQL_PORT
Default Value: 3306

The MySQL/MariaDB port.

User (user)

Environment variable: TAP_MYSQL_USER

The MySQL/MariaDB username.

Password (password)

Environment variable: TAP_MYSQL_PASSWORD

The MySQL/MariaDB password.

Database (database)

Environment variable: TAP_MYSQL_DATABASE

The MySQL/MariaDB database name.

Cursor Class (cursorclass)

Environment variable: TAP_MYSQL_CURSORCLASS

Cursor class used by PyMYSQL.

Server ID (server_id)

Environment variable: TAP_MYSQL_SERVER_ID

Used as the slave id when this tap is connecting to the server.

Filter DBs (filter_dbs)

Environment variable: TAP_MYSQL_FILTER_DBS

Comma separated list of schemas to extract tables only from particular schemas and to improve data extraction performance.

Use GTID (use_gtid)

Environment variable: TAP_MYSQL_USE_GTID
Default Value: false

Flag to enable log based replication using GTID.

Engine (engine)

Environment variable: TAP_MYSQL_ENGINE
Default Value: mysql

Indicate which flavor the server is, used for LOG_BASED with GTID. Can be either 'mysql' or 'mariadb'.

SSL (ssl)

Environment variable: TAP_MYSQL_SSL
Default Value: false

Whether the MySQL/MariaDB connection should use SSL.

SSL CA (ssl_ca)

Environment variable: TAP_MYSQL_SSL_CA

CA for self-signed SSL.

SSL Certificate (ssl_cert)

Environment variable: TAP_MYSQL_SSL_CERT

Certificate for self-signed SSL.

SSL Key (ssl_key)

Environment variable: TAP_MYSQL_SSL_KEY

Key for self-signed SSL.

Internal Hostname (internal_hostname)

Environment variable: TAP_MYSQL_INTERNAL_HOSTNAME

Override match hostname for Google cloud.

Session SQLs (session_sqls)

Environment variable: TAP_MYSQL_SESSION_SQLS
Default Value: ["SET @@session.time_zone='+0:00'","SET @@session.wait_timeout=28800","SET @@session.net_read_timeout=3600","SET @@session.innodb_lock_wait_timeout=3600"]

List of SQL commands to run when a connection made. This allows to set session variables dynamically, like timeouts.

Something missing?

This page is generated from a YAML file that you can contribute changes to.

Edit it on GitHub!

Looking for help?

If you're having trouble getting the tap-mysql extractor to work, look for an existing issue in its repository, file a new issue, or join the Meltano Slack community and ask for help in the

#plugins-general

channel.

Install

meltano add extractor tap-mysql

Homepage

Maintenance Status

Repo

https://github.com/transferwise/pipelinewise-tap-mysql

Maintainer

Meltano Stats

PyPI Stats

Keywords