Module

store

github.com/riducms/ridu/store — Build and read document values for the local API and hooks. This package also defines the interfaces database adapters implement.

Interfaces 3

Types 19

Values 9

Functions 9

  • store.String()

    Construct a typed string field value.

  • store.CanonicalAuthIdentity()

    Normalize an authentication identity to its adapter-neutral storage and lookup key.

  • store.ValidateDistinctRequest()

    Validate the bounded direct-field distinct contract.

  • store.ListPageBounds()

    Normalize list paging and calculate safe half-open result bounds.

  • store.ValidateDocumentID()

    Validate one canonical adapter-neutral document ID.

  • store.CountedPage()

    CountedPage returns the normalized page for documents read at the bounds ListPageBounds computes for the requested page, limit and exact total.

  • store.HasLiveHead()

    HasLiveHead reports whether a working document read for an update has a live head. Authoring reads of draft-enabled collections carry the live revision. Without drafts, every write publishes or removes the live head together with the working status, so the document is published exactly when its live head exists.

  • store.TrimUncountedPage()

    TrimUncountedPage removes the overflow row from a SkipTotal read of at most limit+1 documents and reports whether it existed. Adapters trim before population so the overflow row is never materialized further.

  • store.UncountedPageBounds()

    UncountedPageBounds normalizes a SkipTotal list read without a total. The adapter reads at most limit+1 rows starting at offset; an offset of math.MaxInt cannot hold a document.

Methods 30

Optional store capabilities 15

Authentication adapter contracts 12

Version adapter contracts 2

Publishing adapter contracts 1

Task adapter contracts 7

Reference integrity 3

Safety bounds 28

Errors 1

Constants 33

Variables 6