tap-planetscaleapi is a Singer tap for PlanetScale API.
Built with the Meltano Tap SDK for Singer Taps.
Install from PyPi:
pipx install tap-planetscaleapiInstall from GitHub:
pipx install git+https://github.com/reservoir-data/tap-planetscaleapi.git@maincatalogstatediscoveraboutstream-mapsschema-flatteningbatch
| Setting | Required | Default | Description |
|---|---|---|---|
| service_token_id | True | None | The service token ID, visible on the service token page |
| service_token | True | None | The service token value |
| stream_maps | False | None | Config object for stream maps capability. For more information check out Stream Maps. |
| stream_map_config | False | None | User-defined config values to be used within map expressions. |
| 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. |
| batch_config | False | None |
A full list of supported settings and capabilities is available by running: tap-planetscaleapi --about
- 3.10
- 3.11
- 3.12
- 3.13
- 3.14
A full list of supported settings and capabilities for this tap is available by running:
tap-planetscaleapi --aboutThis Singer tap 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.
You can easily run tap-planetscaleapi by itself or in a pipeline using Meltano.
tap-planetscaleapi --version
tap-planetscaleapi --help
tap-planetscaleapi --config CONFIG --discover > ./catalog.jsonFollow these instructions to contribute to this project.
curl -LsSf https://astral.sh/uv/install.sh | sh # or see https://docs.astral.sh/uv/getting-started/installation/
uv syncCreate tests within the tests subfolder and
then run:
uv run pytestYou can also test the tap-planetscaleapi CLI interface directly using uv run:
uv run tap-planetscaleapi --helpTesting with Meltano
Note: This tap 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:
# Install meltano
pipx install meltano
# Initialize meltano within this directory
cd tap-planetscaleapi
meltano installNow you can test and orchestrate using Meltano:
# Test invocation:
meltano invoke tap-planetscaleapi --version
# OR run a test `elt` pipeline:
meltano elt tap-planetscaleapi target-jsonlSee the dev guide for more instructions on how to use the SDK to develop your own taps and targets.