search.mixins ============= .. py:module:: search.mixins Classes ------- .. autoapisummary:: search.mixins.Searchable search.mixins.ORMSearchable search.mixins.SearchableContent Module Contents --------------- .. py:class:: Searchable Defines the interface required for an object to be searchable. Note that ``es_id ``, ``es_properties`` and ``es_type_name`` must be class properties, not instance properties. So do this:: class X(Searchable): es_properties = {} es_type_name = 'x' But do not do this:: class X(Searchable): @property def es_properties(self): return {} @property def es_type_name(self): return 'x' The rest of the properties may be normal properties. **Polymorphic Identities** If SQLAlchemy's Polymorphic Identities are used, each identity must have it's own unqiue ``es_type_name``. Though such models may share the ``es_properties`` from the base class, we don't assume anything and store each polymorphic identity in its own index. From the point of view of elasticsearch, each different polymorphic identity is a completely different model. .. py:attribute:: TEXT_SEARCH_COLUMN_NAME :value: 'fts_idx' .. py:attribute:: TEXT_SEARCH_DATA_COLUMN_NAME :value: 'fts_idx_data' .. py:property:: fts_idx :type: sqlalchemy.Column[object] The column for the full text search index. .. py:method:: es_properties() -> dict[str, Any] :classmethod: :abstractmethod: Returns the type mapping of this model. Each property in the mapping will be read from the model instance. The returned object needs to be a dict or an object that provides a ``to_dict`` method. Internally, onegov.search stores differing languages in different indices. It does this automatically through langauge detection, or by manually specifying a language. Note that objects with multiple languages are not supported (each object is supposed to have exactly one language). Onegov.search will automatically insert the right analyzer for types like these. There's currently only limited support for properties here, namely objects and nested mappings do not work! This is going to be added in the future though. .. py:method:: es_type_name() -> str :classmethod: :abstractmethod: Returns the unique type name of the model. .. py:method:: es_id() -> str :classmethod: :abstractmethod: The name of the id attribute (not the actual value!). If you use this on an ORM model, be sure to use a primary key, all other properties are not available during deletion. .. py:property:: es_language :type: str Defines the language of the object. By default 'auto' is used, which triggers automatic language detection. Automatic language detection is reasonably accurate if provided with enough text. Short texts are not detected easily. When 'auto' is used, expect some content to be misclassified. You should then search over all languages, not just the epxected one. This property can be used to manually set the language. .. py:property:: es_public :type: bool :abstractmethod: Returns True if the model is available to be found by the public. If false, only editors/admins will see this object in the search results. .. py:property:: es_skip :type: bool Returns True if the indexing of this specific model instance should be skipped. .. py:property:: es_suggestion :type: collections.abc.Sequence[str] | str Returns suggest-as-you-type value of the document. The field used for this property should also be indexed, or the suggestion will lead to nowhere. If a single string is returned, the completion input equals the completion output. (My Title -> My Title) If an array of strings is returned, all values are possible inputs and the first value is the output. (My Title/Title My -> My Title) .. py:property:: es_last_change :type: datetime.datetime | None Returns the date the document was created/last modified. .. py:property:: es_tags :type: list[str] | None Returns a list of tags associated with this content. .. py:class:: ORMSearchable Bases: :py:obj:`Searchable` Extends the default :class:`Searchable` class with sensible defaults for SQLAlchemy orm models. .. py:attribute:: es_id :type: ClassVar[str] The name of the id attribute (not the actual value!). If you use this on an ORM model, be sure to use a primary key, all other properties are not available during deletion. .. py:method:: es_type_name() -> str :classmethod: Returns the unique type name of the model. .. py:property:: es_last_change :type: datetime.datetime | None Returns the date the document was created/last modified. .. py:class:: SearchableContent Bases: :py:obj:`ORMSearchable` Adds search to all classes using the core's content mixin: :class:`onegov.core.orm.mixins.content.ContentMixin` .. py:attribute:: es_properties Returns the type mapping of this model. Each property in the mapping will be read from the model instance. The returned object needs to be a dict or an object that provides a ``to_dict`` method. Internally, onegov.search stores differing languages in different indices. It does this automatically through langauge detection, or by manually specifying a language. Note that objects with multiple languages are not supported (each object is supposed to have exactly one language). Onegov.search will automatically insert the right analyzer for types like these. There's currently only limited support for properties here, namely objects and nested mappings do not work! This is going to be added in the future though. .. py:property:: es_public :type: bool Returns True if the model is available to be found by the public. If false, only editors/admins will see this object in the search results. .. py:property:: es_suggestions :type: dict[str, list[str]] .. py:property:: es_tags :type: list[str] | None Returns a list of tags associated with this content.