Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/duxet/laravel-rethinkdb
RethinkDB adapter for Laravel (with Eloquent support)
https://github.com/duxet/laravel-rethinkdb
laravel laravel-rethinkdb php rethinkdb rethinkdb-adapter
Last synced: 12 days ago
JSON representation
RethinkDB adapter for Laravel (with Eloquent support)
- Host: GitHub
- URL: https://github.com/duxet/laravel-rethinkdb
- Owner: duxet
- License: mit
- Created: 2014-12-03T18:28:05.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2019-07-26T06:49:26.000Z (over 5 years ago)
- Last Synced: 2024-04-24T19:12:21.045Z (7 months ago)
- Topics: laravel, laravel-rethinkdb, php, rethinkdb, rethinkdb-adapter
- Language: PHP
- Size: 147 KB
- Stars: 147
- Watchers: 13
- Forks: 37
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
laravel-rethinkdb
=================
[](https://packagist.org/packages/duxet/laravel-rethinkdb)
[](https://packagist.org/packages/duxet/laravel-rethinkdb)
[](https://travis-ci.org/duxet/laravel-rethinkdb)
[](https://codeclimate.com/github/duxet/laravel-rethinkdb)
[](https://scrutinizer-ci.com/g/duxet/laravel-rethinkdb/)
RethinkDB adapter for Laravel (with Eloquent support)
God bless [@jenssegers](https://github.com/jenssegers) for his great [laravel-mongodb](https://github.com/jenssegers/laravel-mongodb) project. I have used his tests and some other code, since it's awesome codebase for supporting other NoSQL databases. I hope he won't be angry on me for that ;)
# Installation
## Requirements.
1. RethinkDB: You need to make sure that you have installed [RethinkDB](http://www.rethinkdb.com) successfully, you can reffer to rethinkdb [documentation](https://rethinkdb.com/docs/) for the full instruction of how to install RethinkDB.
1. Laravel 5.2: this package was designed to work with [Laravel](http://laravel.com) 5.2, so it will not work with laravel 4.x.
## Installation
To fully install this package you will have either to add it manually to your `composer.json` file, or you can execute the following command :
`composer require "duxet/laravel-rethinkdb:dev-master"`
This will install the package and all the required package for it to work.
## Service Provider
After you install the library you will need to add the `Service Provider` file to your `app.php` file like :
```php
duxet\Rethinkdb\RethinkdbServiceProvider::class,
```
inside your `providers` array.
## Database configuration
Now that you have the service provider setup, you will need to add the following configuration array at the end of your database connections array like :
```php
'rethinkdb' => [
'name' => 'rethinkdb',
'driver' => 'rethinkdb',
'host' => env('DB_HOST', 'localhost'),
'port' => env('DB_PORT', 28015),
'database' => env('DB_DATABASE', 'homestead'),
]
```
After you add it, you can just configure your enviroment file to be something like :
```
DB_HOST=localhost
DB_DATABASE=homestead
DB_CONNECTION=rethinkdb
```
but you can always updatr your `DB_HOST` to point to the IP where you have installed RethinkDB.
# Migration
## Create a Migration File
You can easily create a migration file using the following command which will create a migration file for you to create the users table and use the package schema instead of Laravel schema:
`php artisan make:rethink-migration Users --create`
Please note that you can use the same options that you use in `make:migration` with `make:rethink-migration`, as its based on laravel `make:migration`
Be aware that Laravel Schema API is not fully implemented. For example, ID columns using increments will not be auto-incremented unsigned integers, and will instead be a UUID unless explicitly set. The easiest solution is to maintain UUID use within RethinkDB, turn off incremental IDs in Laravel, and finally implement UUID use in Laravel.
## Running The Migrations
Nothing will change here, you will keep using the same laravel commands which you are used to execute to run the migration.
## Example of Laravel Users Migration file
This is an example of how the laravel Users Migration file has become
```php
increments('id');
$table->string('name');
$table->string('email')->unique();
$table->string('password', 60);
$table->rememberToken();
$table->timestamps();
});
}
/**
* Reverse the migrations.
*
* @return void
*/
public function down()
{
Schema::drop('users');
}
}
```
# Model
## Create a Model Class
You can easily create a model class using the following command which will create it for you and use the package model instead of Laravel model:
`php artisan make:rethink-model News`
Please note that you can use the same options that you use in `make:model` with `make:rethink-model`, as its based on laravel `make:model`
## Example of Laravel News Model Class
This is an example of how the laravel model class has become
```php