Edit spatial and unlocated features of datasets via GeoJSON.
This service is integrated into qwc-docker, consult qwc-services.github.io for the general qwc-services documentation.
Uses PostgreSQL connection service or connection to a PostGIS database. This connection's user requires read and write access to the configured tables.
Uses PostgreSQL connection service qwc_geodb (GeoDB).
The user qwc_service_write requires read and write access to the configured tables
of the data layers from the QGIS project qwc_demo.qgs.
Setup PostgreSQL connection service file ~/.pg_service.conf:
[qwc_geodb]
host=localhost
port=5439
dbname=qwc_demo
user=qwc_service_write
password=qwc_service_write
sslmode=disable
The static config and permission files are stored as JSON files in $CONFIG_PATH with subdirectories for each tenant,
e.g. $CONFIG_PATH/default/*.json. The default tenant name is default.
Config options in the config file can be overridden by equivalent uppercase environment variables.
In addition, the following environment variables are supported:
| Name | Default | Description |
|---|---|---|
ERROR_DETAILS_LOG_ONLY |
False |
Whether to omit detailed errors in API responses, and write these only to the service log. |
- JSON schema
- File location:
$CONFIG_PATH/<tenant>/permissions.json
Example:
{
"$schema": "https://raw.githubusercontent.com/qwc-services/qwc-services-core/master/schemas/qwc-services-permissions.json",
"users": [
{
"name": "demo",
"groups": ["demo"],
"roles": []
}
],
"groups": [
{
"name": "demo",
"roles": ["demo"]
}
],
"roles": [
{
"role": "public",
"permissions": {
"data_datasets": [
{
"name": "qwc_demo.edit_points",
"attributes": [
"id",
"name",
"description",
"num",
"value",
"type",
"amount",
"validated",
"datetime"
],
"writable": true,
"creatable": true,
"readable": true,
"updatable": true,
"deletable": true
}
]
}
}
]
}Install dependencies and run:
# Setup venv
uv venv .venv
export CONFIG_PATH=<CONFIG_PATH>
uv run src/server.py
To use configs from a qwc-docker setup, set CONFIG_PATH=<...>/qwc-docker/volumes/config.
Set FLASK_DEBUG=1 for additional debug output.
Set FLASK_RUN_PORT=<port> to change the default port (default: 5000).
API documentation:
http://localhost:$FLASK_RUN_PORT/api/
The Docker image is published on Dockerhub.
See sample docker-compose.yml of qwc-docker.
JSON only defines recommendations or has no information concerning the encoding of some quite common used database data types. Following a description on how these are encoded in the data service API.
- Date: ISO date strings
YYYY-MM-DD - Datetime: ISO date/time strings
YYYY-MM-DDThh:mm:ss - UUID: Hex-encoded string format. Example:
'6fa459ea-ee8a-3ca4-894e-db77e160355e'
For operations like updating or deleting features, records are identified by
a feature id. This id refers to the primary key of the database
table and is usually kept constant over time.
Query operations support passing filter expressions to narrow down the results. This expression is a serialized JSON array of the format:
[["<name>", "<op>", <value>],"and|or",["<name>","<op>",<value>],...]
-
nameis the attribute column name. Ifnamebegins with?, the filter is only applied if the column name exists. -
opcan be one of"=", "!=", "<>", "<", ">", "<=", ">=", "~", "LIKE", "ILIKE", "IS", "IS NOT", "HAS", "HAS NOT", "IN"The operators are applied on the original database types.
The operator
~is a shorthand forILIKE.The
HASandHAS NOToperators is used to check if an array field contains / does not contain a value.The
INoperators is used to check if a field value is part of the specified array value.If value is
null, the operator should beISorIS NOT. -
valuecan be of typestring,int,floatornull.For string operations, the SQL wildcard character
%can be used.
Examples:
- Find all features in the dataset with a number field smaller 10 and a matching name field:
[["name","LIKE","example%"],"and",["number","<",10]] - Find all features in the dataset with a last change before 1st of January 2020 or having
NULLas lastchange value:[["lastchange","<","2020-01-01T12:00:00"],"or",["lastchange","IS",null]]
# Run all tests
python test.py
# Run single test module
python -m unittest tests.feature_validation_tests
# Run single test case
python -m unittest tests.feature_validation_tests.FeatureValidationTestCase
# Run single test method
python -m unittest tests.feature_validation_tests.FeatureValidationTestCase.test_field_constraints