forked from TrueCloudLab/restic
9be24a1c9f
This commits adds rudimentary support for a cache directory, enabled by default. The cache directory is created if it does not exist. The cache is used if there's anything in it, newly created snapshot and index files are written to the cache automatically.
26 lines
1 KiB
ReStructuredText
26 lines
1 KiB
ReStructuredText
Local Cache
|
|
===========
|
|
|
|
In order to speed up certain operations, restic manages a local cache of data.
|
|
This document describes the data structures for the local cache with version 1.
|
|
|
|
Versions
|
|
--------
|
|
|
|
The cache directory is selected according to the `XDG base dir specification
|
|
<http://standards.freedesktop.org/basedir-spec/basedir-spec-latest.html>`__.
|
|
Each repository has its own cache sub-directory, consting of the repository ID
|
|
which is chosen at ``init``. All cache directories for different repos are
|
|
independent of each other.
|
|
|
|
The cache dir for a repo contains a file named ``version``, which contains a
|
|
single ASCII integer line that stands for the current version of the cache. If
|
|
a lower version number is found the cache is recreated with the current
|
|
version. If a higher version number is found the cache is ignored and left as
|
|
is.
|
|
|
|
Snapshots and Indexes
|
|
---------------------
|
|
|
|
Snapshot, Data and Index files are cached in the sub-directories ``snapshots``,
|
|
``data`` and ``index``, as read from the repository.
|