The target-mysql loader sends data into MySQL after it was pulled from a source using an extractor
Getting Started
Prerequisites
If you haven't already, follow the initial steps of the Getting Started guide:
Installation and configuration
-
Add the target-mysql loader to your
project using
:meltano add
-
Configure the target-mysql
settings using
:meltano config
meltano add loader target-mysql
meltano config target-mysql set --interactive
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
target-mysql
may have been automatically set when originally added to the Hub. Please review the
capabilities when using this loader. 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 loader.
This plugin has the following capabilities:
- about
- schema-flattening
- stream-maps
You can
override these capabilities or specify additional ones
in your meltano.yml
by adding the capabilities
key.
Settings
The
target-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:
allow_column_alter
database
driver_name
host
lower_case_table_names
password
port
replace_null
sqlalchemy_url
username
Expand To Show SDK Settings
You can also list these settings using
with the meltano config
list
subcommand:
meltano config target-mysql list
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.
Allow Column Alter (allow_column_alter)
-
Environment variable:
TARGET_MYSQL_ALLOW_COLUMN_ALTER
-
Default Value:
false
Allow column alter
Configure this setting directly using the following Meltano command:
meltano config target-mysql set allow_column_alter [value]
Database (database)
-
Environment variable:
TARGET_MYSQL_DATABASE
MySQL database
Configure this setting directly using the following Meltano command:
meltano config target-mysql set database [value]
Driver Name (driver_name)
-
Environment variable:
TARGET_MYSQL_DRIVER_NAME
-
Default Value:
mysql
SQLAlchemy driver name
Configure this setting directly using the following Meltano command:
meltano config target-mysql set driver_name [value]
Host (host)
-
Environment variable:
TARGET_MYSQL_HOST
MySQL host
Configure this setting directly using the following Meltano command:
meltano config target-mysql set host [value]
Lower Case Table Names (lower_case_table_names)
-
Environment variable:
TARGET_MYSQL_LOWER_CASE_TABLE_NAMES
-
Default Value:
true
Lower case table names
Configure this setting directly using the following Meltano command:
meltano config target-mysql set lower_case_table_names [value]
Password (password)
-
Environment variable:
TARGET_MYSQL_PASSWORD
MySQL password
Configure this setting directly using the following Meltano command:
meltano config target-mysql set password [value]
Port (port)
-
Environment variable:
TARGET_MYSQL_PORT
MySQL port
Configure this setting directly using the following Meltano command:
meltano config target-mysql set port [value]
Replace Null (replace_null)
-
Environment variable:
TARGET_MYSQL_REPLACE_NULL
-
Default Value:
false
Replace null to blank
Configure this setting directly using the following Meltano command:
meltano config target-mysql set replace_null [value]
Sqlalchemy URL (sqlalchemy_url)
-
Environment variable:
TARGET_MYSQL_SQLALCHEMY_URL
SQLAlchemy connection string
Configure this setting directly using the following Meltano command:
meltano config target-mysql set sqlalchemy_url [value]
Username (username)
-
Environment variable:
TARGET_MYSQL_USERNAME
MySQL username
Configure this setting directly using the following Meltano command:
meltano config target-mysql set username [value]
Expand To Show SDK Settings
Default Target Schema (default_target_schema)
-
Environment variable:
TARGET_MYSQL_DEFAULT_TARGET_SCHEMA
The default target database schema name to use for all streams.
Configure this setting directly using the following Meltano command:
meltano config target-mysql set default_target_schema [value]
Flattening Enabled (flattening_enabled)
-
Environment variable:
TARGET_MYSQL_FLATTENING_ENABLED
'True' to enable schema flattening and automatically expand nested properties.
Configure this setting directly using the following Meltano command:
meltano config target-mysql set flattening_enabled [value]
Flattening Max Depth (flattening_max_depth)
-
Environment variable:
TARGET_MYSQL_FLATTENING_MAX_DEPTH
The max depth to flatten schemas.
Configure this setting directly using the following Meltano command:
meltano config target-mysql set flattening_max_depth [value]
Stream Map Config (stream_map_config)
-
Environment variable:
TARGET_MYSQL_STREAM_MAP_CONFIG
User-defined config values to be used within map expressions.
Configure this setting directly using the following Meltano command:
meltano config target-mysql set stream_map_config [value]
Stream Maps (stream_maps)
-
Environment variable:
TARGET_MYSQL_STREAM_MAPS
Config object for stream maps capability. For more information check out Stream Maps.
Configure this setting directly using the following Meltano command:
meltano config target-mysql set stream_maps [value]
Something missing?
This page is generated from a YAML file that you can contribute changes to.
Edit it on GitHub!Looking for help?
#plugins-general
channel.