Skip to content

Repository files navigation

Grafite Archive

Archive - A simple data archiving package.

Build Status Maintainability Packagist License: MIT

The archiving package is designed for helping long term applications with data handling. You have the power to archive old data sets to json storage files in S3 based on time frames. These same files can be restored with the restore command handling a specified date range.

Author(s):

Requirements

  1. PHP 8.4+

Compatibility and Support

Laravel Version Package Tag Supported
^12.x - ^13.x 1.x yes

Installation

Start a new Laravel project:

composer create-project laravel/laravel your-project-name

Then run the following to add Archive

composer require "grafite/archive"

Time to publish those assets!

php artisan vendor:publish --provider="Grafite\Archive\GrafiteArchiveProvider"

Current Command Surface

The package currently provides the first archive workflow command:

php artisan archive:run --model="App\\Models\\Post" --before="2024-12-31 23:59:59"

Exports are encrypted by default using Laravel's APP_KEY. You can configure default models, scopes, relationships, archive disk, and archive path in config/archive.php, then override those defaults from the command line with options such as --scope, --with, --without-scopes, --without-relationships, --unencrypted, and --dry-run.

Documentation

https://documentation.grafite.ca/docs/utilities-archive

License

Archive is open-sourced software licensed under the MIT license

Bug Reporting and Feature Requests

Please add as many details as possible regarding submission of issues and feature requests

Disclaimer

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

About

A simple data archiving package

Resources

Contributing

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages