# target-starrocks
`target-starrocks` is a Singer target for [Starrocks].
Build with the [Meltano Target SDK][Singer SDK].
<!--
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-starrocks
```
Install from GitHub:
```bash
pipx install git+https://github.com/ORG_NAME/target-starrocks.git@main
```
-->
## Supported Python Versions
* 3.9
* 3.10
* 3.11
* 3.12
* 3.13
## Configuration
### Accepted Config Options
| Setting | Required | Default | Description |
| :-------------------------------- | :------- | :---------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| user | False | None | User for the Starrocks database |
| password | False | None | Password for the Starrocks database |
| host | False | None | Host for the Starrocks database |
| port | False | 9030 | Port for the Starrocks database |
| database | True | None | Database name for the Starrocks database |
#### Additional Config Options
The following built-in configuration options are also supported:
| Setting | Required | Default | Description |
| :-------------------------------- | :------- | :---------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| default_target_schema | False | None | The default target database schema name to use for all streams. |
| hard_delete | False | 0 | Hard delete records. |
| add_record_metadata | False | None | Whether to add metadata fields to records. |
| load_method | False | TargetLoadMethods.APPEND_ONLY | The method to use when loading data into the destination. `append-only` will always write all input records whether that records already exists or not. `upsert` will update existing records and insert new records. `overwrite` will delete all existing records and insert all input records. |
| batch_size_rows | False | None | Maximum number of rows in each batch. |
| process_activate_version_messages | False | 1 | Whether to process `ACTIVATE_VERSION` messages. |
| validate_records | False | 1 | Whether to validate the schema of the incoming streams. |
| stream_maps | False | None | Config object for stream maps capability. For more information check out [Stream Maps](https://sdk.meltano.com/en/latest/stream_maps.html). |
| stream_map_config | False | None | User-defined config values to be used within map expressions. |
| faker_config | False | None | Config for the [`Faker`](https://faker.readthedocs.io/en/master/) instance variable `fake` used within map expressions. Only applicable if the plugin specifies `faker` as an addtional dependency (through the `singer-sdk` `faker` extra or directly). |
| faker_config.seed | False | None | Value to seed the Faker generator for deterministic output: https://faker.readthedocs.io/en/master/#seeding-the-generator |
| faker_config.locale | False | None | One or more LCID locale strings to produce localized output for: https://faker.readthedocs.io/en/master/#localization |
| flattening_enabled | False | None | 'True' to enable schema flattening and automatically expand nested properties. |
| flattening_max_depth | False | None | The max depth to flatten schemas. |
A full list of supported settings and capabilities is available by running: `target-starrocks --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.
### 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-starrocks` by itself or in a pipeline using [Meltano](https://meltano.com/).
### Executing the Target Directly
```bash
target-starrocks --version
target-starrocks --help
# Test using the "Smoke Test" tap:
tap-smoke-test | target-starrocks --config /path/to/target-starrocks-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 `tests` subfolder and
then run:
```bash
poetry run pytest
```
You can also test the `target-starrocks` CLI interface directly using `poetry run`:
```bash
poetry run target-starrocks --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-starrocks
meltano install
```
Now you can test and orchestrate using Meltano:
```bash
# Test invocation:
meltano invoke target-starrocks --version
# OR run a test `elt` pipeline with the Smoke Test sample tap:
meltano run tap-smoke-test target-starrocks
```
### 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.
[Starrocks]: https://starrocks.io
[Singer SDK]: https://sdk.meltano.com
Raw data
{
"_id": null,
"home_page": null,
"name": "target-starrocks",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "ELT, Starrocks",
"author": "Edgar Ram\u00edrez-Mondrag\u00f3n",
"author_email": "edgarrm358@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/cb/4f/6a2f36c063863396ced13fca59efc0ea05b18378dd5e0e609aa1001b0136/target_starrocks-0.0.1a2.tar.gz",
"platform": null,
"description": "# target-starrocks\n\n`target-starrocks` is a Singer target for [Starrocks].\n\nBuild with the [Meltano Target SDK][Singer SDK].\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-starrocks\n```\n\nInstall from GitHub:\n\n```bash\npipx install git+https://github.com/ORG_NAME/target-starrocks.git@main\n```\n\n-->\n\n## Supported Python Versions\n\n* 3.9\n* 3.10\n* 3.11\n* 3.12\n* 3.13\n\n## Configuration\n\n### Accepted Config Options\n\n| Setting | Required | Default | Description |\n| :-------------------------------- | :------- | :---------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| user | False | None | User for the Starrocks database |\n| password | False | None | Password for the Starrocks database |\n| host | False | None | Host for the Starrocks database |\n| port | False | 9030 | Port for the Starrocks database |\n| database | True | None | Database name for the Starrocks database |\n\n#### Additional Config Options\n\nThe following built-in configuration options are also supported:\n\n| Setting | Required | Default | Description |\n| :-------------------------------- | :------- | :---------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| default_target_schema | False | None | The default target database schema name to use for all streams. |\n| hard_delete | False | 0 | Hard delete records. |\n| add_record_metadata | False | None | Whether to add metadata fields to records. |\n| load_method | False | TargetLoadMethods.APPEND_ONLY | The method to use when loading data into the destination. `append-only` will always write all input records whether that records already exists or not. `upsert` will update existing records and insert new records. `overwrite` will delete all existing records and insert all input records. |\n| batch_size_rows | False | None | Maximum number of rows in each batch. |\n| process_activate_version_messages | False | 1 | Whether to process `ACTIVATE_VERSION` messages. |\n| validate_records | False | 1 | Whether to validate the schema of the incoming streams. |\n| stream_maps | False | None | Config object for stream maps capability. For more information check out [Stream Maps](https://sdk.meltano.com/en/latest/stream_maps.html). |\n| stream_map_config | False | None | User-defined config values to be used within map expressions. |\n| faker_config | False | None | Config for the [`Faker`](https://faker.readthedocs.io/en/master/) instance variable `fake` used within map expressions. Only applicable if the plugin specifies `faker` as an addtional dependency (through the `singer-sdk` `faker` extra or directly). |\n| faker_config.seed | False | None | Value to seed the Faker generator for deterministic output: https://faker.readthedocs.io/en/master/#seeding-the-generator |\n| faker_config.locale | False | None | One or more LCID locale strings to produce localized output for: https://faker.readthedocs.io/en/master/#localization |\n| flattening_enabled | False | None | 'True' to enable schema flattening and automatically expand nested properties. |\n| flattening_max_depth | False | None | The max depth to flatten schemas. |\n\nA full list of supported settings and capabilities is available by running: `target-starrocks --about`\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### 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-starrocks` by itself or in a pipeline using [Meltano](https://meltano.com/).\n\n### Executing the Target Directly\n\n```bash\ntarget-starrocks --version\ntarget-starrocks --help\n# Test using the \"Smoke Test\" tap:\ntap-smoke-test | target-starrocks --config /path/to/target-starrocks-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 `tests` subfolder and\n then run:\n\n```bash\npoetry run pytest\n```\n\nYou can also test the `target-starrocks` CLI interface directly using `poetry run`:\n\n```bash\npoetry run target-starrocks --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-starrocks\nmeltano install\n```\n\nNow you can test and orchestrate using Meltano:\n\n```bash\n# Test invocation:\nmeltano invoke target-starrocks --version\n# OR run a test `elt` pipeline with the Smoke Test sample tap:\nmeltano run tap-smoke-test target-starrocks\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\n[Starrocks]: https://starrocks.io\n[Singer SDK]: https://sdk.meltano.com\n\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "Singer target for Starrocks, built with the Meltano Singer SDK.",
"version": "0.0.1a2",
"project_urls": null,
"split_keywords": [
"elt",
" starrocks"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "d34d04783d8a1bc23e2e74e70b8c215fd94aede43d0de8b8aa2b67f812b0ec8f",
"md5": "467df9d59ef9455793ea4c79d8618a22",
"sha256": "99765de5d08b5ba6be77eca88d92aba81e4abd4f541e8128f2e880ccd1b933cd"
},
"downloads": -1,
"filename": "target_starrocks-0.0.1a2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "467df9d59ef9455793ea4c79d8618a22",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 10406,
"upload_time": "2024-12-30T23:00:39",
"upload_time_iso_8601": "2024-12-30T23:00:39.067583Z",
"url": "https://files.pythonhosted.org/packages/d3/4d/04783d8a1bc23e2e74e70b8c215fd94aede43d0de8b8aa2b67f812b0ec8f/target_starrocks-0.0.1a2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "cb4f6a2f36c063863396ced13fca59efc0ea05b18378dd5e0e609aa1001b0136",
"md5": "a2c8e3bf3b0439124d6d7da8afc9dbb3",
"sha256": "afd5588960d3f28514a6e27a37d3eb0f0b7def115a80771111185ef85f7fe146"
},
"downloads": -1,
"filename": "target_starrocks-0.0.1a2.tar.gz",
"has_sig": false,
"md5_digest": "a2c8e3bf3b0439124d6d7da8afc9dbb3",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 9141,
"upload_time": "2024-12-30T23:00:41",
"upload_time_iso_8601": "2024-12-30T23:00:41.472186Z",
"url": "https://files.pythonhosted.org/packages/cb/4f/6a2f36c063863396ced13fca59efc0ea05b18378dd5e0e609aa1001b0136/target_starrocks-0.0.1a2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-30 23:00:41",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "target-starrocks"
}
JSON