barrel_server_dbs (barrel_server v1.5.0)

View Source

Server-side database access: a thin, stateless shim over Barrel's database lifecycle manager (barrel_dbs), which owns the open handles, touches them on use, closes idle ones, and bounds the open set. This module adds only the HTTP concerns: name validation and the server-wide open options from the app env.

Summary

Functions

branch(Parent, BranchName, Opts)

Fork Parent into BranchName. Opts: at => now | HlcT.

close(Name)

Close and forget the database Name. Idempotent.

destroy(Name)

Destroy the database Name: close it and delete its files.

ensure(Name)

Return the (possibly newly opened) handle for Name.

ensure(Name, Opts)

Same as ensure/1, with Opts (e.g. #{docdb => #{att_opts => ...}}) merged over the server-wide open_opts() baseline -- only takes effect on a cold open (genuinely new, or reopened after being closed): an already-open Name short-circuits in barrel_dbs before Opts is ever consulted.

list()

Names of the currently open databases.

Functions

branch(Parent, BranchName, Opts)

-spec branch(binary(), binary(), map()) -> {ok, barrel:db()} | {error, term()}.

Fork Parent into BranchName. Opts: at => now | HlcT.

close(Name)

-spec close(binary()) -> ok.

Close and forget the database Name. Idempotent.

destroy(Name)

-spec destroy(binary()) -> ok | {error, term()}.

Destroy the database Name: close it and delete its files.

ensure(Name)

-spec ensure(binary()) -> {ok, barrel:db()} | {error, term()}.

Return the (possibly newly opened) handle for Name.

ensure(Name, Opts)

-spec ensure(binary(), map()) -> {ok, barrel:db()} | {error, term()}.

Same as ensure/1, with Opts (e.g. #{docdb => #{att_opts => ...}}) merged over the server-wide open_opts() baseline -- only takes effect on a cold open (genuinely new, or reopened after being closed): an already-open Name short-circuits in barrel_dbs before Opts is ever consulted.

list()

-spec list() -> [binary()].

Names of the currently open databases.