README

Laravel Storage with Database is a powerful package that provides a seamless way to store and retrieve text-based data using a database in Laravel. It offers a simple and intuitive API similar to Laravel's built-in Storage facade, making it easy to switch from file-based storage to database storage for your text-based data[1].

Features

Store and retrieve text-based data using a database
Seamless integration with Laravel's Storage facade
Simple and intuitive API for interacting with stored data
Supports various database drivers (MySQL, PostgreSQL, SQLite, etc.)
Customizable database table and column names
Provides mock implementations for file-related functions
Comprehensive documentation and code examples

Installation

You can install the package via Composer:

composer require rakshitbharat/laravel-storage-with-database

After installing the package, you need to publish the configuration file:

php artisan vendor:publish --provider="Rakshitbharat\LaravelStorageWithDatabase\StorageDatabaseServiceProvider" --tag="config"

This will create a storage-database.php configuration file in your config directory. You can modify this file to customize the database connection, table name, and column names.

Next, run the database migration to create the necessary table:

php artisan migrate

Configuration

To use the database storage driver, you need to update your config/filesystems.php file. Add the following to the disks array:

'disks' => [
    // ... other disks ...
    'database' => [
        'driver' => 'database'
    ],
],

Usage

Once the package is installed and configured, you can start using it to store and retrieve text-based data. You can use the Storage facade with the database disk to interact with the stored data.

Storing Data

To store data, you can use the put method:

use Illuminate\Support\Facades\Storage;

Storage::disk('database')->put('key', 'value');

Retrieving Data

To retrieve data, you can use the get method:

use Illuminate\Support\Facades\Storage;

$value = Storage::disk('database')->get('key');

Checking Data Existence

To check if a key exists, you can use the exists method:

use Illuminate\Support\Facades\Storage;

$exists = Storage::disk('database')->exists('key');

Deleting Data

To delete data, you can use the delete method:

use Illuminate\Support\Facades\Storage;

Storage::disk('database')->delete('key');

Other Methods

The package supports other Laravel Storage methods like append, prepend, copy, move, size, lastModified, and more. Refer to the Laravel filesystem documentation for a complete list of available methods[1].

Contributing

Contributions are welcome! If you find any issues or have suggestions for improvements, please open an issue or submit a pull request on the GitHub repository.

License

Laravel Storage with Database is open-sourced software licensed under the MIT license[1].

rakshitbharat / laravel-storage-with-database

Maintainers

Details