Mongodb Laravel Package

Getting Started

Minimal Setup in Laravel

1. Installation

   composer require doctrine/mongodb:^1.6.4
   

   (Note: This package is archived. For new projects, consider jenssegers/laravel-mongodb or the official mongodb/mongodb driver. Ensure PHP 7.4+ and MongoDB 4.0+ compatibility.)

2. Configure MongoDB Connection Add a MongoDB connection in config/database.php:

   'connections' => [
       'mongodb' => [
           'driver' => 'mongodb',
           'host' => env('DB_MONGODB_HOST', '127.0.0.1'),
           'port' => env('DB_MONGODB_PORT', 27017),
           'database' => env('DB_MONGODB_DATABASE', 'laravel'),
           'username' => env('DB_MONGODB_USERNAME'),
           'password' => env('DB_MONGODB_PASSWORD'),
           'options' => [
               'connect' => env('DB_MONGODB_CONNECT', false), // Set to `false` in production
           ],
       ],
   ],
   

3. First Query Use the MongoDBManager facade to interact with collections:

   use Doctrine\MongoDB\MongoDBManager;
   
   $manager = MongoDBManager::connection('mongodb');
   $collection = $manager->selectCollection('users');
   
   $user = $collection->findOne(['email' => '[email protected]']);
   

4. Eloquent Integration (Optional) For Eloquent-like syntax, use jenssegers/laravel-mongodb (recommended):

   composer require jenssegers/laravel-mongodb
   

Implementation Patterns

Common Workflows

1. CRUD Operations

   // Insert
   $collection->insertOne(['name' => 'John', 'email' => '[email protected]']);
   
   // Update with `replaceRoot` (fixed in 1.6.4)
   $collection->updateOne(
       ['email' => '[email protected]'],
       ['$set' => ['name' => 'John Doe']]
   );
   
   // Delete
   $collection->deleteOne(['email' => '[email protected]']);
   

2. Aggregation Pipeline (Fixed replaceRoot Stage)

   $pipeline = [
       ['$match' => ['status' => 'active']],
       ['$replaceRoot' => ['newRoot' => ['$mergeObjects' => ['$$ROOT', { 'activeSince' => '$createdAt' }]]]], // Now works correctly
       ['$group' => ['_id' => '$department', 'count' => ['$sum' => 1]]],
   ];
   $results = $collection->aggregate($pipeline);
   

3. Transactions (Multi-Document)

   $session = $manager->createSession();
   $session->startTransaction();
   
   try {
       $collection1->insertOne([...], ['session' => $session]);
       $collection2->insertOne([...], ['session' => $session]);
       $session->commitTransaction();
   } catch (\Exception $e) {
       $session->abortTransaction();
   }
   

4. Index Management

   $collection->createIndex(['email' => 1], ['unique' => true]);
   

Integration Tips

• Laravel Service Providers: Bind the MongoDBManager to the container:

  $this->app->singleton('mongodb', function ($app) {
      return MongoDBManager::connection('mongodb');
  });
  

• Query Builder: Use Doctrine\MongoDB\Query\Query for complex queries:

  $query = new Query();
  $query->where('age')->gt(18);
  $results = $collection->find($query);
  

• Hydration: Convert BSON to PHP objects with validation:

  $hydrator = new \Doctrine\MongoDB\Hydrator\ObjectHydrator();
  $user = $hydrator->hydrate($collection->findOne([...]), User::class);
  

Gotchas and Tips

Pitfalls

1. Archived Package: Still not maintained. Prefer jenssegers/laravel-mongodb or the official driver.
2. replaceRoot Stage: Fixed in 1.6.4, but test thoroughly if using aggregation pipelines with this stage.
3. Type Safety: MongoDB’s schema-less nature conflicts with Doctrine’s hydration. Validate data before hydration.
4. Connection Pooling: Set options['connect'] to false in production to avoid overhead.
5. BSON Limits: Large documents (>16MB) may fail. Use GridFS for files.
6. Transactions: Require MongoDB 4.0+. Test multi-document transactions carefully.

Debugging

• Query Logging: Enable debug mode:

  $manager->getClient()->setLoggerLevel(\MongoDB\Driver\Logger::DEBUG);
  

• BSON Errors: Inspect raw data with json_encode($document, JSON_PRETTY_PRINT).
• Aggregation Issues: Validate pipeline stages (e.g., replaceRoot syntax).

Extension Points

1. Custom Hydrators: Extend \Doctrine\MongoDB\Hydrator\HydratorInterface for custom mapping.
2. Event Listeners: Attach hooks to MongoDBManager for pre/post-query logic.
3. Query Middleware: Add global conditions via middleware:

   $manager->getClient()->executeQuery('admin.$cmd', ['ping' => 1]);
   

4. Schema Validation: Implement MongoDB\BSON\Type\Type for custom BSON types.
5. Aggregation Pipelines: Leverage fixed stages (e.g., replaceRoot) for complex transformations.