Common
A feature provider is defined in a configuration file by an object with the following properties. Properties without default are mandatory.
| Name | Default | Description | Type | Since |
|---|---|---|---|---|
id | Unique identifier of the entity, has to match the filename. Allowed characters are (A-Z, a-z), numbers (0-9), underscore and hyphen. | string | v2.0 | |
providerType | Always FEATURE. | string | v2.0 | |
providerSubType | SQL for SQL DBMS as data source, WFS for OGC Web Feature Service as data source. | string | v2.0 | |
featureProviderType | Deprecated See providerSubType. | string | v2.0 | |
nativeCrs | CRS84 | Coordinate reference system of geometries in the dataset. The EPSG code of the coordinate reference system is given as integer in code. forceAxisOrder may be set to use a non-default axis order: LON_LAT uses longitude/east as first value and latitude/north as second value, LAT_LON uses the reverse. NONE uses the default axis order and is the default value. Example: The default coordinate reference system CRS84 would look like this: code: 4326 and forceAxisOrder: LON_LAT. | object | v2.0 |
nativeTimeZone | UTC | A timezone ID, such as Europe/Berlin. Is applied to temporal values without timezone in the dataset. | object | v2.0 |
typeValidation | NONE | Optional type definition validation with regard to the data source (only for SQL). NONE means no validation. With LAX the validation will fail and the provider will not start, when issues are detected that would definitely lead to runtime errors. Issues that might lead to runtime errors depending on the data will be logged as warning. With STRICT the validation will fail for any detected issue. That means the provider will only start if runtime errors with regard to the data source can be ruled out. | string | v2.0 |
labelTemplate | string | v2.0 | ||
types | Definition of feature types, see below. | object | v2.0 | |
auto | false | Option to derive types definitions automatically from the data source. When enabled types must not be set. | boolean | v2.0 |
autoPersist | false | Option to persist definitions generated with auto: true to the configuration file. Will remove auto und autoPersist from the configuration file. If the configuration file does not reside in store/entities/providers (see additionalLocations), a new file will be created in store/entities/providers. The store must not be READ_ONLY for this to take effect. | boolean | v2.0 |
autoTypes | [] | List of source types to include in derived types definitions when auto: true. Currently only works for SQL. | array | v2.0 |
Types
| Name | Default | Description | Type | Since |
|---|---|---|---|---|
sourcePath | string | v2.0 | ||
path | Deprecated See sourcePath. | string | v2.0 | |
sourcePaths | [sourcePath] | array | v2.0 | |
type | STRING/OBJECT | Data type of the schema object. Default is OBJECT when properties is set, otherwise it is STRING. Possible values: - FLOAT, INTEGER, STRING, BOOLEAN, DATETIME, DATE for simple values. - GEOMETRY for geometries. - OBJECT for objects. - OBJECT_ARRAY a list of objects. - VALUE_ARRAY a list of simple values. | string | v2.0 |
role | null | ID has to be set for the property that should be used as the unique feature id. As a rule that should be the first property ion the properties object. Property names cannot contain spaces (" ") or slashes ("/"). Set TYPE for a property that specifies the type name of the object. | string | v2.0 |
valueType | STRING | Only needed when type is VALUE_ARRAY. Possible values: FLOAT, INTEGER, STRING, BOOLEAN, DATETIME, DATE | string | v2.0 |
geometryType | null | The specific geometry type for properties with type: GEOMETRY. Possible values are simple feature geometry types: POINT, MULTI_POINT, LINE_STRING, MULTI_LINE_STRING, POLYGON, MULTI_POLYGON, GEOMETRY_COLLECTION and ANY | string | v2.0 |
objectType | Optional name for an object type, used for example in JSON Schema. For properties that should be mapped as links according to RFC 8288, use Link. | string | v2.0 | |
label | Label for the schema object, used for example in HTML representations. | string | v2.0 | |
description | Description for the schema object, used for example in HTML representations or JSON Schema. | string | v2.0 | |
unit | The unit of measurement of the value, only relevant for numeric properties. | string | v2.0 | |
constantValue | null | Might be used instead of sourcePath to define a property with a constant value. | string | v2.0 |
scope | null | Optional scope for properties that should only be used when either reading ( QUERIES) or writing (MUTATIONS) features. | string | v2.0 |
transformations | [] | Optional transformations for the property, see transformations. | array | v2.0 |
constraints | {} | Optional description of schema constraints, especially for JSON schema generation. See Constraints. | object | v2.0 |
forcePolygonCCW | true | Option to disable enforcement of counter-clockwise orientation for exterior rings and a clockwise orientation for interior rings (only for SQL). | boolean | v2.0 |
properties | Only for OBJECT and OBJECT_ARRAY. Object with the property names as keys and schema objects as values. | object | v2.0 |
Connection Info
For data source specifics, see SQL and WFS.
Example Configuration (SQL)
See the feature provider of the API Vineyards in Rhineland-Palatinate, Germany.