PHPackages                             nexusbrother/laravel-archivable - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Database & ORM](/categories/database)
4. /
5. nexusbrother/laravel-archivable

ActiveLibrary[Database & ORM](/categories/database)

nexusbrother/laravel-archivable
===============================

This is laravel extension packages

1.0.0(3mo ago)07↓44.4%MITPHPPHP >=8.1

Since Mar 30Pushed 3mo agoCompare

[ Source](https://github.com/nexusbrother/laravel-archivable)[ Packagist](https://packagist.org/packages/nexusbrother/laravel-archivable)[ Docs](https://github.com/nexusbrother/laravel-archivable)[ RSS](/packages/nexusbrother-laravel-archivable/feed)WikiDiscussions main Synced 3w ago

READMEChangelog (1)Dependencies (4)Versions (2)Used By (0)

Laravel Archivable
==================

[](#laravel-archivable)

Laravel Archivable 是一个强大的 Laravel 扩展包，用于数据库记录归档，它能够将不需要的记录从主数据库移动到归档数据库，同时保持表结构同步。

功能特性
----

[](#功能特性)

- 将模型记录归档到指定的归档数据库
- 自动同步主数据库和归档数据库之间的表结构
- 支持批量归档操作，可配置分块大小
- 提供命令行工具进行批量归档和表结构同步
- 支持自定义归档条件
- 支持基于日期字段的自动归档
- 支持按月自动分表归档
- 提供归档事件监听

安装
--

[](#安装)

使用 Composer 安装包：

```
composer require nexusbrother/laravel-archivable
```

发布配置文件：

```
php artisan vendor:publish --provider="Nexusbrother\Archivable\ServiceProvider" --tag="config"
```

配置
--

[](#配置)

在你的 .env 文件中配置归档数据库连接：

```
ARCHIVE_DB_CONNECTION=archive
```

确保在 config/database.php 中定义了 archive 数据库连接：

```
'connections' => [
    // 其他连接...

    'archive' => [
        'driver' => 'mysql',
        'host' => env('ARCHIVE_DB_HOST', '127.0.0.1'),
        'port' => env('ARCHIVE_DB_PORT', '3306'),
        'database' => env('ARCHIVE_DB_DATABASE', 'archive'),
        'username' => env('ARCHIVE_DB_USERNAME', 'root'),
        'password' => env('ARCHIVE_DB_PASSWORD', ''),
        'unix_socket' => env('ARCHIVE_DB_SOCKET', ''),
        'charset' => 'utf8mb4',
        'collation' => 'utf8mb4_unicode_ci',
        'prefix' => '',
        'strict' => true,
        'engine' => null,
    ],
],
```

配置项
---

[](#配置项)

在 config/archive.php 中可以配置以下选项：

```
return [
    // 默认分块大小
    'default_chunk_size' => 1000,

    // 归档数据库连接
    'db' => env('ARCHIVE_DB_CONNECTION', 'archive'),

    // 模型扫描路径
    'model_paths' => [
        app_path('Models'),
    ],
];
```

使用方法
----

[](#使用方法)

### 1. 基本归档功能

[](#1-基本归档功能)

在模型中使用 Archivable Trait：

```