Customize how data is searched¶

As the application developer you can customize how end users can search for data.

Excluding a database model from site-wide searches¶

If you want a given model to never occur in the site-wide search window, then you can set its Model.show_in_site_search to False.

class lino.core.model.Model

show_in_site_search = True: Whether this model is to be included in the site-wide search window.

Customizing where quick search should search¶

The following two model attributes customize which fields to search when the quick search field is used.

class lino.core.model.Model

quick_search_fields = None

The fields to be included in queries with a quick search value.

If you don’t specify it, Lino searches all text fields on this model.

quick_search_fields_digit = None

As quick_search_fields, but this list is used when the search text contains only digits (and does not start with ‘0’).

If you don’t specify it, Lino searches all number fields on this model.

In your model declarations your specify these attributes as a string containing a space-separated list of field names. Lino resolves this string into a tuple of data elements during site startup.

If you want to not inherit this field from a parent using standard MRO, then you must set that field explicitly to None.

This is also used when a gridfilter has been set on a foreign key column which points to this model.

For end-user documentation see quick search field.