How To Build a Laravel + MongoDB Back End Service

1
└── ./laraproject
2
    ├── ./app
3
    ├── ./artisan
4
    ├── ./bootstrap
5
    ├── ...

1
Route::get('/info', function () {
2
    phpinfo();
3
});

1
'connections' => [
2
        'mongodb' => [
3
            'driver' => 'mongodb',
4
            'dsn' => env('MONGODB_URI'),
5
            'database' => 'YOUR_DATABASE_NAME',
6
        ],

1
Route::get('/ping', function (Request  $request) {    
2
    $connection = DB::connection('mongodb');
3
    $msg = 'MongoDB is accessible!';
4
    try {  
5
        $connection->command(['ping' => 1]);  
6
    } catch (\Exception  $e) {  
7
        $msg = 'MongoDB is not accessible. Error: ' . $e->getMessage();
8
    }
9
    return ['msg' => $msg];
10
});

1
public function up()
2
{
3
     Schema::connection('mysql')->create('customer_sql', function (Blueprint  $table) {
4
      $table->id();
5
      $table->uuid('guid')->unique();
6
      $table->string('first_name');
7
      $table->string('family_name');
8
      $table->string('email');
9
      $table->text('address');
10
      $table->timestamps();
11
      });
12
}

1
// This is the standard Eloquent Model
2
use Illuminate\Database\Eloquent\Model;
3
class  CustomerSQL  extends  Model
4
{
5
    use  HasFactory;
6
    // the selected database as defined in /config/database.php
7
    protected  $connection = 'mysql';
8
    // the table as defined in the migration
9
    protected  $table= 'customer_sql';
10
    // our selected primary key for this model
11
    protected  $primaryKey = 'guid';
12
    //the attributes' names that match the migration's schema
13
    protected  $fillable = ['guid', 'first_name', 'family_name', 'email', 'address'];
14
}

1
//use Illuminate\Database\Eloquent\Model;
2
 use MongoDB\Laravel\Eloquent\Model;
3
4
class  CustomerMongoDB  extends  Model
5
{
6
    use  HasFactory;
7
8
    // the selected database as defined in /config/database.php
9
    protected  $connection = 'mongodb';
10
11
    // equivalent to $table for MySQL
12
    protected  $collection = 'laracoll';
13
14
    // defines the schema for top-level properties (optional).
15
    protected  $fillable = ['guid', 'first_name', 'family_name', 'email', 'address'];
16
}

1
Route::get('/create_eloquent_sql/', function (Request  $request) {
2
    $success = CustomerSQL::create([
3
        'guid'=> 'cust_0000',
4
        'first_name'=> 'John',
5
        'family_name' => 'Doe',
6
        'email' => 'j.doe@gmail.com',
7
        'address' => '123 my street, my city, zip, state, country'
8
    ]);
9
10
    ...
11
});
12
13
Route::get('/create_eloquent_mongo/', function (Request  $request) {
14
    $success = CustomerMongoDB::create([
15
        'guid'=> 'cust_1111',
16
        'first_name'=> 'John',
17
        'family_name' => 'Doe',
18
        'email' => 'j.doe@gmail.com',          
19
        'address' => '123 my street, my city, zip, state, country'
20
    ]);
21
22
    ...
23
});

1
Route::get('/find_eloquent/', function (Request  $request) {
2
    $customer = CustomerMongoDB::where('guid', 'cust_1111')->get();
3
    ...
4
});

1
Route::get('/update_eloquent/', function (Request  $request) {
2
 $result = CustomerMongoDB::where('guid', 'cust_1111')->update( ['first_name' => 'Jimmy'] );
3
    ...
4
});
5
6
Route::get('/delete_eloquent/', function (Request  $request) {
7
    $result = CustomerMongoDB::where('guid', 'cust_1111')->delete();
8
    ...
9
});

1
Route::get('/create_nested/', function (Request  $request) {
2
    $message = "executed";
3
    $success = null;
4
5
    $address = new  stdClass;
6
    $address->street = '123 my street name';
7
    $address->city = 'my city';
8
    $address->zip= '12345';
9
    $emails = ['j.doe@gmail.com', 'j.doe@work.com'];
10
11
    try {
12
        $customer = new  CustomerMongoDB();
13
        $customer->guid = 'cust_2222';
14
        $customer->first_name = 'John';
15
        $customer->family_name= 'Doe';
16
        $customer->email= $emails;
17
        $customer->address= $address;
18
        $success = $customer->save(); // save() returns 1 or 0
19
    }
20
    catch (\Exception  $e) {
21
        $message = $e->getMessage();
22
    }
23
    return ['msg' => $message, 'data' => $success];
24
});

1
$mongodbquery = ['guid' => 'cust_1111'];
2
   
3
// returns a "Illuminate\Database\Eloquent\Collection" Object
4
$results = CustomerMongoDB::whereRaw( $mongodbquery )->get();

1
$mongodbquery = ['guid' => 'cust_1111', ];
2
3
$mongodb_native_collection = DB::connection('mongodb')->getCollection('laracoll');
4
5
$document = $mongodb_native_collection->findOne( $mongodbquery );  
6
$cursor = $mongodb_native_collection->find( $mongodbquery );  

1
/*
2
 Find records using a native MongoDB Query
3
 1 - with Model->whereRaw()
4
 2 - with native Collection->findOne()
5
 3 - with native Collection->find()
6
*/
7
8
Route::get('/find_native/', function (Request  $request) {
9
    // a simple MongoDB query that looks for a customer based on the guid
10
    $mongodbquery = ['guid' => 'cust_2222'];
11
12
    // Option #1
13
    //==========
14
    // use Eloquent's whereRaw() function. This is the easiest way to stay close to the Laravel paradigm
15
    // returns a "Illuminate\Database\Eloquent\Collection" Object
16
17
    $results = CustomerMongoDB::whereRaw( $mongodbquery )->get();
18
19
    // Option #2 & #3
20
    //===============
21
    // use the native MongoDB driver Collection object. with it, you can use the native MongoDB Query API
22
    $mdb_collection = DB::connection('mongodb')->getCollection('laracoll');
23
24
    // find the first document that matches the query
25
    $mdb_bsondoc= $mdb_collection->findOne( $mongodbquery ); // returns a "MongoDB\Model\BSONDocument" Object
26
27
    // if we want to convert the MongoDB Document to a Laravel Model, use the Model's newFromBuilder() method
28
    $cust= new  CustomerMongoDB();
29
    $one_doc = $cust->newFromBuilder((array) $mdb_bsondoc);
30
31
    // find all documents that matches the query
32
    // Note: we're using find without any arguments, so ALL documents will be returned
33
34
    $mdb_cursor = $mdb_collection->find( ); // returns a "MongoDB\Driver\Cursor" object
35
    $cust_array = array();
36
    foreach ($mdb_cursor->toArray() as $bson) {
37
        $cust_array[] = $cust->newFromBuilder( $bson );
38
    }
39
40
    return ['msg' => 'executed', 'whereraw' => $results, 'document' => $one_doc, 'cursor_array' => $cust_array];
41
});

1
/*
2
 Update a record using a native MongoDB Query
3
*/
4
Route::get('/update_native/', function (Request  $request) {
5
    $mdb_collection = DB::connection('mongodb')->getCollection('laracoll');
6
    $match = ['guid' => 'cust_2222'];
7
    $update = ['$set' => ['first_name' => 'Henry', 'address.street' => '777 new street name'] ];
8
    $result = $mdb_collection->updateOne($match, $update );
9
    return ['msg' => 'executed', 'matched_docs' => $result->getMatchedCount(), 'modified_docs' => $result->getModifiedCount()];
10
});

1
Route::get('/delete_native/', function (Request  $request) {
2
    $mdb_collection = DB::connection('mongodb')->getCollection('laracoll');
3
    $match = ['guid' => 'cust_2222'];
4
    $result = $mdb_collection->deleteOne($match );
5
    return ['msg' => 'executed', 'deleted_docs' => $result->getDeletedCount() ];
6
});

1
'mongodb_mflix' => [
2
            'driver' => 'mongodb',
3
            'dsn' => env('DB_URI'),
4
            'database' => 'sample_mflix',
5
        ],

1
Route::get('/aggregate/', function (Request  $request) {
2
    $mdb_collection = DB::connection('mongodb_mflix')->getCollection('movies');
3
4
    $stage0 = ['$unwind' => ['path' => '$genres']];
5
    $stage1 = ['$group' => ['_id' => '$genres', 'averageGenreRating' => ['$avg' => '$imdb.rating']]];
6
    $stage2 = ['$sort' => ['averageGenreRating' => -1]];
7
8
    $aggregation = [$stage0, $stage1, $stage2];
9
    $mdb_cursor = $mdb_collection->aggregate( $aggregation );
10
    return ['msg' => 'executed', 'data' => $mdb_cursor->toArray() ];
11
});

1
public function up() {
2
  Schema::connection('mongodb')->create('laracoll', function ($collection) {
3
  $collection->unique('guid'); // Ensure the guid is unique since it will be used as a primary key.
4
  });
5
}

1
Route::get('/create_index/', function (Request  $request) {
2
3
    $indexKeys = ["guid" => 1];
4
    $indexOptions = ["unique" => true];
5
    $result = DB::connection('mongodb')->getCollection('laracoll')->createIndex($indexKeys, $indexOptions);
6
7
    return ['msg' => 'executed', 'data' => $result ];
8
});