v0.6.0-rc.1
HomeDocumentationGoing deeper

A place for everything.

Understand the project data, private runtime and what portability actually means.

Where files live

LocationPurpose
./Database/Project data, database metadata, owned locks and encrypted diagnostics
Private Windows application dataExtracted executable, DPAPI-protected credential/data-key vault and temporary TLS sessions
Your chosen backup locationAn authenticated encrypted .bslbackup archive; keep it outside Database

The SDK file contains its engine. Windows still needs an executable file to run it, so BsonLite extracts the trusted engine outside the project. Runtime files can be inspected by a user with sufficient access; hiding files is not the security model.

Choose a data directory

javascript
await BsonLite.connect({
  name: 'myapp',
  directory: './Database'
});

Relative paths resolve from the process working directory. Packaged applications should choose a private writable application-data location rather than assume their installation directory is writable. Do not point managed runtime/vault storage inside the project.

Moving data between accounts

The folder is not the key

Copying Database alone to another PC or account does not carry the account-bound DPAPI key vault. Use an encrypted backup and its password to move a supported store. Physical restore requires a matching OS, CPU architecture and engine profile. Cross-PC restore still needs field validation.

Keep matching metadata, keys and backups. Do not delete a vault, change a store identity or edit encryption metadata to bypass an error. Native encrypted stores cannot be converted to plaintext by changing an option.

Documentation for BsonLite 0.6.0-rc.1. View SDK source · Download the validated SDK