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许可证。

miguilim / laravel-singlestore-backup

维护者

详细信息