CLI

The Data Hub provides the following CLI commands that ca be run via Djangos manage.py system.

INFO

If you run the system inside a Docker container you need to prefix the commands with docker compose exec datahub, i.e., docker compose exec datahub python manage.py <command>.

Load shapes

To import the prepared shape files use the following commands. A GeoPackage (.gpkg) or Shapefile (.shp) can be used. See the Shape documentation for required/optional attributes in the file.

python manage.py loadshapes <file>

Data Layer

To interact with the Data Layers on the CLI the following management commands exist. <key> stands for the key of a Data Layer, you can provide multiple keys separated by , and use patterns with *.

Managing Data Layers:

python manage.py dl_init <key>
python manage.py dl_copy <source_key> <target_key>
python manage.py dl_rename <source_key> <target_key>

# Batch update of a single field of the Data Layer model
python manage.py dl_update <key|s> --attr <attr> --value <value>

# Delete metadata, log, processed data, class file, 
# add --data to also delete data dir 
python manage.py dl_delete <key>

Processing:

python manage.py dl_download <key|s>
python manage.py dl_process <key|s>

# Delete processed data and log
python manage.py dl_reset <key|s>

Exporting and importing:

# Metadata (model definitions) of the Data Layers
python manage.py dl_dump_data <key|s>
python manage.py dl_dump_meta <key|s>

# Processed data
python manage.py dl_restore_data <file>
python manage.py dl_restore_meta <file>

Centroid

To calculate the centroid of all loaded shapes use the following command.

python manage.py centroid

Export

Export the database contents to a single file. This doesn't export raw data that are stored on the file system, only the database contents. It's a wrapper for pg_dump.

python manage.py dump [<file>]

Import

Imports a previously created dump. It's a wrapper for pg_restore.

python manage.py restore <file>