litestream README

The project's README from github.com/benbjohnson/litestream. As one markdown file: README.md.

Litestream GitHub release (latest by date) Status GitHub Docker Pulls

Litestream is a standalone disaster recovery tool for SQLite. It runs as a background process and safely replicates changes incrementally to another file or S3. Litestream only communicates with SQLite through the SQLite API so it will not corrupt your database.

If you need support or have ideas for improving Litestream, please visit GitHub Issues. Please visit the Litestream web site for installation instructions and documentation.

If you find this project interesting, please consider starring the project on GitHub.

Source database changes

When Litestream begins replicating a database, it creates an internal _litestream_lock table in the source SQLite database. This is expected and safe to leave in place. Litestream uses the table to acquire SQLite's write lock while coordinating synchronization around WAL checkpoints. The writes occur in transactions that are rolled back, so Litestream does not leave rows in the table.

The table is part of the source database, not a separate table in the replica destination. Because the source schema is backed up, restored databases also contain it. Its creation changes the source database schema and can change its page count or bytes, so a database under Litestream should not be expected to remain byte-identical to its pre-Litestream state.

Do not drop _litestream_lock while Litestream is running. Synchronization around a checkpoint can fail until Litestream reinitializes the database. Restarting Litestream recreates the missing table automatically.

Contributing

We welcome bug reports, fixes, and patches! Please see our Contributing Guide for details on how to contribute.

Security

Please do not open a public issue for security vulnerabilities. Report them privately through GitHub's private vulnerability reporting, which keeps the report visible only to you and the maintainers until a fix is released. See our Security Policy for what to include and what to expect.

Acknowledgements

I want to give special thanks to individuals who invest much of their time and energy into the project to help make it better:

Huge thanks to fly.io for their support and for contributing credits for testing and development!

litestream (benbjohnson/litestream)

Searching Database…

Что это такое?Litestream — это отдельный инструмент аварийного восстановления для SQLite: фоновый процесс, который безопасно реплицирует изменения базы данных инкрементально, чтобы вы могли восстановиться после сбоя.
Так это разовый скрипт для бэкапа или его нужно держать запущенным постоянно?Его нужно держать запущенным вместе с вашим приложением — он непрерывно передаёт изменения по мере их появления, а не делает снимки по расписанию.
Как его запустить?README отправляет вас на сайт Litestream (litestream.io) за инструкциями по установке и документацией. В репозитории также есть Dockerfile, если вам удобнее работать с контейнерами.
Он как-то изменяет мою базу данных?Да — он создаёт в исходной базе внутреннюю таблицу litestreamlock для координации WAL-чекпоинтов. Из-за этого меняются схема и число страниц, поэтому база больше не побайтово идентична своему состоянию до Litestream.
Можно запустить его в Docker или на Kubernetes?И то, и другое: в репозитории есть Dockerfile, а в документации сообщества описан запуск Litestream на Kubernetes. Это один бинарник на Go, доступны и сборки релизов для OpenBSD.
Куда попадают реплики — только в S3 или куда-то ещё?В README названы два типа хранилищ: другой файл или S3. Репликация инкрементальная, поэтому изменения передаются постоянно, а не в виде периодических полных дампов.
Может ли Litestream повредить мою базу данных?Проект прямо заявляет об этом как об одном из принципов дизайна: он общается с SQLite только через SQLite API, и, как сказано в README, он не повредит вашу базу данных.
Что будет, если я удалю таблицу litestreamlock во время его работы?Синхронизация чекпоинтов может нарушиться, пока Litestream не реинициализирует базу. При перезапуске Litestream пересоздаст таблицу автоматически, но удалять её во время работы не стоит.
Если я восстановлю базу данных, попадёт ли в неё и таблица блокировок?Да — поскольку вместе с базой сохраняется и её исходная схема, восстановленные базы тоже содержат эту таблицу. Это ожидаемо, и её можно спокойно оставить на месте.
Size
3.7 MB
Stars
14.5K
Age
6y
Commits · 90 Days