codenotary / immudb / 30468081253

85%

master: 85%

Build Type

Pull #2113

gh-ci

Committed by vchaindz

Commit Message

docs(embedding): add an in-process embedding guide and runnable examples

immudb can run fully in-process as a Go library, with no server and no
container, but nothing in the repository explained how. Readers had to infer the
approach from the test suite and guess which layer to build against.

Adds docs/EMBEDDING.md covering:

  - choosing between pkg/database and embedded/store + embedded/sql
  - why the SQL engine needs a multi-indexing store
  - the single-writer constraint: immudb does not lock its data directory, so
    concurrent processes over one directory need external coordination
  - the on-disk layout
  - how to confirm a build links no server code

Adds three runnable companions, so the guide cannot drift from working code:

  - examples/embedded/main.go       end-to-end pkg/database walkthrough
  - embedded/store/example_test.go  verifiable KV against the raw store
  - embedded/sql/example_test.go    embedded SQL against the raw engine

The two example_test.go files are Go Example tests with expected output, so
`go test` fails if the documented behaviour ever changes.

Links the guide from the README paragraph describing immudb as embeddable.

Pull Request Pull Request #2113: docs(embedding): add an in-process embedding guide and runnable examples

Coverage Stats

0 of 76 new or added lines in 1 file covered. (0.0%)

1 existing line in 1 file now uncovered.

45241 of 53301 relevant lines covered (84.88%)

126033.56 hits per line