# target-mysql
`target-mysql` is a Singer target for MySQL.
(forked from [radbrt/target-oracle](https://github.com/radbrt/target-oracle))
Build with the [Meltano Target SDK](https://sdk.meltano.com).
<!--
Developer TODO: Update the below as needed to correctly describe the install procedure. For instance, if you do not have a PyPi repo, or if you want users to directly install from your git repo, you can modify this step as appropriate.
## Installation
Install from PyPi:
```bash
pipx install target-mysql
```
Install from GitHub:
```bash
pipx install git+https://github.com/ORG_NAME/target-mysql.git@main
```
-->
## Configuration
### Accepted Config Options
<!--
Developer TODO: Provide a list of config options accepted by the target.
This section can be created by copy-pasting the CLI output from:
```
target-mysql --about --format=markdown
```
-->
A full list of supported settings and capabilities for this
target is available by running:
```bash
target-mysql --about
```
### Configure using environment variables
This Singer target will automatically import any environment variables within the working directory's
`.env` if the `--config=ENV` is provided, such that config values will be considered if a matching
environment variable is set either in the terminal context or in the `.env` file.
### Source Authentication and Authorization
<!--
Developer TODO: If your target requires special access on the destination system, or any special authentication requirements, provide those here.
-->
## Usage
You can easily run `target-mysql` by itself or in a pipeline using [Meltano](https://meltano.com/).
### Executing the Target Directly
```bash
target-mysql --version
target-mysql --help
# Test using the "Carbon Intensity" sample:
tap-carbon-intensity | target-mysql --config /path/to/target-mysql-config.json
```
## Developer Resources
Follow these instructions to contribute to this project.
### Initialize your Development Environment
```bash
pipx install poetry
poetry install
```
### Create and Run Tests
Create tests within the `target_mysql/tests` subfolder and
then run:
```bash
poetry run pytest
```
You can also test the `target-mysql` CLI interface directly using `poetry run`:
```bash
poetry run target-mysql --help
```
### Testing with [Meltano](https://meltano.com/)
_**Note:** This target will work in any Singer environment and does not require Meltano.
Examples here are for convenience and to streamline end-to-end orchestration scenarios._
<!--
Developer TODO:
Your project comes with a custom `meltano.yml` project file already created. Open the `meltano.yml` and follow any "TODO" items listed in
the file.
-->
Next, install Meltano (if you haven't already) and any needed plugins:
```bash
# Install meltano
pipx install meltano
# Initialize meltano within this directory
cd target-mysql
meltano install
```
Now you can test and orchestrate using Meltano:
```bash
# Test invocation:
meltano invoke target-mysql --version
# OR run a test `elt` pipeline with the Carbon Intensity sample tap:
meltano elt tap-carbon-intensity target-mysql
```
### SDK Dev Guide
See the [dev guide](https://sdk.meltano.com/en/latest/dev_guide.html) for more instructions on how to use the Meltano Singer SDK to
develop your own Singer taps and targets.
Raw data
{
"_id": null,
"home_page": "https://github.com/thkwag/target-mysql",
"name": "thk-target-mysql",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8.1,<=3.11",
"maintainer_email": "",
"keywords": "ELT,MySQL,Singer,Meltano",
"author": "Taehwan Kwag",
"author_email": "thkwag@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/e5/dd/adf7b231c6328e55788abdaad97465cc16b11c78fc235292b911d2e4de00/thk_target_mysql-0.1.3.tar.gz",
"platform": null,
"description": "# target-mysql\n\n`target-mysql` is a Singer target for MySQL.\n(forked from [radbrt/target-oracle](https://github.com/radbrt/target-oracle))\n\nBuild with the [Meltano Target SDK](https://sdk.meltano.com).\n\n<!--\n\nDeveloper TODO: Update the below as needed to correctly describe the install procedure. For instance, if you do not have a PyPi repo, or if you want users to directly install from your git repo, you can modify this step as appropriate.\n\n## Installation\n\nInstall from PyPi:\n\n```bash\npipx install target-mysql\n```\n\nInstall from GitHub:\n\n```bash\npipx install git+https://github.com/ORG_NAME/target-mysql.git@main\n```\n\n-->\n\n## Configuration\n\n### Accepted Config Options\n\n<!--\nDeveloper TODO: Provide a list of config options accepted by the target.\n\nThis section can be created by copy-pasting the CLI output from:\n\n```\ntarget-mysql --about --format=markdown\n```\n-->\n\nA full list of supported settings and capabilities for this\ntarget is available by running:\n\n```bash\ntarget-mysql --about\n```\n\n### Configure using environment variables\n\nThis Singer target will automatically import any environment variables within the working directory's\n`.env` if the `--config=ENV` is provided, such that config values will be considered if a matching\nenvironment variable is set either in the terminal context or in the `.env` file.\n\n### Source Authentication and Authorization\n\n<!--\nDeveloper TODO: If your target requires special access on the destination system, or any special authentication requirements, provide those here.\n-->\n\n## Usage\n\nYou can easily run `target-mysql` by itself or in a pipeline using [Meltano](https://meltano.com/).\n\n### Executing the Target Directly\n\n```bash\ntarget-mysql --version\ntarget-mysql --help\n# Test using the \"Carbon Intensity\" sample:\ntap-carbon-intensity | target-mysql --config /path/to/target-mysql-config.json\n```\n\n## Developer Resources\n\nFollow these instructions to contribute to this project.\n\n### Initialize your Development Environment\n\n```bash\npipx install poetry\npoetry install\n```\n\n### Create and Run Tests\n\nCreate tests within the `target_mysql/tests` subfolder and\n then run:\n\n```bash\npoetry run pytest\n```\n\nYou can also test the `target-mysql` CLI interface directly using `poetry run`:\n\n```bash\npoetry run target-mysql --help\n```\n\n### Testing with [Meltano](https://meltano.com/)\n\n_**Note:** This target will work in any Singer environment and does not require Meltano.\nExamples here are for convenience and to streamline end-to-end orchestration scenarios._\n\n<!--\nDeveloper TODO:\nYour project comes with a custom `meltano.yml` project file already created. Open the `meltano.yml` and follow any \"TODO\" items listed in\nthe file.\n-->\n\nNext, install Meltano (if you haven't already) and any needed plugins:\n\n```bash\n# Install meltano\npipx install meltano\n# Initialize meltano within this directory\ncd target-mysql\nmeltano install\n```\n\nNow you can test and orchestrate using Meltano:\n\n```bash\n# Test invocation:\nmeltano invoke target-mysql --version\n# OR run a test `elt` pipeline with the Carbon Intensity sample tap:\nmeltano elt tap-carbon-intensity target-mysql\n```\n\n### SDK Dev Guide\n\nSee the [dev guide](https://sdk.meltano.com/en/latest/dev_guide.html) for more instructions on how to use the Meltano Singer SDK to\ndevelop your own Singer taps and targets.\n",
"bugtrack_url": null,
"license": "Apache 2.0",
"summary": "`target-mysql` is a Singer target for MySQL, built with the Meltano Singer SDK.",
"version": "0.1.3",
"project_urls": {
"Homepage": "https://github.com/thkwag/target-mysql",
"Repository": "https://github.com/thkwag/target-mysql"
},
"split_keywords": [
"elt",
"mysql",
"singer",
"meltano"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "9b53a8935c652db06e4b21741dc4905ca808cb2ffb4d9ab6ec6bc4208e57bc07",
"md5": "488f0fc959a30979533209ce3fa4c049",
"sha256": "da484f12a2be85ee10647d1fb1bc552f1ba85bcaff970ac2a5b7f2cb7a87bf5c"
},
"downloads": -1,
"filename": "thk_target_mysql-0.1.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "488f0fc959a30979533209ce3fa4c049",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8.1,<=3.11",
"size": 114918,
"upload_time": "2023-07-20T07:57:21",
"upload_time_iso_8601": "2023-07-20T07:57:21.459602Z",
"url": "https://files.pythonhosted.org/packages/9b/53/a8935c652db06e4b21741dc4905ca808cb2ffb4d9ab6ec6bc4208e57bc07/thk_target_mysql-0.1.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "e5ddadf7b231c6328e55788abdaad97465cc16b11c78fc235292b911d2e4de00",
"md5": "de77de54d21328977b32937a6647b099",
"sha256": "28d5f30cd3ca622d00922ed9a0d798d140dd0f58bf593c1c096e01903dc8fea7"
},
"downloads": -1,
"filename": "thk_target_mysql-0.1.3.tar.gz",
"has_sig": false,
"md5_digest": "de77de54d21328977b32937a6647b099",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8.1,<=3.11",
"size": 101635,
"upload_time": "2023-07-20T07:57:23",
"upload_time_iso_8601": "2023-07-20T07:57:23.436777Z",
"url": "https://files.pythonhosted.org/packages/e5/dd/adf7b231c6328e55788abdaad97465cc16b11c78fc235292b911d2e4de00/thk_target_mysql-0.1.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-07-20 07:57:23",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "thkwag",
"github_project": "target-mysql",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "thk-target-mysql"
}