search.dsl
==========

.. py:module:: search.dsl


Classes
-------

.. autoapisummary::

   search.dsl.Search
   search.dsl.Response
   search.dsl.Hit
   search.dsl.BoundResponse


Functions
---------

.. autoapisummary::

   search.dsl.type_from_hit
   search.dsl.explanation_value


Module Contents
---------------

.. py:function:: type_from_hit(hit: elasticsearch_dsl.response.Hit) -> str

.. py:class:: Search(*args: Any, **kwargs: Any)

   Bases: :py:obj:`elasticsearch_dsl.Search`


   Extends elastichsearch_dsl's search object with ORM integration.

   Works exactly the same as the original, but the results it returns offer
   additional methods to query the SQLAlchemy models behind the results (if
   any).



   .. py:attribute:: session
      :type:  sqlalchemy.orm.Session | None


   .. py:attribute:: mappings
      :type:  onegov.search.indexer.TypeMappingRegistry


   .. py:attribute:: _response_class


   .. py:property:: explain
      :type: bool



   .. py:method:: _clone() -> Self

      Return a clone of the current search request. Performs a shallow copy
      of all the underlying objects. Used internally by most state modifying
      APIs.



   .. py:method:: _get_result(*args: Any, **kwargs: Any) -> BoundHit


.. py:class:: Response(search, response, doc_class=None)

   Bases: :py:obj:`elasticsearch_dsl.response.Response`


   Extends the default response (list of results) with additional
   methods to query the SQLAlchemy models behind the results.



   .. py:method:: bind(session: sqlalchemy.orm.Session | None, mappings: onegov.search.indexer.TypeMappingRegistry | None, explain: bool) -> type[Response.bind.BoundResponse]
      :classmethod:



   .. py:method:: hits_by_type(type: str) -> collections.abc.Iterator[elasticsearch_dsl.response.Hit]


   .. py:method:: query(type: str) -> sqlalchemy.orm.Query[Any] | None

      Returns an SQLAlchemy query for the given type. You must provide
      a type, because a query can't consist of multiple unrelated tables.

      If no results match the type, None is returned.




   .. py:method:: load() -> list[Any]

      Loads all results by querying the SQLAlchemy session in the order
      they were returned by elasticsearch.

      Note that the resulting lists may include None values, since we are
      might get elasticsearch results for which we do not have a model
      on the database (the data is then out of sync).




.. py:function:: explanation_value(explanation: Any, text: str) -> dict[str, Any] | None

   Gets the value from the explanation for descriptions starting with
   the given text.



.. py:class:: Hit(document)

   Bases: :py:obj:`elasticsearch_dsl.response.Hit`


   Extends a single result with additional methods to query the SQLAlchemy
   models behind the results.



   .. py:method:: bind(model: type[onegov.search.mixins.Searchable] | None, session: sqlalchemy.orm.Session | None) -> type[Hit.bind.BoundHit]
      :classmethod:



   .. py:method:: query() -> sqlalchemy.orm.Query[Any]

      Returns the SQLAlchemy query for this result. 



   .. py:method:: load() -> Any

      Loads this result from the SQLAlchemy session. 



.. py:class:: BoundResponse(search, response, doc_class=None)

   Bases: :py:obj:`Response`


   Extends the default response (list of results) with additional
   methods to query the SQLAlchemy models behind the results.



   .. py:attribute:: session
      :type:  sqlalchemy.orm.Session | None


   .. py:attribute:: mappings
      :type:  onegov.search.indexer.TypeMappingRegistry | None


   .. py:attribute:: explain
      :type:  bool