https://github.com/data-fair/processing-gpkg
Create datasets from a geopackage (gpkg) file
https://github.com/data-fair/processing-gpkg
Last synced: about 1 month ago
JSON representation
Create datasets from a geopackage (gpkg) file
- Host: GitHub
- URL: https://github.com/data-fair/processing-gpkg
- Owner: data-fair
- License: agpl-3.0
- Created: 2026-04-16T08:25:38.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2026-06-09T14:29:48.000Z (about 2 months ago)
- Last Synced: 2026-06-09T16:21:59.315Z (about 2 months ago)
- Language: TypeScript
- Size: 227 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 
@data-fair/processing-gpkg
A plugin that allows the creation and management of datasets from geopackage files or zip files that contain them.
## Features
- **List layers** — Lists the layers and corresponding information in your file
- **Dataset management** — Create or update a REST or file dataset from the desired layers, configurable from the processing parameters.
- **Graceful stop** — honours the stop signal from the platform and exits cleanly mid-run; optionally, the stop can be ignored to test forced termination after timeout.
## Configuration
The plugin configurations change depending on the datasetMode to be applied. There are three of them:
- `list` to list the different layers
- `create` to create a new dataset
- `update` to target an existing one
Overall, only the URL in the settings tab remains common, representing a stable URL from which the data file is downloaded (this is the only possible option, there is no repository).
### list
For this mode, you only need to enter the URL in the Parameters tab.
### create
| Tab | Field | Description |
| --- | ----- | ----------- |
| Datasets | `editableCreate` | By default, file-based datasets are created ; by checking this box, editable datasets can be created |
| File layers | `addAllLayers` | Allows you to build datasets directly for all layers of the file |
| File layers - Layers | `add` | Allows you to build a dataset with the corresponding layer by checking the box |
| File layers - Layers | `title` | This corresponds to the name you want for your dataset. By default, the title will be the layer name. |
### update
| Tab | Field | Description |
| --- | ----- | ----------- |
| Datasets | `datasets` | List of datasets to be updated, taking into account the layer and the schema update forcing |
| Datasets - Datasets to update | `dataset` | Name of the dataset to update, selectable from the list of available datasets |
| Datasets - Datasets to update | `layer` | Name of the layer from which the update should be made, selectable from the list of available layers. |
| Datasets - Datasets to update | `forceUpdate` | Indicates whether the scheme update should also be forced |
*Note: the detection of the type of dataset (file or editable) during the update is done automatically, so it is possible to update datasets of both types at the same time.*
## Release
Publishing is handled automatically by CI: the plugin is pushed to the data-fair registry (`@data-fair/registry`), not to the public npm registry — there is no manual `npm publish`. A push to `main`/`master` publishes to the staging registry; pushing a `v*` tag publishes to production:
```bash
npm version minor # version bump + v* tag
git push --follow-tags # CI publishes to the production registry
```