storeengine

storeengine

import "github.com/kitsunium/sdk/framework/internal/app/storeengine"

Package storeengine is what framework/app/store plugs into kit: the engines the framework's stores run on — the SDK's document store in memory, in the data directory and over SQL —, the framework's scope on a database — the SDK's transaction manager, its check and its migrator — and the migrations of the framework's tables (ADR 0179 §1). The framework'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 storeengine — the compile-time proof that the engines are the framework'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, the framework's scope on a database and the migrations of the framework's tables into the framework.

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.