Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/joeymckenzie/sqlighter
A Laravel package for routinely backing up your SQLite database.
https://github.com/joeymckenzie/sqlighter
laravel php sqlite
Last synced: 22 days ago
JSON representation
A Laravel package for routinely backing up your SQLite database.
- Host: GitHub
- URL: https://github.com/joeymckenzie/sqlighter
- Owner: JoeyMckenzie
- License: mit
- Created: 2024-10-27T16:17:20.000Z (24 days ago)
- Default Branch: main
- Last Pushed: 2024-10-27T22:34:20.000Z (24 days ago)
- Last Synced: 2024-10-28T00:13:36.249Z (24 days ago)
- Topics: laravel, php, sqlite
- Language: PHP
- Homepage:
- Size: 60.5 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
# SQLighter: Backup Commands for your SQLite Databases
[](https://packagist.org/packages/joeymckenzie/sqlighter)
[](https://github.com/joeymckenzie/sqlighter/actions?query=workflow%3Arun-tests+branch%3Amain)
[](https://github.com/joeymckenzie/sqlighter/actions?query=workflow%3A"Fix+PHP+code+style+issues"+branch%3Amain)
[](https://packagist.org/packages/joeymckenzie/sqlighter)
SQLighter is a lightweight SQLite backup solution for Laravel applications. SQLighter provides automated backups of your
SQLite database with configurable retention policies, while allowing for manual backups through an artisan command.
- 🔄 Automated SQLite database backups
- ⚙️ Configurable backup frequency
- 📦 Backup file rotation with configurable retention
- 🗂️ Automatic backup directory creation
- 🚫 Git-friendly (auto-generates appropriate .gitignore)
- 💡 Simple integration with Laravel's scheduler
## Installation
You can install the package via composer:
```bash
composer require joeymckenzie/sqlighter
```
## Usage
After installation, publish the configuration file:
```bash
php artisan vendor:publish --tag="sqligther-config"
```
This will create a `config/sqligther.php` configuration file. Customize the options to fit your needs:
```php
return [
// Enable/disable automatic backups
'enabled' => env('SQLIGHTER_ENABLED', true),
// Hours between backups
'frequency' => env('SQLIGHTER_FREQUENCY', 3),
// SQLite database filename
'database' => env('SQLIGHTER_DATABASE', 'database.sqlite'),
// How many backup copies to maintain
'copies_to_maintain' => env('SQLIGHTER_COPIES', 5),
// Where to store backups (relative to database directory)
'storage_folder' => env('SQLIGHTER_STORAGE', 'backups/'),
// Prefix for backup files
'file_prefix' => env('SQLIGHTER_PREFIX', 'backup'),
];
```
### Automatic Backups
SQLighter automatically registers a scheduled command to perform backups based on your configuration. No additional
setup is required other than ensuring your Laravel scheduler is running:
```bash
cd /path-to-your-project && php artisan schedule:run >> /dev/null 2>&1
```
Backups are configured to run every six hours by default, though can be overridden using the `sqlighter.frequency`
configuration option. Any valid cron string will work:
```php
return [
// Using hour intervals
'frequency' => 1, // Every hour
'frequency' => 12, // Every 12 hours
'frequency' => 24, // Daily
'frequency' => 168, // Weekly
// Or using cron expressions
'frequency' => '0 * * * *', // Every hour
'frequency' => '0 */12 * * *', // Every 12 hours
'frequency' => '0 0 * * *', // Daily at midnight
'frequency' => '0 0 * * 0', // Weekly on Sunday at midnight
'frequency' => '30 2 * * *', // Daily at 2:30 AM
];
```
### Manual Backups
You can also trigger a backup manually using the provided Artisan command:
```bash
php artisan sqlighter:backup
```
### Backup Storage
Backups are stored in your Laravel database directory under the configured `storage_folder` (default: `backups/`). A
`.gitignore` file is automatically created to prevent backups from being committed to your repository.
### File Naming
Backup files are named using the following format:
```
{prefix}-{timestamp}.sql
```
For example: `backup-1698765432.sql`
## Testing
Pest is used to test the backup command. To run tests, just use the composer script:
```bash
composer test
```
## Security Vulnerabilities
If you discover a security vulnerability within SQLighter, please send an e-mail to Joey McKenzie
via [[email protected]](mailto:[email protected]).
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.