schpill/redissql

Redis ORM abstraction for Laravel Framework

dev-main 2024-03-15 10:42 UTC

Requires

• php: >=8.1
• ext-curl: *
• ext-json: *
• barryvdh/laravel-dompdf: ^2.0
• meilisearch/meilisearch-php: ^v1
• predis/predis: ^v2

Requires (Dev)

• mockery/mockery: ~1.0
• phpunit/phpunit: ~8.5|^9.5.10

MIT

README

Installation

composer require schpill/redissql

Add service provider to your config/app.php file:

'providers' => [
    ...
    Morbihanet\RedisSQL\RedisSQLServiceProvider::class,
    ...
]

No need to create migrations nor models

Some examples

use Morbihanet\RedisSQL\RedisSQL;

$bookModel = RedisSQL::forTable('book');
$authorModel = RedisSQL::forTable('author');

// create
$author = $authorModel->create([
    'name' => 'John Doe'
]);

// firstOrCreate
$bookModel->firstOrCreate([
    'title' => 'My Book',
    'author_id' => $author->id,
    'year' => 2020,
    'price' => 10.99
]);

$first = $bookModel->first();
$price = $first->price;
// or
$price = $first['price'];
// or
$price = $first->>getPrice();

$first->price = 12.99;
// or
$first['price'] = 12.99;
// or
$first->setPrice(12.99);

$first->save();

// relationships
$authorFirst = $first->author;
$books = $authorFirst->books;

// queries
$books = $bookModel->where('year', '>', 2010)->where('price', '<', 20)->orderByDesc('price');
$count = $books->count();

// scopes
$bookModel->addScope('forYear', function($query, $year) {
    return $query->where('year', $year);
});

$books = $bookModel->forYear(2020)->where('price', '<', 20)->orderByDesc('price');

// aggregates
$avg = $bookModel->avg('price');
$sum = $bookModel->sum('price');
$max = $bookModel->max('price');
$min = $bookModel->min('price');

// helpers
$latest = $bookModel->latest();
$oldest = $bookModel->oldest();

$book = $bookModel->find(1);
$book = $bookModel->findOrFail(1);
$book = $bookModel->first();
$status = $book->delete();

// index
$bookModel->index();

// search indexed data
$books = $bookModel->queryfy('My Book');

// unindex
$bookModel->unindex();

// pivots
$tagModel = RedisSQL::forTable('tag');
$firstTag = $tagModel->firstOrCreate(['name' => 'first']);
$book = $bookModel->first();

$book->attach($firstTag);
// or
$book->sync($firstTag);

$tags = $book->tags;

$book->detach($firstTag);