core/go-store
8
0
Fork 0
Code Issues 4 Pull requests Projects Releases Packages Wiki Activity Actions 2

docs(store): clarify shared journal flow

Browse source 
Co-Authored-By: Virgil <virgil@lethean.io>
This commit is contained in:
Virgil 2026-04-04 11:57:37 +00:00
parent 9450a293cf
commit 92db4b72ff
2 changed files with 4 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
journal.go
View file

@ -45,6 +45,8 @@ type journalExecutor interface {
}
// Usage example: `result := storeInstance.CommitToJournal("scroll-session", map[string]any{"like": 4}, map[string]string{"workspace": "scroll-session"})`
// Workspace.Commit uses this same journal write path before it updates the
// summary row in `workspace:NAME`.
func (storeInstance *Store) CommitToJournal(measurement string, fields map[string]any, tags map[string]string) core.Result {
if err := storeInstance.ensureReady("store.CommitToJournal"); err != nil {
return core.Result{Value: err, OK: false}

4
workspace.go
View file

@ -287,8 +287,8 @@ func (workspace *Workspace) Aggregate() map[string]any {
return fields
}
// Commit writes one journal row for the workspace and upserts the summary row
// in `workspace:NAME`.
// Commit writes one journal row for the workspace through the shared journal
// writer and upserts the summary row in `workspace:NAME`.
//
// Usage example: `result := workspace.Commit(); if !result.OK { return }; fmt.Println(result.Value)`
func (workspace *Workspace) Commit() core.Result {