<title>QWC Fulltext Search Service</title>

QWC Fulltext Search Service

Type: object

root $schema

JSON Schema

Type: stringFormat: uri Default: "https://raw.githubusercontent.com/qwc-services/qwc-fulltext-search-service/master/schemas/qwc-search-service.json"

Reference to JSON schema of this config

root service

Service name

Type: const
Specific value: "search"

root config

Config options

Type: object

root config search_backend
Type: string

Search backend: solr or pg. Default: solr.

root config solr_service_url
Type: string

SOLR service URL

root config solr_service_auth
Type: object

SOLR service basic authentication. Default: None

root config solr_service_auth username
Type: string

Username for SOLR service authentication

root config solr_service_auth password
Type: string

Password for SOLR service authentication

root config search_result_sort
Type: string

Search result ordering for solr search results. Default: searchresultsort

root config pg_feature_query
Type: string

Postgres feature query SQL. You can use the placeholder parameters :term (full search string), :terms (list of words of the search string), :thres (similarity threshold), :facets (the permitted search facets, as a list) and :facetlimit (maximum number of results per facet). The query must return the columns display, facetid, idfieldname, featureid, bbox (as a [xmin,ymin,xmax,ymax] string), srid.

root config pg_feature_query_template
Type: string

Jinja template string to generate the feature query SQL. The following variables are passed to the template: searchtext (the full search text, as a string), words (the single words of the search text, as an array), facets (the permitted search facets, as an array) and facetlimit (maximum number of results per facet). The generated SQL can accept the same placeholder parameters and must return the columns as documented in pg_feature_query.

root config pg_layer_query
Type: string

Postgres layer query SQL. You can use the placeholder parameters :term (full search string), :terms (list of words of the search string), :thres (similarity threshold) and :facets (the permitted search facets, as a list). The query must return the columns display, dataproductid, dsetinfo, sublayers, stacktype.

root config pg_layer_query_template
Type: string

Jinja template string to generate the layer query SQL. The following variables are passed to the template: searchtext (the full search text, as a string), words (the single words of the search text, as an array) and facets (the permitted search facets, as an array). The generated SQL can accept the same placeholder parameters and must return the columns as documented in pg_layer_query.

root config pg_facet_search_limit
Type: number Default: 50

Postgres search result limit per facet. Controls the facetlimit parameter passed to the trgm_feature_query. Note: trgm_facet_search_limit + 1 will be passed to the query, and the results will be limited to trgm_facet_search_limit in the backed, in order to discover where more than trgm_facet_search_limit results exist, in which case the backend will return count: -1 in the facet result counts.

root config trgm_feature_query
Type: string

DEPRECATED - use pgfeaturequery instead

root config trgm_feature_query_template
Type: string

DEPRECATED - use pgfeaturequery_template instead

root config trgm_layer_query
Type: string

DEPRECATED - use pglayerquery instead

root config trgm_layer_query_template
Type: string

DEPRECATED - use pglayerquery_template instead

root config trgm_facet_search_limit
Type: number Default: 50

DEPRECATED - use pgfacetsearch_limit instead

root config trgm_similarity_threshold
Type: number

Trigram similarity treshold. Default: 0.3

root config word_split_re
Type: string Default: "[\\s,.:;\"]+"

Word split Regex

root config search_result_limit
Type: integer Default: 50

Result count limit per search

root config db_url
Type: string

Default DB connection for geometry result query

root resources

Resources

Type: object

root resources facets

Search facets

Type: array of object
No Additional Items

Each item of this array must be:

root resources facets Facet

Facet

Type: object

root resources facets Facet name
Type: string

Facet name

root resources facets Facet filter_word
Type: string

root resources facets Facet table_name
Type: string Default: "search_v"

Table/View for search result geometries

root resources facets Facet geometry_column
Type: string Default: "geom"

Geometry column in search result table

root resources facets Facet facet_column
Type: string Default: "subclass"

Facet name column in search result table

root resources facets Facet db_url
Type: string

DB connection for geometry result query