Allgemein

Jeder Feature-Provider wird in einer Konfigurationsdatei in einem Objekt mit den folgenden Eigenschaften beschrieben. Werte ohne Defaultwert sind in diesem Fall Pflichtangaben.

NameDefaultBeschreibungTypSeit
id
Eindeutiger Identifikator der Entity, muss dem Dateinamen entsprechen. Erlaubt sind Buchstaben (A-Z, a-z), Ziffern (0-9), der Unterstrich ("_") und der Bindestrich ("-").
string
v2.0
providerType
Stets FEATURE.
string
v2.0
providerSubType
SQL für ein SQL-DBMS als Datenquelle, WFS für einen OGC Web Feature Service als Datenquelle.
string
v2.0
featureProviderType
Deprecated Siehe providerSubType.
string
v2.0
nativeCrs
CRS84
Das Koordinatenreferenzsystem, in dem Geometrien in dem Datensatz geführt werden. Der EPSG-Code des Koordinatenreferenzsystems wird als Integer in code angegeben. Mit forceAxisOrder kann die Koordinatenreihenfolge geändert werden: NONE verwendet die Reihenfolge des Koordinatenreferenzsystems, LON_LAT verwendet stets Länge/Ostwert als ersten und Breite/Nordwert als zweiten Wert, LAT_LON entsprechend umgekehrt. Beispiel: Das Default-Koordinatenreferenzsystem CRS84 entspricht code: 4326 und forceAxisOrder: LON_LAT.
object
v2.0
nativeTimeZone
UTC
Eine Zeitzonen-ID, z.B. Europe/Berlin. Wird auf temporale Werte ohne Zeitzone im Datensatz angewendet.
object
v2.0
typeValidation
NONE
Steuert ob die Spezifikationen der Objektarten daraufhin geprüft werden, ob sie zur Datenquelle passen (nur für SQL). NONE heißt keine Prüfung. Bei LAX schlägt die Prüfung fehl und der Start des Providers wird verhindert, wenn Probleme festgestellt werden, die in jedem Fall zu Laufzeitfehlern führen würden. Probleme die abhängig von den tatsächlichen Daten zu Laufzeitfehlern führen könnten, werden als Warnung geloggt. Bei STRICT führen alle festgestellten Probleme zu einem Fehlstart. Der Provider wird also nur gestartet, wenn keine Risiken für Laufzeitfehler im Zusammenhang mit der Datenquelle identifiziert werden.
string
v2.0
labelTemplate
string
v2.0
types
Definition of object types, see below.
object
v2.0
auto
false
Steuert, ob die Informationen zu types beim Start automatisch aus der Datenquelle bestimmt werden sollen (Auto-Modus). In diesem Fall sollte types nicht angegeben sein.
boolean
v2.0
autoPersist
false
Steuert, ob die im Auto-Modus (auto: true) bestimmten Schemainformationen in die Konfigurationsdatei übernommen werden sollen. In diesem Fall werden auto und autoPersist beim nächsten Start automatisch aus der Datei entfernt. Liegt die Konfigurationsdatei in einem anderen Verzeichnis als unter store/entities/providers (siehe additionalLocations), so wird eine neue Datei in store/entities/providers erstellt. autoPersist: true setzt voraus, dass store sich nicht im READ_ONLY-Modus befindet.
boolean
v2.0
autoTypes
[]
Liste von Quelltypen, die für die Ableitung der types Definitionen im Auto-Modus berücksichtigt werden sollen. Funktioniert aktuell nur für SQL.
array
v2.0

Types

NameDefaultBeschreibungTypSeit
sourcePath
Der relative Pfad zu diesem Schemaobjekt. Die Pfadsyntax ist je nach Provider-Typ unterschiedlich (SQL und WFS).
string
v2.0
path
Deprecated Siehe sourcePath.
string
v2.0
sourcePaths
[sourcePath]
Die relativen Pfade zu diesem Schemaobjekt. Die Pfadsyntax ist je nach Provider-Typ unterschiedlich (SQL und WFS).
array
v2.0
type
STRING/OBJECT
Der Datentyp des Schemaobjekts. Der Standardwert ist STRING, sofern nicht auch die Eigenschaft properties angegeben ist, dann ist es OBJECT. Erlaubt sind: - FLOAT, INTEGER, STRING, BOOLEAN, DATETIME, DATE für einfache Werte. - GEOMETRY für eine Geometrie. - OBJECT für ein Objekt. - OBJECT_ARRAY für eine Liste von Objekten. - VALUE_ARRAYfür eine Liste von einfachen Werten.
string
v2.0
role
null
Kennzeichnet besondere Bedeutungen der Eigenschaft. - ID ist bei der Eigenschaft eines Objekts anzugeben, die für die featureId in der API zu verwenden ist. Diese Eigenschaft ist typischerweise die erste Eigenschaft im properties-Objekt. Erlaubte Zeichen in diesen Eigenschaften sind alle Zeichen bis auf das Leerzeichen (" ") und der Querstrich ("/"). - TYPE ist optional bei der Eigenschaft eines Objekts anzugeben, die den Namen einer Unterobjektart enthält. - Hat eine Objektart mehrere Geometrieeigenschaften, dann ist PRIMARY_GEOMETRY bei der Eigenschaft anzugeben, die für bbox-Abfragen verwendet werden soll und die in GeoJSON in geometry oder in JSON-FG in where kodiert werden soll. - Hat eine Objektart mehrere zeitliche Eigenschaften, dann sollte PRIMARY_INSTANT bei der Eigenschaft angegeben werden, die für datetime-Abfragen verwendet werden soll, sofern ein Zeitpunkt die zeitliche Ausdehnung der Features beschreibt. - Ist die zeitliche Ausdehnung hingegen ein Zeitintervall, dann sind PRIMARY_INTERVAL_START und PRIMARY_INTERVAL_END bei den jeweiligen zeitlichen Eigenschaften anzugeben.
string
v2.0
valueType
STRING
Wird nur benötigt wenn type auf VALUE_ARRAY gesetzt ist. Mögliche Werte: FLOAT, INTEGER, STRING, BOOLEAN, DATETIME, DATE
string
v2.0
geometryType
null
Mit der Angabe kann der Geometrietype spezifiziert werden. Die Angabe ist nur bei Geometrieeigenschaften (type: GEOMETRY) relevant. Erlaubt sind die Simple-Feature-Geometrietypen, d.h. POINT, MULTI_POINT, LINE_STRING, MULTI_LINE_STRING, POLYGON, MULTI_POLYGON, GEOMETRY_COLLECTION und ANY.
string
v2.0
objectType
Optional kann ein Name für den Typ spezifiziert werden. Der Name hat i.d.R. nur informativen Charakter und wird z.B. bei der Erzeugung von JSON-Schemas verwendet. Bei Eigenschaften, die als Web-Links nach RFC 8288 abgebildet werden sollen, ist immer "Link" anzugeben.
string
v2.0
label
Eine Bezeichnung des Schemaobjekts, z.B. für die Angabe in der HTML-Ausgabe.
string
v2.0
description
Eine Beschreibung des Schemaobjekts, z.B. für die HTML-Ausgabe oder das JSON-Schema.
string
v2.0
unit
Die Maßeinheit des Wertes, nur relevant bei numerischen Eigenschaften.
string
v2.0
constantValue
null
Alternativ zu sourcePath kann diese Eigenschaft verwendet werden, um im Feature-Provider eine Eigenschaft mit einem festen Wert zu belegen.
string
v2.0
scope
null
Optionaler Geltungsbereich für Eigenschaften die entweder nur beim Lesen (QUERIES) * oder beim Schreiben (MUTATIONS) verwendet werden sollen.
string
v2.0
transformations
[]
Optionale Transformationen für die Eigenschaft, siehe Transformationen.
array
v2.0
constraints
{}
Optionale Beschreibung von Schema-Einschränkungen, vor allem für die Erzeugung von JSON-Schemas. Siehe Constraints.
object
v2.0
forcePolygonCCW
true
Option zum Erzwingen der Orientierung von Polygonen, gegen den Uhrzeigersinn für äußere Ringe und mit dem Uhrzeigersinn für innere Ringe (nur für SQL).
boolean
v2.0
properties
Nur bei OBJECT und OBJECT_ARRAY. Ein Objekt mit einer Eigenschaft pro Objekteigenschaft. Der Schüssel ist der Name der Objekteigenschaft, der Wert das Schema-Objekt zu der Objekteigenschaft.
object
v2.0

Connection Info

Informationen zu den Datenquellen finden Sie auf separaten Seiten: SQL und WFS.

Example Configuration (SQL)

Als Beispiel siehe die Provider-Konfigurationopen in new window der API Weinlagen in Rheinland-Pfalzopen in new window.