Extensions configuration
[extensions]
[extensions]
mode = "configured"
Whether the extensions follow their own tables ("configured") or are all forced off ("conformance").
[extensions.cursor_pagination]
offset nor cursor is paged.[extensions.cursor_pagination]
mode = "enabled"
fresh_requests = "offset"
Whether cursors are offered. Off, collections page by offset only and a cursor parameter is refused with InvalidRequest. With extensions.mode set to "conformance", collections page by offset whatever this says.
How a request that names neither offset nor cursor is paged while cursors are offered. Read only when extensions.cursor_pagination.mode is "enabled".
[extensions.temporal_delete_by_query]
DELETE /temporal/entities: a windowed, selector-scoped history purge the NGSI-LD temporal delete operations have no equivalent for.[extensions.temporal_delete_by_query]
mode = "disabled"
max_matches = 100000
Whether temporal delete-by-query is served on DELETE /temporal/entities. It acts on local history only and is never forwarded.
The most history instances one delete-by-query may remove. The matches are counted before anything is deleted, so a larger purge is refused whole with 403 TooManyResults and deletes nothing.
[extensions.temporal_aggregation_grouping]
aggrGroupBy and format=groupedValues.[extensions.temporal_aggregation_grouping]
mode = "disabled"
max_groups = 10000
Whether grouped temporal aggregation is served: calendar and cyclic time buckets, per-entity-member keys and value-in-effect keys, with groups of mixed units split rather than refused. Off, aggrGroupBy and groupedValues are refused with InvalidRequest.
The most distinct groups one grouped aggregation may produce. The groups are counted before they are computed, so a larger grouping is refused whole with 403 TooManyResults.
[extensions.temporal_linked_retrieval]
join, joinLevel and containedBy and retrieve the linked entities' temporal evolution over the request's window. Off, those parameters are refused with InvalidRequest, and a nested projection, a q hop or a retrieving join in a query body with BadRequestData.[extensions.temporal_linked_retrieval]
mode = "disabled"
Whether the extension is served. Off, the broker answers as a conformant broker that never implemented it.
[extensions.purge_dataset_scope]
datasetId and deleteAll on Purge Entities. On, DELETE /entities gains the per-datasetId precision Delete Attribute already has. Off, a datasetId or deleteAll there is refused with InvalidRequest.[extensions.purge_dataset_scope]
mode = "disabled"
Whether the extension is served. Off, the broker answers as a conformant broker that never implemented it.
[extensions.tenant_management]
/tenants. On, the broker serves the tenant collection, per-tenant introspection and suspend or resume through PATCH isActive, and advertises them at /info/sourceIdentity. No API operation ever drops a tenant's database.[extensions.tenant_management]
mode = "disabled"
Whether the extension is served. Off, the broker answers as a conformant broker that never implemented it.
[extensions.near_distance_band]
near geo-query bounded from both sides. On, a near carrying both minDistance and maxDistance matches the entities between the two, on queries, temporal queries, subscription geoQ and registration discovery. Off, the pair is refused with BadRequestData.[extensions.near_distance_band]
mode = "disabled"
Whether the extension is served. Off, the broker answers as a conformant broker that never implemented it.
[extensions.accept_language]
Accept-Language read as the language filter. On, a Retrieve or Query of entities, Temporal Evolutions or context source registrations that carries no lang takes its filter from Accept-Language, and the response carries Vary: Accept-Language. Off, the header is ignored.[extensions.accept_language]
mode = "disabled"
Whether the extension is served. Off, the broker answers as a conformant broker that never implemented it.
[extensions.q_target_languages]
q bracket may name as a target language.[extensions.q_target_languages]
mode = "disabled"
level = "language-tags"
Whether a q bracket may name a language tag. Off, a bracket names only what the NGSI-LD q grammar defines: [en] is admitted, [en-GB] is refused with BadRequestData. A query carrying a target language is held to the level every context source it reaches advertises.
What a q bracket may name while the extension is on. Read only when extensions.q_target_languages.mode is "enabled".