Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/inmanturbo/instances
https://github.com/inmanturbo/instances
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/inmanturbo/instances
- Owner: inmanturbo
- License: mit
- Created: 2024-08-09T23:36:47.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2024-08-12T14:39:06.000Z (3 months ago)
- Last Synced: 2024-08-13T15:21:15.765Z (3 months ago)
- Language: PHP
- Size: 78.1 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
# An single table store for storing eloquent model instances
[](https://packagist.org/packages/inmanturbo/instances)
[](https://github.com/inmanturbo/instances/actions?query=workflow%3Arun-tests+branch%3Amain)
[](https://github.com/inmanturbo/instances/actions?query=workflow%3A"Fix+PHP+code+style+issues"+branch%3Amain)
[](https://packagist.org/packages/inmanturbo/instances)
## Installation
You can install the package via composer:
```bash
composer require inmanturbo/instances
```
You can run the migrations with:
```bash
php artisan instances:migrate
```
You can publish and run the migrations with:
```bash
php artisan vendor:publish --tag="instances-migrations"
php artisan migrate
```
You can publish the config file with:
```bash
php artisan vendor:publish --tag="instances-config"
```
This is the contents of the published config file:
```php
return [
/*
* Enable or disable the event listeners.
*/
'enabled' => env('INSTANCES_ENABLED', true),
/*
* The model used to store instances.
*/
'instance_model' => \Inmanturbo\Instances\Models\Instance::class,
/*
* The model used to store snapshots.
*/
'snapshot_model' => \Inmanturbo\Instances\Models\InstanceSnapshot::class,
/*
* The number of days to keep instances.
*/
'prune_after_days' => 365 * 1000000, // wouldn't delete this in a million years,
/*
* The table name used to store instances.
*
* Changing it is not supported at this time.
*
* It's here for reference and to be used by the `instances:migrate` command.
*/
'instance_table' => 'instances',
/*
* The table name used to store snapshots.
*
* Changing it is not supported at this time.
*
* It's here for reference and to be used by the `instances:migrate` command.
*/
'snapshot_table' => 'instance_snapshots',
/*
* These tables will be created when running the migration.
*
* They will be dropped when running `php artisan instances:migrate --fresh`.
*/
'migration_tables' => [
'instances',
'instance_snapshots',
],
];
```
## Usage
Work in progress. See [tests](https://github.com/inmanturbo/instances/tree/main/tests/Feature) for usage.
## Testing
```bash
composer test
```
## Changelog
Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.
## Contributing
Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
## Security Vulnerabilities
Please review [our security policy](../../security/policy) on how to report security vulnerabilities.
## Credits
- [inmanturbo](https://github.com/inmanturbo)
- [spatie/laravel-event-sourcing](https://github.com/spatie/laravel-event-sourcing)
- [spatie/laravel-deleted-models](https://github.com/spatie/laravel-deleted-models)
- [All Contributors](../../contributors)
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.