api.rst

:mod:`hypatia.catalog`

.. automodule:: hypatia.catalog

  .. autoclass:: Catalog
     :members:

     .. automethod:: __setitem__

     .. automethod:: __getitem__

        Retrieve an index.

     .. automethod:: get

        Retrieve an index or return failobj.

     .. automethod:: reset
        :no-index:

     .. automethod:: index_doc
        :no-index:

     .. automethod:: unindex_doc
        :no-index:

     .. automethod:: reindex_doc
        :no-index:

  .. autoclass:: CatalogQuery
     :members:

     .. automethod:: __call__

     .. automethod:: sort
        :no-index:

:mod:`hypatia.query`

.. module:: hypatia.query

Comparators

.. autoclass:: Contains
   :no-index:

.. autoclass:: Eq

.. autoclass:: NotEq

.. autoclass:: Gt

.. autoclass:: Lt

.. autoclass:: Ge

.. autoclass:: Le

.. autoclass:: Contains

.. autoclass:: NotContains

.. autoclass:: Any

.. autoclass:: NotAny

.. autoclass:: All

.. autoclass:: NotAll

.. autoclass:: InRange

.. autoclass:: NotInRange

Boolean Operators

.. autoclass:: Or

.. autoclass:: And

.. autoclass:: Not

Other Helpers

.. autoclass:: Name

.. autofunction:: parse_query

:mod:`hypatia.util`

.. automodule:: hypatia.util

  .. autoclass:: ResultSet
     :members:

:mod:`hypatia.exc`

.. automodule:: hypatia.exc

  .. autoclass:: BadResults

  .. autoclass:: MultipleResults

  .. autoclass:: NoResults

  .. autoclass:: Unsortable

:mod:`hypatia.field`

.. automodule:: hypatia.field

   .. autoclass:: FieldIndex
      :members:

:mod:`hypatia.keyword`

.. automodule:: hypatia.keyword

   .. autoclass:: KeywordIndex
      :members:

:mod:`hypatia.text`

.. automodule:: hypatia.text

   .. autoclass:: TextIndex
      :members:

:mod:`hypatia.facet`

.. automodule:: hypatia.facet

   .. autoclass:: FacetIndex
      :members:

:mod:`hypatia.interfaces`

.. automodule:: hypatia.interfaces

  .. attribute:: STABLE

     Used as an argument to the ``sort_type`` parameter of IIndexSort.sort.

  .. attribute:: OPTIMAL

     Used as an argument to the ``sort_type`` parameter of IIndexSort.sort.