From caacbbd1c1a3699ba7e3c5a50659912c7c3c6fc8 Mon Sep 17 00:00:00 2001 From: Virgil Date: Sat, 4 Apr 2026 14:36:40 +0000 Subject: [PATCH] docs(store): clarify SQLite journal implementation Co-Authored-By: Virgil --- doc.go | 3 ++- store.go | 3 +++ 2 files changed, 5 insertions(+), 1 deletion(-) diff --git a/doc.go b/doc.go index a68b1a2..4280e57 100644 --- a/doc.go +++ b/doc.go @@ -1,6 +1,7 @@ // Package store provides SQLite-backed key-value storage for grouped entries, // TTL expiry, namespace isolation, quota enforcement, reactive change -// notifications, workspace journalling, and orphan recovery. +// notifications, SQLite journal writes, workspace journalling, and orphan +// recovery. // // Workspace files live under `.core/state/` and can be recovered with // `RecoverOrphans(".core/state/")`. diff --git a/store.go b/store.go index 3c8fcc6..1de5c24 100644 --- a/store.go +++ b/store.go @@ -83,6 +83,9 @@ func (journalConfig JournalConfiguration) isConfigured() bool { journalConfig.BucketName != "" } +// Store is the SQLite KV store with TTL expiry, namespace isolation, +// reactive events, SQLite journal writes, and orphan recovery. +// // Usage example: `storeInstance, err := store.NewConfigured(store.StoreConfig{DatabasePath: ":memory:", Journal: store.JournalConfiguration{EndpointURL: "http://127.0.0.1:8086", Organisation: "core", BucketName: "events"}, PurgeInterval: 30 * time.Second})` // Usage example: `value, err := storeInstance.Get("config", "colour")` type Store struct { -- 2.45.3