srdate / laravel-singlestore-backup
1.0.2
2024-03-17 19:19 UTC
Requires
- illuminate/config: ^9.0|^10.0|^11.0
- illuminate/console: ^9.0|^10.0|^11.0
- illuminate/database: ^9.0|^10.0|^11.0
- illuminate/support: ^9.0|^10.0|^11.0
README
Laravel SingleStore Backup 是一个易于将您的SingleStore数据库备份到您喜欢的存储的包。在幕后,该包使用SingleStore DB引擎的内置命令 BACKUP DATABASE
。
内容
安装
您可以通过composer安装此包
composer require miguilim/laravel-singlestore-backup
支持的驱动器
此包支持以下备份驱动器
- 本地 -
local
- S3 / S3 兼容 -
s3
- Google Cloud Storage -
gcs
- Azure Blobs -
azure
配置
您必须将以下行添加到您的.env文件中,以配置您的S3凭据
SINGLESTORE_BACKUP_DRIVER= # Local storage SINGLESTORE_BACKUP_PATH= # S3 storage (optionals) SINGLESTORE_BACKUP_REGION= SINGLESTORE_BACKUP_MULTIPART_CHUNK_SIZE= SINGLESTORE_BACKUP_FORCE_PATH_STYLE= # External storages SINGLESTORE_BACKUP_ENDPOINT= SINGLESTORE_BACKUP_BUCKET= SINGLESTORE_BACKUP_PUBLIC_KEY= SINGLESTORE_BACKUP_SECRET_KEY=
基本用法
以下是一个如何使用备份命令的简单示例。默认情况下,该命令将执行完整备份。
php artisan singlestore:backup
设置超时参数
您可以将超时参数设置为一个以毫秒为单位的值,以确定等待 BACKUP DATABASE
命令在集群中提交的长度。如果没有指定,则使用全局变量 default_distributed_ddl_timeout
的值。
php artisan singlestore:backup --timeout=30000
初始化备份
如果您正在制作增量备份并想创建 INIT
备份,您可以使用 --init
参数来完成。
php artisan singlestore:backup --init
差异备份
如果您正在制作增量备份并想进行 DIFFERENTIAL
备份,您可以使用 --differential
参数来完成。
php artisan singlestore:backup --differential
高级用法
有时,带有配置的简单备份命令可能不如您希望的那样灵活。相反,您可以使用 SinglestoreBackup
类。
use Miguilim\LaravelSinglestoreBackup\SinglestoreBackup; $backupInstance = new SinglestoreBackup( driver: 'local', database: 'mydatabase', path: '/my-backup/path' ); $result = $backupInstance->executeQuery();
可用参数
driver
database
path
endpoint
timeout
publicKey
secretKey
bucket
init
differential
region
multipartChunkSizeMb
s3ForcePathStyle
发布配置文件
您可以使用以下命令将包配置文件发布到项目中
php artisan vendor:publish --tag=singlestore-backup-config
许可证
Laravel SingleStore Backup 是开源软件,采用 MIT许可证。