SQLite

The SQLite integration hosts a Kloset store inside a single SQLite database file. Snapshot data, metadata and locks are all kept in that file, so the store needs no server. This suits desktop, embedded, test and air-gapped environments where running a remote backend is not practical.

The integration includes one connector:

Requirements

• Write access to the directory that holds the database file.

Installation

The SQLite integration is distributed as a Plakar package.

$ plakar pkg add sqlite

$ plakar pkg show

$ plakar pkg build sqlite

$ plakar pkg add -allow-unsigned ./sqlite_v1.1.0_darwin_arm64.ptar

$ plakar pkg show

To list, upgrade, or remove the package, see managing packages guide.

Configuration

The store connector writes the Kloset store to a SQLite database file on the local filesystem, addressed by a sqlite:// URL.

Store flow

flowchart LR

Source["Source data"]

Plakar["Plakar"]

Transform["Encrypt & deduplicate"]

Via["Store snapshot via
SQLite store connector"]

subgraph Store["SQLite database file"]
  Kloset["Kloset Store"]
end

Source --> Plakar --> Transform --> Via --> Kloset

Store configuration

File permissions

Creating the Kloset store creates the database file with mode 0600, so only the user who created it can read or write it. SQLite keeps two companion files next to the database, -wal and -shm, and creates them with the same mode as the database. Other local users therefore cannot read the store contents, even when they can list the directory.

The mode is set only when the store is created. A database that already exists keeps its permissions. To restrict an existing store, set the mode of the database file and of any -wal or -shm file next to it:

$ chmod 600 /var/backups/kloset.db

Example

Create a Kloset store in a SQLite file and use it:

# Configure the Kloset store
$ plakar store add sqlite_store sqlite:///var/backups/kloset.db

# Initialize the Kloset store
$ plakar at "@sqlite_store" create

# Back up a local folder to the Kloset store
$ plakar at "@sqlite_store" backup /etc

# List snapshots in the Kloset store
$ plakar at "@sqlite_store" ls

# Restore a snapshot to a local directory
$ plakar at "@sqlite_store" restore -to /tmp/restore <snapshot_id>

See also

• SQLite documentation
• Plakar Architecture (Kloset Engine)