Repository files navigation

Laravel SingleStore Backup is a package that makes it easy to make backups of your SingleStore database to your favorite storage. Behind the scenes, this package uses theBACKUP DATABASE command, anative command from SingleStore DB engine.

• Installation
• Supported Drivers
• Configuring
• Basic Usage
  • Setting Timeout Parameter
  • Setting With Date Parameter
  • Setting With Time Parameter
  • Init Backup
  • Differential Backup
• Prune Backups
  • Prune Incremental Backups
  • Prune Backups Older Than Days
  • Prune Backups Older Than Date
• Advanced Usage
• Publishing Config File
• License

You can install the package via composer:

composer require miguilim/laravel-singlestore-backup

This package supports the following backup drivers:

• Local -local
• S3 / S3 compatible -s3
• Google Cloud Storage -gcs
• Azure Blobs -azure

You must add the following lines to your .env file in order to configure your S3 credentials:

SINGLESTORE_BACKUP_DRIVER=# Local / External storageSINGLESTORE_BACKUP_PATH=# External storage (S3 / GCS / Azure)SINGLESTORE_BACKUP_ENDPOINT=SINGLESTORE_BACKUP_BUCKET=SINGLESTORE_BACKUP_PUBLIC_KEY=SINGLESTORE_BACKUP_SECRET_KEY=# S3 storage (optionals)SINGLESTORE_BACKUP_REGION=SINGLESTORE_BACKUP_MULTIPART_CHUNK_SIZE=SINGLESTORE_BACKUP_FORCE_PATH_STYLE=SINGLESTORE_BACKUP_COMPATIBILITY_MODE=

Below there is a simple example of how you use the backup command. By default, the command will do a full backup.

php artisan singlestore:backup

You can set the timeout parameter, a value specified in milliseconds, to determines the length of time to wait for theBACKUP DATABASE command to commit across the cluster. If not specified, thedefault_distributed_ddl_timeout global variable value is used.

php artisan singlestore:backup --timeout=30000

If you want to add the date to the backup name, you can do that by using the--with-date parameter.

php artisan singlestore:backup --with-date

If you want to add the time to the backup name, you can do that by using the--with-time parameter.

php artisan singlestore:backup --with-time

If you're making an incremental backup and want to create theINIT backup, you can do that by using the--init parameter.

php artisan singlestore:backup --init

If you're making an incremental backup and want to do aDIFFERENTIAL backup, you can do that by using the--differential parameter.

php artisan singlestore:backup --differential

You can prune backups by using thesinglestore:prune-backups command. This command will prune the{$database}.backup directory by default.

php artisan singlestore:prune-backups

If you want to prune incremental backups, you can do that by using the--incremental parameter. This will prune the{$database}.incr_backup directory.

php artisan singlestore:prune-backups --incremental

If you want to prune backups older than a certain number of days, you can do that by using the--older-than-days parameter. This will prune the{$database}_(.*?).backup (respecting the date) directory.

php artisan singlestore:prune-backups --older-than-days=30

If you want to prune backups older than a certain date, you can do that by using the--older-than-date parameter. This will prune the{$database}_(.*?).backup (respecting the date) directory.

php artisan singlestore:prune-backups --older-than-date=2024-01-01

Sometimes the simple backup command with configs may not be flexible as you want. Instead, you can use theSinglestoreBackup class:

useMiguilim\LaravelSinglestoreBackup\SinglestoreBackup;$backupInstance =newSinglestoreBackup(    driver:'local',    database:'mydatabase',    path:'/my-backup/path');$result =$backupInstance->executeQuery();

Available arguments:

• driver
• database
• path
• endpoint
• timeout
• publicKey
• secretKey
• bucket
• init
• differential
• region
• multipartChunkSizeMb
• s3ForcePathStyle
• compatibilityMode
• withDate
• withTime

You can publish the package configuration file to your project with the following command:

php artisan vendor:publish --tag=singlestore-backup-config

Laravel SingleStore Backup is open-sourced software licensed under theMIT license.