httk.store.mongo.results

Materialized MongoDB result sets and live keyset pages.

Classes

MongoResultSet

A materialized MongoDB result set with named rows and scalar helpers.

Module Contents

class httk.store.mongo.results.MongoResultSet(searcher, outputs=None)

A materialized MongoDB result set with named rows and scalar helpers.

Parameters:

• searcher (httk.store.mongo.searcher.MongoSearcher) – The search plan to freeze.

• outputs (list[Any] | None) – Optional replacement output declarations.

names

first()

Return the first row or None.

one()

Return the sole row.

Raises:

• NoResultError – If no row exists.

• MultipleResultsError – If multiple rows exist.

Returns:

The sole result row.

Return type:

httk.store.query.ResultRow

scalars(name=None)

Iterate one named output from each row.

column(name)

Return an iterator over one scalar output.

Mongo packet 4a keeps this optional capability intentionally small; object-output validation is performed from the frozen output plan.

page(*, size, order_by, cursor=None, include_total=False)

Fetch one bounded live page using a strict MongoDB keyset seek.

Parameters:

• size (int) – The maximum number of verified rows to return.

• order_by (collections.abc.Iterable[httk.store.query.PageOrder]) – Root scalar result projections used as order keys.

• cursor (httk.store.query.ContinuationToken | None) – A continuation token returned by a preceding page.

• include_total (bool) – Whether to calculate the exact server-side total.

Returns:

The requested immutable result page.

Return type:

httk.store.query.ResultPage