search

dscat.queries.search(cat, query, dataset, version, all_versions, table_name, scale, limit, raw)

Full-text search features by name, title, definition, value coding, and notes.

Query terms expand through the synonym table and run as an FTS5 BM25 match, where a lower rank is a better match. Set raw to pass an FTS5 MATCH expression through unchanged.

Parameters:

• cat (dscat.index.Catalogue) – Open catalogue to read from.

• query (str) – Search text, or a raw FTS5 MATCH expression when raw is set.

• dataset (str or None) – Restrict to one dataset.

• version (str or None) – Pin a version (needs dataset); the default scope is the latest.

• all_versions (bool) – Search every version instead of only the latest.

• table_name (str or None) – Restrict to one table.

• scale (str or None) – Keep only features with this field type or measurement scale.

• limit (int) – Maximum number of rows to return.

• raw (bool) – Treat query as a verbatim FTS5 MATCH expression.

Returns:

Matching features with their rank, best first.

Return type:

collections.abc.Sequence of sqlalchemy.engine.RowMapping