Skip to content

Commit

Permalink
Merge pull request #4 from mgcostaParedes/readme-1#
Browse files Browse the repository at this point in the history
fix: updated readme
  • Loading branch information
mgcostaParedes authored May 7, 2021
2 parents 2f5ade2 + f3aeee0 commit b798837
Showing 1 changed file with 35 additions and 2 deletions.
37 changes: 35 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,21 @@
## Spanner ORM Builder
## Spanner ORM Builder For PHP

[![License](https://poser.pugx.org/mgcosta/spanner-orm-builder/license)](//packagist.org/packages/mgcosta/spanner-orm-builder)
[![Build Status](https://travis-ci.com/mgcostaParedes/spanner-orm-builder.svg?branch=main)](https://travis-ci.com/mgcostaParedes/spanner-orm-builder)
[![codecov](https://codecov.io/gh/mgcostaParedes/spanner-orm-builder/branch/main/graph/badge.svg?token=OEUY7ZDTOP)](https://codecov.io/gh/mgcostaParedes/spanner-orm-builder)
[![Total Downloads](https://poser.pugx.org/mgcosta/spanner-orm-builder/downloads)](//packagist.org/packages/mgcosta/spanner-orm-builder)


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

``` bash
$ 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.
Expand All @@ -28,11 +39,33 @@ Once the Manager instance has been registered, we may use it like:
**Using The Query Builder**

```PHP
use MgCosta\Spanner\Model\Model;

class User extends \MgCosta\Spanner\Model\Model {}
class User extends Model {}

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

```

**Saving a model **

```PHP
use MgCosta\Spanner\Model\Model;

class User extends Model {
protected $primaryKey = 'UserId';

public $name;
public $age;
public $email;
}

$user = new User();
$user->name = 'Miguel';
$user->age = 28;
$user->email = '[email protected]';
$user->save();

```

The implementation of the query builder is inspired on Laravel Query Builder, to get more documentation follow the [link](https://laravel.com/docs/master/queries).

0 comments on commit b798837

Please sign in to comment.