A Meltano target for MySQL.
Project description
macrometa-target-mongo
macrometa-target-mysql
is a Macrometa connector for writing data into MySQL, can be used as a target for any
Data Mesh Integration.
Installation
Use PIP for installation:
pip install macrometa-target-mysql
Configuration
The available configuration options for macrometa-target-mysql
are:
Property | Type | Required? | Description |
---|---|---|---|
host | String | Yes | MySQL host |
port | Int | Yes | MySQL port |
username | String | Yes | MySQL user |
password | Password | Yes | MySQL password |
database | String | Yes | MySQL database name |
target_table | String | Yes | Destination table name |
replace_null | Boolean | No | Replace null values with default values |
batch_flush_size | Int | No | Maximum size of batch. Exceeding this will trigger a batch flush |
batch_flush_interval | Int | No | Time between batch flush executions |
lower_case_table_names | Boolean | No | Use lowercase for table names or not. This will update target table name to lower case |
allow_column_alter | Boolean | No | Allow column alterations if target table's column type doesn't match the source column type |
hard_delete | Boolean | No | When hard_delete option is true, DELETE SQL commands will be performed in Postgres to delete rows |
ssl | Boolean | No | If set to true then use SSL for connecting with MySQL. |
If the server does not accept SSL connections or the client certificate is not recognized | |||
then the connection will fail. | |||
ssl_check_hostname | Boolean | No | Flag to configure whether SSL handshake should verify that the certificate |
matches the DB hostname. | |||
ssl_root_ca_cert | File | No | Specific CA certificate in PEM string format. This is most often the case |
when using self-signed server certificate. |
|||
ssl_client_certificate | File | No | Specific client certificate in PEM string format. The private key for the client |
certificate should be specified in a different parameter, SSL Client Key. | |||
ssl_client_key | File | No | Specific client key in PEM string format. |
Configurations can be stored in a JSON configuration file and specified using the --config
flag with
macrometa-target-mysql
.
The replace_null
Option (Experimental)
By enabling the replace_null
option, null values are replaced with 'empty' equivalents based on their data type.
Use with caution as it may alter data semantics.
When replace_null
is true
, null values are replaced as follows:
JSON Schema Data Type | Null Value Replacement |
---|---|
string | Empty string("" ) |
number | 0 |
object | Empty object({} ) |
array | Empty array([] ) |
boolean | false |
null | null |
Usage
cat <input_stream> | macrometa-target-mysql --config <config.json>
<input_stream>
: Input data stream<config.json>
: JSON configuration file
macrometa-target-mysql
reads data from a Singer Tap and writes it to a MySQL database. Run Singer Tap to generate
data before launching macrometa-target-mysql
.
Here's an example of using Singer Tap with macrometa-target-mysql
:
tap-exchangeratesapi | target-mysql --config config.json
In this case, tap-exchangeratesapi
is a Singer Tap that generates exchange rate data. The data is passed to
macrometa-target-mysql
through a pipe(|
), and macrometa-target-mysql
writes it to a MySQL database. config.json
contains
macrometa-target-mysql
settings.
Developer Resources
Initializing the Development Environment
pipx install poetry
poetry install
Creating and Running Tests
Create tests in the macrometa_target_mysql/tests
subfolder and run:
poetry run pytest
Use poetry run
to test macrometa-target-mysql
CLI interface:
poetry run target-mysql --help
Testing with Meltano
Note: This target functions within a Singer environment and does not require Meltano.
Firstly, install Meltano and necessary plugins:
# Install Meltano
pipx install meltano
# Initialize Meltano in this directory
cd target-mysql
meltano install
Then, test and orchestrate with Meltano:
# Call tests:
meltano invoke macrometa-target-mysql --version
# Or execute pipeline with Carbon Intensity sample tap:
meltano run tap-carbon-intensity target-mysql
Reference Links
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for macrometa-target-mysql-0.0.8.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8d77b8cfc5beaaa71cc0ec401ea12329d27b68b1440ecea1d78ddf3cc387aeb6 |
|
MD5 | 5d62ebac64bd10a7e7c24c9016717c42 |
|
BLAKE2b-256 | 8ccbe87895598b8ca068567b8aaa9e301156c0304b9b958513515840b66044de |
Hashes for macrometa_target_mysql-0.0.8-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2a836f7614232f8147ace9b49faea93e7f0bc1a94e6f24a92467020866e9a55d |
|
MD5 | 8aff5d74e95a59a73c9991255c2806d4 |
|
BLAKE2b-256 | 58e60d272042459df36b2b95fbf84740fb2e206954def41c357135684b8f768c |