storekit

storekit

import "github.com/kitsunium/sdk/framework/internal/kit/storekit"

Package storekit is what framework/kit/store plugs into kit: the engines kit's stores run on — the SDK's document store in memory, in the data directory and over SQL —, kit's scope on a database — the SDK's transaction manager, its check and its migrator — and the migrations of kit's tables (ADR 0179 §1). kit's core imports neither the SDK's docstore nor its sql: it reaches them through plug, and a product that declares no store links none of them.

Package storekit — the compile-time proof that the engines are kit's.

Index

• func Enable()
• func SQLOf(db plug.Database) (tm sql.Transactor, dialect sql.Dialect, ok bool)

func Enable

func Enable()

Enable plugs the stores' engines, kit's scope on a database and the migrations of kit's tables into kit.

func SQLOf

func SQLOf(db plug.Database) (tm sql.Transactor, dialect sql.Dialect, ok bool)

SQLOf is the SDK's transaction manager and dialect of db, a database this package opened: what the queues' SQL broker runs on, so that a publication joins the transaction its context carries (ADR 0179 step 4), and what a mailer's spool defers its announcements on (step 6); false for a database it did not open.

Generated from docs/api by tools/genindex.