QWC Data Service

QWC Data Service

Type: object

root $schema

JSON Schema

Type: stringFormat: uri Default: "https://github.com/qwc-services/qwc-data-service/raw/master/schemas/qwc-data-service.json"

Reference to JSON schema of this config

root service

Service name

Type: const
Specific value: "data"

root config

Config options

Type: object

root config attachments_base_dir
Type: string

Base dir where attachments are stored

root config attachments_namespace_dir
Type: string

The namespace dir, below attachmentsbasedir. You can use {tenant}, {map}, {dataset}. Default is '{tenant}/{map}.{dataset}'

root config attachment_store_pattern
Type: string

The path pattern to use when saving attachments to disk. You can use {random}, {filename}, {ext} and {<field>}, where field refers to the value of the field <field> of the committed feature. Default is '{random}/{filename}'

root config allowed_attachment_extensions
Type: string

Comma separated list of allowed attachment file extensions, i.e. '.png,.jpg'

root config recaptcha_site_secret_key
Type: string

Captcha site secret key. Set to enable ReCAPTCHA verification for public users

root config max_attachment_file_size
Type: number

Maximum attachment file size in bytes

root config clamd_host
Type: string

Hostname of ClamD server listening on TCP port 3310. If set, uploaded files are checked by ClamAV

root config upload_user_field_suffix
Type: string

Field suffix where to log the username who last changed an upload field, i.e. <fieldname>__<suffix> for the field <fieldname>. If empty, username is not logged.

root config create_timestamp_field
Type: string

If specified, the timestamp of the creation of the record will be logged to the <createtimestampfield> field of the record.

root config edit_timestamp_field
Type: string

If specified, the timestamp of the last mutation to a record will be logged to the <edittimestampfield> field of the record.

root config write_utc_timestamps
Type: boolean

Whether to write the create/edit timestamps in UTC, as opposed to local time. Default: false

root config create_user_field
Type: string

If specified, the username of the user who created a record with be logged to the <createuserfield> field of the record.

root config edit_user_field
Type: string

If specified, the username of the last user who performed a mutation to a record with be logged to the <edituserfield> field of the record.

root config geometry_default_allow_null
Type: boolean

Whether to allow null geometries by default

root config allowed_extensions_per_dataset
Type: object

Loopup of allowed attachment file extensions per dataset, values as comma separated list, i.e. '.png,.jpg'

root config max_attachment_file_size_per_dataset
Type: object

Lookup of maximum attachment file size in bytes per dataset

root resources

Resources

Type: object

root resources datasets

Datasets

Type: array of object
No Additional Items

Each item of this array must be:

root resources datasets Dataset

Dataset

Type: object

PostgreSQL metadata and field constraints for a dataset

root resources datasets Dataset name
Type: string

Dataset name

root resources datasets Dataset db_url
Type: string

DB connection string for read and write access (or read-only access if dbwriteurl is present)

root resources datasets Dataset db_write_url
Type: string

Optional DB connection string for write access

root resources datasets Dataset schema
Type: string

root resources datasets Dataset fields
Type: array of object

Dataset fields with optional constraints

 No Additional Items

Each item of this array must be:

root resources datasets Dataset fields fields items
Type: object

root resources datasets Dataset fields fields items name
Type: string

Field name

root resources datasets Dataset fields fields items data_type
Type: enum (of string) Default: "text"

Must be one of:

  • "USER-DEFINED"
  • "bigint"
  • "boolean"
  • "character"
  • "character varying"
  • "date"
  • "double precision"
  • "file"
  • "integer"
  • "json"
  • "jsonb"
  • "numeric"
  • "real"
  • "smallint"
  • "text"
  • "time"
  • "timestamp with time zone"
  • "timestamp without time zone"
  • "uuid"

root resources datasets Dataset geometry

PostGIS geometry metadata

Type: object

root resources datasets Dataset geometry geometry_type
Type: enum (of string)

Must be one of:

  • "POINT"
  • "POINTZ"
  • "LINESTRING"
  • "LINESTRINGZ"
  • "POLYGON"
  • "POLYGONZ"
  • "MULTIPOINT"
  • "MULTIPOINTZ"
  • "MULTILINESTRING"
  • "MULTILINESTRINGZ"
  • "MULTIPOLYGON"
  • "MULTIPOLYGONZ"

root resources datasets Dataset geometry srid

SRID

Type: integer

Spatial Reference System Identifier (EPSG code)

root resources datasets Dataset geometry allow_null

Allow NULL geometries

Type: boolean Default: false

Allow setting geometry values to NULL