catalogstatediscoveraboutstream-mapsschema-flatteningbatch
- 3.12
- 3.13
- 3.14
This tap doesn't have any settings of its own, but it does support the following built-in SDK settings:
| Setting | Required | Default | Description |
|---|---|---|---|
| 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. |
| faker_config | False | None | Config for the Faker 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. |
| batch_config | False | None | |
| batch_config.encoding | False | None | Specifies the format and compression of the batch files. |
| batch_config.encoding.format | False | None | Format to use for batch files. |
| batch_config.encoding.compression | False | None | Compression format to use for batch files. |
| batch_config.storage | False | None | Defines the storage layer to use when writing batch files |
| batch_config.storage.root | False | None | Root path to use when writing batch files. |
| batch_config.storage.prefix | False | None | Prefix to use when writing batch files. |
A full list of supported settings and capabilities is available by running: tap-fedidb --about
The FediDB API doesn't require authentication at this time.
You can easily run tap-fedidb by itself or in a pipeline using Meltano.
tap-fedidb --version
tap-fedidb --help
tap-fedidb --config CONFIG --discover > ./catalog.jsonYou will need the following tools to develop and test this tap:
- Python 3.12+
- uv
Run integration tests:
uvx --with=tox-uv tox -e 3.12You can also test the tap-fedidb CLI interface directly:
uvx --with=tox-uv tox -e syncTesting 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.
Your project comes with a custom meltano.yml project file already created. Go ahead and install Meltano if you haven't already.
-
Install all plugins
meltano install
-
Check that the extractor is working properly
meltano invoke tap-fedidb --version
-
Execute an ELT pipeline
meltano run tap-fedidb target-jsonl
See the dev guide for more instructions on how to use the SDK to develop your own taps and targets.