mgcosta/spanner-orm-builder

Google Spanner ORM With Query Builder

v0.0.5 2021-06-01 22:20 UTC

This package is auto-updated.

Last update: 2022-04-29 01:33:54 UTC


README

License Actions Status codecov Total Downloads

The Spanner ORM Builder is a database toolkit to PHP, providing an expressive query builder, ActiveRecord style ORM, it can serve as a database layer for your PHP app if you intend to work with Google Cloud Spanner.

Install

Via Composer

$ composer require mgcosta/spanner-orm-builder

Usage Instructions

First, we should create a new "Manager" instance. Manager aims to make configuring the library for every framework as easy as possible.

use MgCosta\Spanner\Manager;
use Google\Cloud\Spanner\Database;

// $database = your database instance for google cloud spanner;
// instance of Google\Cloud\Spanner\Database;

$manager = new Manager($database);
$manager->boot();

That's it, you're ready to use the library, just be sure to instantiate the manager as soon as possible on your APP, usually on your bootstrap or config file.

Once the Manager instance has been registered, we may use it like:

Using The Query Builder

use MgCosta\Spanner\Model\Model;

class User extends Model {}

$users = User::where('age', '>', 30)->get();

$id = 1;
$user = User::find($id);

Updating/Deleting using the Query Builder

use MgCosta\Spanner\Model\Model;

class User extends Model {}

// deleting
User::where('id', 1)->delete();

// updating
$status = User::where('id', 5)->update(['name' => 'Richard', 'age' => 30]);

Saving a model

use MgCosta\Spanner\Model\Model;

class User extends Model {

    protected $primaryKey = 'userId';
    
    // available strategies [uuid4, increment] 
    // increment is not recommend by cloud spanner
    protected $keyStrategy = 'uuid4';
    
    // we must define the properties which corresponds to the columns of the table as public
    public $userId;
    public $name;
    public $age;
    public $email;
}

$user = new User();
$user->name = 'Miguel';
$user->age = 28;
$user->email = 'email@gmail.com';
$user->save();

Using the query builder without Model Class

use MgCosta\Spanner\Facade\SpannerDB;

(new SpannerDB())->table('users')->whereIn('id', [1, 2, 3])->get();

// you can also provide a custom spanner Database Instance
// $database = instance of Google\Cloud\Spanner\Database;
(new SpannerDB($database))->table('users')->where('id', 1)->first();

The implementation of the query builder is inspired on Laravel Query Builder, to get more documentation follow the link.

Roadmap

You can get more details of the plans for this early version on the following link.

Contributing

Please see CONTRIBUTING for details.

Credits

License

The MIT License (MIT). Please see License File for more information.