codenotary / immudb
85%
master: 85%

LAST BUILD BRANCH: dependabot/go_modules/github.com/prometheus/common-0.70.1
DEFAULT BRANCH: master
Repo Added
Files 311
Badge
Embed ▾
README BADGES
x

If you need to use a raster PNG badge, change the '.svg' to '.png' in the link

Markdown

Textile

RDoc

HTML

Rst

LAST BUILD ON BRANCH docs/embedding-guide
branch: docs/embedding-guide
CHANGE BRANCH
x

coverage: 84.878% (-0.09%) from 84.966%
30468081253

Pull #2113

gh-ci

vchaindz 
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 #2113: docs(embedding): add an in-process embedding guide and runnable examples

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

Relevant lines Covered
53301 RELEVANT LINES 45241 COVERED LINES
126033.56 HITS PER LINE
Source Files on docs/embedding-guide

Recent builds

Builds Branch Commit Type Ran Committer Via Coverage
30468081253 docs/embedding-guide 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 tes... Pull #2113 vchaindz gh-ci
84.88
See All Builds (4113)