org.models.search

Module Contents

Classes

Search

Provides collections with pagination, if they implement a few
class org.models.search.Search(request: onegov.org.request.OrgRequest, query: str, page: int)[source]

Bases: onegov.core.collection.Pagination[onegov.core.collection._M]

Provides collections with pagination, if they implement a few documented properties and methods.

See onegov.ticket.TicketCollection for an example.

property q: str[source]
property page_index: int[source]

Returns the current page index (starting at 0).

results_per_page = 10[source]
max_query_length = 100[source]
available_documents() → int[source]
explain() → bool[source]
__eq__(other: object) → bool[source]

Returns True if the current and the other Pagination instance are equal. Used to find the current page in a list of pages.

subset() → Response | None[source]

Returns an SQLAlchemy query containing all records that should be considered for pagination.

page_by_index(index: int) → Search[_M][source]

Returns the page at the given index. A page here means an instance of the class inheriting from the Pagination base class.

batch() → Response | None[source]

Returns the elements on the current page.

load_batch_results() → list[onegov.search.dsl.Hit][source]

Load search results and sort events by latest occurrence.

This methods is a wrapper around batch.load(), which returns the actual search results form the query.

feeling_lucky() → str | None[source]
subset_count() → int[source]

Returns the total number of elements this pagination represents.

suggestions() → tuple[str, Ellipsis][source]