Text Search
specdraftimplproposalGeneral text search in multiple text properties of the data.
Scope
Conformance Classes
Text Search implements requirements of the section "Parameter q" of the draft OGC API - Records - Part 1: Core.
Query Parameters
| Name | Resources | Description |
|---|---|---|
q | Features | General text search in multiple text properties of the data. Search terms are separated by comma. If at least one of the search terms is included in an item, it is included in the result set. |
Configuration
Options
| Name | Default | Description | Type | Since |
|---|---|---|---|---|
buildingBlock | Always TEXT_SEARCH. | string | v2.0 | |
extensionType | Deprecated See buildingBlock. | string | v2.0 | |
enabled | false | Enable the building block? | boolean | v2.0 |
properties | [] | Controls which of the queryable attributes are used for text search. | array | v2.0 |
Examples
- buildingBlock: TEXT_SEARCH
enabled: true
properties:
- name
- description
- function