Clean up

- made sure all API routes work. fixed a syntax issue found in the update code
- add try{} blocks where useful for the tutorial
- remove unused temporary code

Author: hubertnguyen

app/Models/CustomerMongoDB.php

@@ -11,14 +11,12 @@ class CustomerMongoDB extends Model
 {
     use HasFactory;
 
+    // the selected database as defined in /config/database.php
     protected $connection = 'mongodb';
-    protected $collection = 'laracoll'; // equivalent to $table for MySQL 
 
-    protected $primaryKey = 'guid';
+    // equivalent to $table for MySQL 
+    protected $collection = 'laracoll'; 
 
     // defines the schema's top-level properties.
-    // ❌ skip nested definitions?
-    // each of these can be assgined as an object, array, array of objects etc
-    protected $fillable = ['guid','first_name', 'family_name', 'email', 'address'];
-    
+    protected $fillable = ['guid','first_name', 'family_name', 'email', 'address'];    
 }

routes/api.php

@@ -57,31 +57,44 @@
     This is just to show the code looks identical to the MongoDB version
 */
 Route::get('/create_eloquent_sql/', function (Request $request) {
-    $success = CustomerSQL::create([
-        'guid'        => 'cust_0000',
-        'first_name'  => 'John',
-        'family_name' => 'Doe',
-        'email'       => 'j.doe@gmail.com',
-        'address'     => '123 my street, my city, zip, state, country'
-    ]);
+
+    try {
+        $success = CustomerSQL::create([
+            'guid'        => 'cust_0000',
+            'first_name'  => 'John',
+            'family_name' => 'Doe',
+            'email'       => 'j.doe@gmail.com',
+            'address'     => '123 my street, my city, zip, state, country'
+        ]);
+        $msg = "OK";
+    }
+    catch (\Exception $e) {
+        $msg =  'Create user via Eloquent SQL model. Error: ' . $e->getMessage();
+    }
 
-    return ['msg' => 'executed', 'data' => $success];
+    return ['status' => 'executed', 'msg' => $msg];
 });
 
 /* 
     Create a new "customer" in our SQL database
     This is just to show the code looks identical to the MongoDB version
 */
 Route::get('/create_eloquent_mongo/', function (Request $request) {
-    $success = CustomerMongoDB::create([
-        'guid'        => 'cust_1111',
-        'first_name'  => 'John',
-        'family_name' => 'Doe',
-        'email'       => 'j.doe@gmail.com',          
-        'address'     => '123 my street, my city, zip, state, country'
-    ]);
-
-    return ['msg' => 'executed', 'data' => $success];
+    try {
+        $success = CustomerMongoDB::create([
+            'guid'        => 'cust_1111',
+            'first_name'  => 'John',
+            'family_name' => 'Doe',
+            'email'       => 'j.doe@gmail.com',          
+            'address'     => '123 my street, my city, zip, state, country'
+        ]);
+        $msg = "OK";
+    }
+    catch (\Exception $e) {
+        $msg =  'Create user via Eloquent MongoDB model. Error: ' . $e->getMessage();
+    }
+
+    return ['status' => 'executed', 'data' => $msg];
 });
 
 /* 
@@ -91,25 +104,25 @@
 
     $customer = CustomerMongoDB::where('guid', 'cust_1111')->get();
 
-    return ['msg' => 'executed', 'data' => $customer];
+    return ['status' => 'executed', 'data' => $customer];
 });
 
 /* 
     Update a record using Eloquent + MongoDB
 */
 Route::get('/update_eloquent/', function (Request $request) {
-    $result = CustomerMongoDB::where('guid', 'cust_1111')->update(['first_name','Jimmy']);
+    $result = CustomerMongoDB::where('guid', 'cust_1111')->update( ['first_name' => 'Jimmy'] );
 
-    return ['msg' => 'executed', 'data' => $result];
+    return ['status' => 'executed', 'data' => $result];
 });
 
 /* 
    Delete a record using Eloquent + MongoDB
 */
 Route::get('/delete_eloquent/', function (Request $request) {
-    $result = CustomerMongoDB::destroy('guid', 'cust_1111');
+    $result = CustomerMongoDB::where('guid', 'cust_1111')->delete();
 
-    return ['msg' => 'executed', 'data' => $result];
+    return ['status' => 'executed', 'data' => $result];
 });
 
 /* 
@@ -139,7 +152,7 @@
         $message = $e->getMessage();
     }
 
-    return ['msg' => $message, 'data' => $success];
+    return ['status' => $message, 'data' => $success];
 });
 
 
@@ -194,7 +207,7 @@
         $cust_array[] = $cust->newFromBuilder( $bson );
     }
 
-    return ['msg' => 'executed', 'whereraw' => $results, 'document' => $one_doc, 'cursor_array' => $cust_array];
+    return ['status' => 'executed', 'whereraw' => $results, 'document' => $one_doc, 'cursor_array' => $cust_array];
 });
 
 /* 
@@ -207,7 +220,7 @@
     $update = ['$set' => ['first_name' => 'Henry', 'address.street' => '777 new street name'] ];
     $result = $mdb_collection->updateOne($match, $update );
 
-    return ['msg' => 'executed', 'matched_docs' => $result->getMatchedCount(), 'modified_docs' => $result->getModifiedCount()];
+    return ['status' => 'executed', 'matched_docs' => $result->getMatchedCount(), 'modified_docs' => $result->getModifiedCount()];
 });
 
 /* 
@@ -219,7 +232,7 @@
     $match = ['guid' => 'cust_2222'];
     $result = $mdb_collection->deleteOne( $match );
 
-    return ['msg' => 'executed', 'deleted_docs' => $result->getDeletedCount() ];
+    return ['status' => 'executed', 'deleted_docs' => $result->getDeletedCount() ];
 });
 
 /* 
@@ -237,7 +250,7 @@
 
     $mdb_cursor = $mdb_collection->aggregate( $aggregation );
 
-    return ['msg' => 'executed', 'data' => $mdb_cursor->toArray() ];
+    return ['status' => 'executed', 'data' => $mdb_cursor->toArray() ];
 });
 
 /* 
@@ -249,63 +262,5 @@
     $indexOptions = ["unique" => true];
     $result = DB::connection('mongodb')->getCollection('laracoll')->createIndex($indexKeys, $indexOptions); 
 
-    return ['msg' => 'executed', 'data' => $result ];
-});
-
-
-/* 
-    TEMPORARY endpoint to test various snippets
-*/
-Route::get('/mongodb_api/', function (Request $request) {
-
-    $address = new stdClass;
-    $address->street = '123 my street name';
-    $address->city   = 'my city';
-    $address->zip    = '12345';
-
-    $emails = array( 'j.doe@gmail.com','j.doe@work.com' );
-
-    $customer = new CustomerMongoDB();
-    $customer->guid         = 'cust_1111';
-    $customer->first_name   = 'John';
-    $customer->family_name  = 'Doe';
-    $customer->email        = $emails;
-    $customer->address      = $address;    
-
-
-    $collectionName = $customer->getTable();
-
-    // ❌ what's the BEST WAY to access the native MongoDB collection object?
-    // getting it from the Model would be best since the Model knows about the connection AND the collection.
-    // but I don't see anything to achieve that
-
-    // this insertOne() works well with an stdClass, but ❌ not with a Model (use Model::save() instead)
-    //
-    // $result = DB::connection('mongodb')->getCollection('laracoll')->insertOne( $address );
-
-    // Create an index with a primary key
-    /* $indexKeys   = ["guid" => 1];
-    $indexOptions = ["unique" => true];
-    $result = DB::connection('mongodb')->getCollection('laracoll')->createIndex($indexKeys, $indexOptions); */
-
-    //
-    $query = ['guid' => 'cust_1111', ];
-    $cursor = DB::connection('mongodb')->getCollection('laracoll')->find( $query );
-    $result = $cursor->toArray(); 
-
-    /* 
-    // ❌ works, but not very convenient to pass parameters, data
-    $result = CustomerMongoDB::raw(function (Collection $collection) {
-        return $collection->insertOne( SOME DATA );
-    }); */
-
-
-    // aggregation pipeline
-    /* collection->aggregate($pipeline, $options)); */
-    
-    $resp       = new stdClass;
-    $resp->msg  = "executed";
-    $resp->data = $result;
-    return $resp;
-});
-
+    return ['status' => 'executed', 'data' => $result ];
+});