Storebrand have moved on from Meltano, and we're therefore no longer maintaining this repository.
tap-pxwebapi is a Singer tap for the PxWebApi used by statistical agencies in Norway, Sweden, Denmark and possibly some other countries to disseminate official statistics.
Because the API has no pagination and a max cell count, some tables might be hard to sync. There are some solutions to this that could be implemented in the tap, but most of them are difficult to implement.
Currently, the only way to handle this is to split up a table into multiple streams, using the select functionality to load only a subset of values for each table.
Initial sync might be very difficult for the same reason. Some workarounds are on the way.
Built with the Meltano Tap SDK for Singer Taps.
Install from GitHub:
pipx install git+https://github.com/radbrt/tap-pxwebapi.git@maincatalogstatediscoveraboutstream-mapsschema-flattening
In order to configure this tap correctly, a general knowledge of the PxWebApi is probably necessary. See the documentation at https://www.ssb.no/api/pxwebapi (or similar pages for the Swedish and Danish statistical agencies).
| Setting | Required | Default | Description |
|---|---|---|---|
| base_url | False | https://data.ssb.no/api/v0/ | Base API URL |
| tables | True | None | Tables to read |
| 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. |
The tables key contains a list of tables to sync. For columns where only specific values are needed, use the select key to filter the request. Columns that are omitted will, depending on the type of column, either return all values or return the top-level value. Details about this can be found in the API documentation: https://www.ssb.no/api/pxwebapi.
example config:
config:
tables:
- table_name: example_table
table_id: '11618'
select:
- code: 'Region'
values:
- '30'In this example, we sync table 11618 to a destination table example_table. We filter the Region column to only request region '30'. The code name is taken from the code key of the metadata, and the values from the values array. See the table metadata for reference: https://data.ssb.no/api/v0/no/table/11618
tap-pxwebapi --about --format=markdown
A full list of supported settings and capabilities for this tap is available by running:
tap-pxwebapi --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-pxwebapi by itself or in a pipeline using Meltano.
tap-pxwebapi --version
tap-pxwebapi --help
tap-pxwebapi --config CONFIG --discover > ./catalog.jsonFollow these instructions to contribute to this project.
pipx install poetry
poetry installCreate tests within the tests subfolder and
then run:
poetry run pytestYou can also test the tap-pxwebapi CLI interface directly using poetry run:
poetry run tap-pxwebapi --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-pxwebapi
meltano installNow you can test and orchestrate using Meltano:
# Test invocation:
meltano invoke tap-pxwebapi --version
# OR run a test `elt` pipeline:
meltano elt tap-pxwebapi target-jsonlSee the dev guide for more instructions on how to use the SDK to develop your own taps and targets.