| Name | target-starrocks JSON |
| Version |
0.0.1a5
JSON |
| download |
| home_page | None |
| Summary | Singer target for StarRocks, built with the Meltano Singer SDK. |
| upload_time | 2025-10-24 06:48:14 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.13 |
| license | None |
| keywords |
elt
meltano
starrocks
singer-tap
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# target-starrocks
`target-starrocks` is a Singer target for [StarRocks].
Build with the [Meltano Target SDK][Singer SDK].
## Installation
Install from PyPI:
```bash
uv tool install target-starrocks
```
Install from GitHub:
```bash
uv tool install git+https://github.com/reservoir-data/target-starrocks.git@main
```
## Supported Python Versions
* 3.13
* 3.14
## 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
## 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
curl -LsSf https://astral.sh/uv/install.sh | sh # or see https://docs.astral.sh/uv/getting-started/installation/
uv sync
```
### Create and Run Tests
Create tests within the `tests` subfolder and
then run:
```bash
uv run pytest
```
You can also test the `target-starrocks` CLI interface directly using `uv run`:
```bash
uv 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._
Next, install Meltano (if you haven't already) and any needed plugins:
```bash
# Install meltano
uv tool install meltano
meltano config meltano set venv.backend uv
# 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 EL 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.13",
"maintainer_email": null,
"keywords": "ELT, Meltano, StarRocks, singer-tap",
"author": null,
"author_email": "Edgar Ram\u00edrez-Mondrag\u00f3n <edgarrm358@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/c3/19/798e967e3587ef8f5a1a111de736607f4b84e4ee4099ba69efd62770e601/target_starrocks-0.0.1a5.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## Installation\n\nInstall from PyPI:\n\n```bash\nuv tool install target-starrocks\n```\n\nInstall from GitHub:\n\n```bash\nuv tool install git+https://github.com/reservoir-data/target-starrocks.git@main\n```\n\n## Supported Python Versions\n\n* 3.13\n* 3.14\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## 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\ncurl -LsSf https://astral.sh/uv/install.sh | sh # or see https://docs.astral.sh/uv/getting-started/installation/\nuv sync\n```\n\n### Create and Run Tests\n\nCreate tests within the `tests` subfolder and\n then run:\n\n```bash\nuv run pytest\n```\n\nYou can also test the `target-starrocks` CLI interface directly using `uv run`:\n\n```bash\nuv 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\nNext, install Meltano (if you haven't already) and any needed plugins:\n\n```bash\n# Install meltano\nuv tool install meltano\nmeltano config meltano set venv.backend uv\n\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\n# OR run a test EL 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",
"bugtrack_url": null,
"license": null,
"summary": "Singer target for StarRocks, built with the Meltano Singer SDK.",
"version": "0.0.1a5",
"project_urls": null,
"split_keywords": [
"elt",
" meltano",
" starrocks",
" singer-tap"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "b0434c7664db2cd6e0f44676a528b0b8cf758b530efcf95206dde0c9aa48d9a5",
"md5": "f5c05a1854c2799a6d65712344e64741",
"sha256": "78eb8859d88dc06ea2dfa956aff4ffb3f6a5f42185e4446e0a1435ff8634d905"
},
"downloads": -1,
"filename": "target_starrocks-0.0.1a5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "f5c05a1854c2799a6d65712344e64741",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.13",
"size": 10248,
"upload_time": "2025-10-24T06:48:12",
"upload_time_iso_8601": "2025-10-24T06:48:12.910773Z",
"url": "https://files.pythonhosted.org/packages/b0/43/4c7664db2cd6e0f44676a528b0b8cf758b530efcf95206dde0c9aa48d9a5/target_starrocks-0.0.1a5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "c319798e967e3587ef8f5a1a111de736607f4b84e4ee4099ba69efd62770e601",
"md5": "56bfb3ff822703cf2b8cf923aa85563c",
"sha256": "41c0877d85ea95a64ed5479e258c341c1e27124c35ba3e11e784ac3b6743eab7"
},
"downloads": -1,
"filename": "target_starrocks-0.0.1a5.tar.gz",
"has_sig": false,
"md5_digest": "56bfb3ff822703cf2b8cf923aa85563c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.13",
"size": 81932,
"upload_time": "2025-10-24T06:48:14",
"upload_time_iso_8601": "2025-10-24T06:48:14.321232Z",
"url": "https://files.pythonhosted.org/packages/c3/19/798e967e3587ef8f5a1a111de736607f4b84e4ee4099ba69efd62770e601/target_starrocks-0.0.1a5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-10-24 06:48:14",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "target-starrocks"
}
