GraphQL

implproposalmainnone

The features are retrieved from a GraphQL API. This feature provider is experimental and has severe limitations.

Configuration

Options

NameDefaultDescriptionTypeSince
queries
Options for query generation, for details see Queries below.
object
v3.5

Connection Info

The connection info object for GraphQL has the following properties:

NameDefaultDescriptionTypeSince
uri
The URI of the GraphQL endpoint.
string
v2.0
user
The user name for HTTP Basic Auth.
string
v2.0
password
The base64 encoded password for HTTP Basic Auth.
string
v2.0

Query Generation

Options for query generation.

NameDefaultDescriptionTypeSince
collection
Options for collection queries.
object
v3.5
single
null
Options for single feature queries. If not set, a collection query will be used.
object
v3.5

Collection queries

NameDefaultDescriptionTypeSince
name
Name of the GraphQL query.
string
v3.5
arguments
Arguments for the GraphQL query.
object
v3.5
fields
Subfields or arguments for specific types.
object
v3.5

Arguments for collection queries

NameDefaultDescriptionTypeSince
id
Argument to select a feature with a specific id. String template where {{sourcePath}} is replaced with the name of the id property and {{value}} is replaced with the actual id.
string
v3.5
limit
null
Argument to limit the number of selected features. String template where {{value}} is replaced with the limit.
string
v3.5
offset
null
Argument to change the index of the first feature in the overall result set. String template where {{value}} is replaced with the offset.
string
v3.5
filter
null
Argument that wraps filter expressions. String template where {{value}} is replaced with the filter expressions.
string
v3.5
bbox
null
Argument for a bounding box filter. String template where {{sourcePath}} is replaced with the name of the primary spatial property and {{value}} is replaced with spatial value (see geometry below).
string
v3.5
geometry
null
Argument that wraps geometries in filter expressions. String template where {{value}} is replaced with the spatial value. A filter to convert the geometry to a textual representation is required, currently only toWkt is supported ({{value | toWkt}}).
string
v3.5

Single queries

NameDefaultDescriptionTypeSince
name
Name of the GraphQL query.
string
v3.5
arguments
Arguments for the GraphQL query.
object
v3.5
fields
Subfields for specific types.
object
v3.5

Arguments for single queries

NameDefaultDescriptionTypeSince
id
Argument to select a feature with a specific id. String template where {{sourcePath}} is replaced with the name of the id property and {{value}} is replaced with the actual id.
string
v3.5

Special subfields

NameDefaultDescriptionTypeSince
geometry
null
Subfield or argument for properties of type GEOMETRY. String template where {{sourcePath}} is replaced with the name of the spatial property.
string
v3.5