Laravel MongoDB

https://github.com/mongodb/laravel-mongodb
Admin
Laravel MongoDB is a MongoDB-based Eloquent model and Query builder that extends Laravel with native...
Tokens:141,788
Snippets:1,293
Trust Score:9.7
License:MIT
Update:1 month ago
Show doc for...
Tokens:
Raw
### Install skill-validator from source with go install

Source: https://github.com/mongodb/laravel-mongodb/blob/5.x/tools/review-skill/references/install-skill-validator.md

Installs skill-validator from source. Requires Go 1.25.5 or later.

```bash
go install github.com/agent-ecosystem/skill-validator/cmd/skill-validator@latest
```

--------------------------------

### Install skill-validator from pre-built binary

Source: https://github.com/mongodb/laravel-mongodb/blob/5.x/tools/review-skill/references/install-skill-validator.md

Installs a pre-built skill-validator binary to /usr/local/bin and makes it executable.

```bash
cp /path/to/skill-validator /usr/local/bin/ && chmod +x /usr/local/bin/skill-validator
```

--------------------------------

### Build aggregation pipeline with fluent stages

Source: https://github.com/mongodb/laravel-mongodb/blob/5.x/_autodocs/api-reference/aggregation-builder.md

Builds an aggregation pipeline using fluent stage methods. The example matches sales records with a date greater than or equal to $start, groups by region summing the amount, and sorts by total descending.

```php
use MongoDB\Builder\Accumulator;
use MongoDB\Builder\Expression;
use MongoDB\Builder\Query;

$pipeline = DB::table('sales')->aggregate()
    ->match(Query::gte('date', $start))
    ->group('_id' => '$region', 'total' => Accumulator::sum(Expression::fieldPath('amount')))
    ->sort(total: -1);
```

--------------------------------

### Get MongoDB client instance

Source: https://github.com/mongodb/laravel-mongodb/blob/5.x/_autodocs/api-reference/connection.md

Example of using getClient() to retrieve the MongoDB\Client instance.

```php
$client = DB::connection('mongodb')->getClient(); // MongoDB\Client
```

--------------------------------

### Cache facade usage example

Source: https://github.com/mongodb/laravel-mongodb/blob/5.x/_autodocs/api-reference/cache.md

Example usage of the cache facade with the MongoStore: put, get, increment, and lock acquisition with release in a finally block.

```php
use Illuminate\Support\Facades\Cache;

Cache::put('foo', 'bar', 60);
$value = Cache::get('foo'); // 'bar'
Cache::increment('counter'); // numeric counters are stored natively

// With a lock:
$lock = Cache::lock('processing', 30);
if ($lock->get()) {
    try {
        // exclusive section
    } finally {
        $lock->release();
    }
}
```

--------------------------------

### Get MongoDB database instance

Source: https://github.com/mongodb/laravel-mongodb/blob/5.x/_autodocs/api-reference/connection.md

Example of using getDatabase() to retrieve the MongoDB\Database instance.

```php
$db = DB::connection('mongodb')->getDatabase(); // MongoDB\Database
```

--------------------------------

### Install Laravel Scout

Source: https://github.com/mongodb/laravel-mongodb/blob/5.x/resources/boost/skills/laravel-mongodb/references/search-engine.md

Install Laravel Scout and publish its configuration files. Run these commands in your project root.

```bash
composer require laravel/scout
php artisan vendor:publish --provider="Laravel\Scout\ScoutServiceProvider"
```

--------------------------------

### push() usage examples

Source: https://github.com/mongodb/laravel-mongodb/blob/5.x/_autodocs/api-reference/query-builder.md

Example usage of push() with a single value and with a list (using $each).

```php
DB::table('users')->where('_id', $id)->push('tags', 'php');      // $push
DB::table('users')->where('_id', $id)->push('tags', ['a','b']);  // $push $each
```

--------------------------------

### Install PHP MongoDB extension with pie

Source: https://github.com/mongodb/laravel-mongodb/blob/5.x/resources/boost/skills/laravel-mongodb/references/installation.md

Installs the MongoDB PHP extension using the cross-platform PHP extension installer 'pie'.

```bash
pie install mongodb/mongodb-extension
```

--------------------------------

### Verify skill-validator installation

Source: https://github.com/mongodb/laravel-mongodb/blob/5.x/tools/review-skill/references/install-skill-validator.md

Verifies the skill-validator installation by printing its version.

```bash
skill-validator --version
```

--------------------------------

### has() usage example

Source: https://github.com/mongodb/laravel-mongodb/blob/5.x/_autodocs/api-reference/eloquent-traits.md

Usage example for `has()`: querying users that have at least 3 posts.

```php
User::has('posts', '>=', 3)->get();
```

--------------------------------

### Get raw MongoDB collection and insert

Source: https://github.com/mongodb/laravel-mongodb/blob/5.x/_autodocs/api-reference/connection.md

Example of using getCollection() to obtain a raw MongoDB\Collection and insert a document.

```php
$collection = DB::connection('mongodb')->getCollection('logs'); // MongoDB\Collection
$collection->insertOne(['msg' => 'hi']);
```

--------------------------------

### withAggregate usage example

Source: https://github.com/mongodb/laravel-mongodb/blob/5.x/_autodocs/api-reference/eloquent-traits.md

Usage example for `withAggregate` and its convenience methods `withCount` and `withSum`.

```php
$posts = Post::withCount('comments')->withSum('votes', 'score')->get();
```

--------------------------------

### Run app container with docker-compose

Source: https://github.com/mongodb/laravel-mongodb/blob/5.x/CONTRIBUTING.md

Starts the application container via Docker Compose. Docker can be slow to start, so running tests locally with `composer run test` is an alternative.

```bash
$ docker-compose run app
```

--------------------------------

### Creating indexes with index()

Source: https://github.com/mongodb/laravel-mongodb/blob/5.x/_autodocs/api-reference/schema.md

Example of creating an ascending index on 'email' and a TTL index on 'created_at' with expireAfterSeconds.

```php
Schema::table('users', function (Blueprint $c) {
    $c->index(['email' => 1]);                       // ascending index
    $c->index('created_at', null, null, ['expireAfterSeconds' => 86400]); // TTL
});
```

--------------------------------

### create collection with unique index example

Source: https://github.com/mongodb/laravel-mongodb/blob/5.x/_autodocs/api-reference/schema.md

Example usage of create() to create a 'users' collection with a unique index on the 'email' field.

```php
Schema::connection('mongodb')->create('users', function (Blueprint $collection) {
    $collection->index('email', null, null, ['unique' => true]);
});
```

--------------------------------

### Use MongoDB connection from code

Source: https://github.com/mongodb/laravel-mongodb/blob/5.x/resources/boost/skills/laravel-mongodb/references/connection.md

Shows how to use the MongoDB connection from code. Demonstrates inserting a document, getting the MongoDB\Database and MongoDB\Client instances, and getting a collection. Notes that getMongoDB() and getMongoClient() are deprecated, and that ->collection() does not exist.

```php
use Illuminate\Support\Facades\DB;

DB::connection('mongodb')->table('logs')->insert(['msg' => 'hi']);

$db     = DB::connection('mongodb')->getDatabase();   // MongoDB\Database
$client = DB::connection('mongodb')->getClient();     // MongoDB\Client
// deprecated: getMongoDB() → getDatabase(), getMongoClient() → getClient()

$collection = DB::connection('mongodb')->getCollection('logs');
// note: ->collection() does not exist; use ->table() for the query builder
```

--------------------------------

### Install MongoDB extension in Dockerfile

Source: https://github.com/mongodb/laravel-mongodb/blob/5.x/resources/boost/skills/laravel-mongodb/references/installation.md

Adds MongoDB extension installation and enabling to a Dockerfile for PHP containers.

```dockerfile
RUN pecl install mongodb && docker-php-ext-enable mongodb
```

--------------------------------

### Creating search and vector search indexes

Source: https://github.com/mongodb/laravel-mongodb/blob/5.x/_autodocs/api-reference/schema.md

Example of creating a search index with dynamic mappings and a vector search index with a vector field.

```php
Schema::table('products', function (Blueprint $c) {
    $c->searchIndex(['mappings' => ['dynamic' => true]]);
    $c->vectorSearchIndex(['fields' => [
        ['type' => 'vector', 'path' => 'embedding', 'numDimensions' => 768, 'similarity' => 'cosine'],
    ]]);
});
```

--------------------------------

### database-query-mongodb usage example

Source: https://github.com/mongodb/laravel-mongodb/blob/5.x/_autodocs/endpoints.md

Example configuration for the database-query-mongodb tool. It runs a read-only MQL aggregate command against the 'mongodb' connection, filtering paid orders and grouping totals by region.

```yaml
database-query-mongodb:
  command: { "aggregate": "orders", "pipeline": [ { "$match": { "status": "paid" } }, { "$group": { "_id": "$region", "total": { "$sum": "$amount" } } } ] }
  connection: mongodb
```

--------------------------------

### Install PHP MongoDB extension on macOS with Homebrew

Source: https://github.com/mongodb/laravel-mongodb/blob/5.x/resources/boost/skills/laravel-mongodb/references/installation.md

Installs PHP and the MongoDB extension on macOS using Homebrew, building the extension from source.

```bash
brew install php && brew install --build-from-source php-mongodb
```

--------------------------------

### Example usage of prepareFieldsForResult

Source: https://github.com/mongodb/laravel-mongodb/blob/5.x/_autodocs/api-reference/query-grammar.md

Example usage showing that after fetching rows, each row has an 'id' attribute (not '_id') and Carbon date attributes.

```php
use Illuminate\Support\Facades\DB;

$rows = DB::table('users')->get();
// each row has ->id (not ->_id) and Carbon date attributes
```

--------------------------------

### Install mongodb/laravel-mongodb via Composer

Source: https://github.com/mongodb/laravel-mongodb/blob/5.x/resources/boost/skills/laravel-mongodb/references/installation.md

Installs the mongodb/laravel-mongodb Composer package. The Laravel service provider is auto-discovered, so no manual registration is needed.

```bash
composer require mongodb/laravel-mongodb
```

--------------------------------

### Dispatch a batch with Bus facade

Source: https://github.com/mongodb/laravel-mongodb/blob/5.x/_autodocs/api-reference/bus.md

Example of dispatching a batch using the Bus facade, which stores the batch via MongoBatchRepository.

```php
use Illuminate\Support\Facades\Bus;
use MongoDB\Laravel\Bus\MongoBatchRepository;

$batch = Bus::batch([...])->dispatch(); // stored via MongoBatchRepository
```

--------------------------------

### Install skill-validator with Homebrew

Source: https://github.com/mongodb/laravel-mongodb/blob/5.x/tools/review-skill/references/install-skill-validator.md

Installs skill-validator via Homebrew on macOS. Requires the Homebrew tap to be added first.

```bash
brew tap agent-ecosystem/homebrew-tap
brew install skill-validator
```

--------------------------------

### search usage example

Source: https://github.com/mongodb/laravel-mongodb/blob/5.x/_autodocs/api-reference/eloquent-builder.md

Example of using the search method with an Atlas Search operator. Requires importing MongoDB\Builder\Search.

```php
use MongoDB\Builder\Search;

$articles = Article::search(Search::text('lorem ipsum', path: 'body'));
```

--------------------------------

### Install PHP MongoDB extension with PECL

Source: https://github.com/mongodb/laravel-mongodb/blob/5.x/resources/boost/skills/laravel-mongodb/references/installation.md

Installs the MongoDB PHP extension via PECL, noted as a last resort option.

```bash
pecl install mongodb
```

--------------------------------

### Aggregate count example

Source: https://github.com/mongodb/laravel-mongodb/blob/5.x/_autodocs/api-reference/query-builder.md

Example of using the aggregate method with a groupBy and the count function. Returns the count of orders per status.

```php
$results = DB::table('orders')->groupBy('status')
    ->aggregate('count', ['*']);
```

--------------------------------

### Add Go bin directory to PATH

Source: https://github.com/mongodb/laravel-mongodb/blob/5.x/tools/review-skill/references/install-skill-validator.md

Adds the Go bin directory (usually ~/go/bin) to the PATH so the installed skill-validator binary can be found.

```bash
export PATH="$PATH:$(go env GOPATH)/bin"
```

--------------------------------

### firstOrCreate usage example

Source: https://github.com/mongodb/laravel-mongodb/blob/5.x/_autodocs/api-reference/eloquent-builder.md

Example usage of firstOrCreate with attributes and values. This is the fallback behavior inside a transaction when a duplicate-key error would abort the transaction.

```php
$user = User::firstOrCreate(
    ['email' => 'a@example.com'],
    ['name' => 'Alice'],
);
```

--------------------------------

### Install PHP MongoDB extension on Ubuntu/Debian

Source: https://github.com/mongodb/laravel-mongodb/blob/5.x/resources/boost/skills/laravel-mongodb/references/installation.md

Installs the MongoDB PHP extension on Ubuntu or Debian systems using the apt package manager.

```bash
sudo apt install php-mongodb
```

--------------------------------

### HasMany relationship example

Source: https://github.com/mongodb/laravel-mongodb/blob/5.x/_autodocs/api-reference/relations.md

Example of defining a HasMany relationship in a User model, returning posts with foreign key 'user_id'.

```php
class User extends Model
{
    public function posts()
    {
        return $this->hasMany(Post::class, 'user_id');
    }
}
```

--------------------------------

### Manual transaction with beginTransaction, commit, and rollBack

Source: https://github.com/mongodb/laravel-mongodb/blob/5.x/_autodocs/api-reference/connection.md

Example of manually managing a transaction with beginTransaction, commit, and rollBack, including error handling.

```php
use Illuminate\Support\Facades\DB;

DB::connection('mongodb')->beginTransaction();
try {
    // ... model saves ...
    DB::connection('mongodb')->commit();
} catch (Throwable $e) {
    DB::connection('mongodb')->rollBack();
    throw $e;
}
```

--------------------------------

### where() usage examples

Source: https://github.com/mongodb/laravel-mongodb/blob/5.x/_autodocs/api-reference/query-builder.md

Examples of using the where method with different operators: comparison, array, like, and regex.

```php
DB::table('users')->where('age', '>', 21)->get();
DB::table('users')->where(['name' => 'John', 'age' => ['$gt' => 21]])->get();
DB::table('users')->where('name', 'like', 'joh%')->get(); // compiles to Regex('^joh.*$', 'i')
DB::table('users')->where('name', 'regex', '/^joh/i')->get();
```

--------------------------------

### vectorSearch usage example

Source: https://github.com/mongodb/laravel-mongodb/blob/5.x/_autodocs/api-reference/eloquent-builder.md

Example of using the vectorSearch method with named arguments for index, path, queryVector, and limit.

```php
$movies = Movie::vectorSearch(
    index: 'vector_index',
    path: 'embedding',
    queryVector: $vector,
    limit: 5,
);
```

--------------------------------

### Session configuration in config/session.php

Source: https://github.com/mongodb/laravel-mongodb/blob/5.x/_autodocs/api-reference/session.md

Example configuration for using the mongodb session driver, including connection, table, and lifetime settings.

```php
// config/session.php
'driver' => env('SESSION_DRIVER', 'mongodb'),
'connection' => 'mongodb',
'table' => 'sessions',
'lifetime' => 120,
```

--------------------------------

### MassPrunable usage example

Source: https://github.com/mongodb/laravel-mongodb/blob/5.x/_autodocs/api-reference/eloquent-traits.md

Example model using the MassPrunable trait to define a prunable query for logs older than 30 days.

```php
use MongoDB\Laravel\Eloquent\MassPrunable;

class Log extends Model
{
    use MassPrunable;

    public function prunable()
    {
        return static::where('created_at', '<', now()->subDays(30));
    }
}
```

--------------------------------

### database-info response JSON structure

Source: https://github.com/mongodb/laravel-mongodb/blob/5.x/_autodocs/endpoints.md

Example response from the database-info tool, showing the structure with database, connection, and collections details including type, estimated_document_count, options, and indexes.

```json
{
  "database": "<database name>",
  "connection": "<connection name>",
  "collections": {
    "<collection name>": {
      "type": "collection|view|timeseries",
      "estimated_document_count": 0,
      "options": {},
      "indexes": {
        "<index name>": { "keys": {}, "unique": false }
      }
    }
  }
}
```

--------------------------------

### ObjectId Usage Example

Source: https://github.com/mongodb/laravel-mongodb/blob/5.x/_autodocs/api-reference/casts.md

Example of using the ObjectId cast with a 24-character hex string. The cast normalizes storage to an ObjectId.

```php
$user = User::find('507f1f77bcf86cd799439011'); // ObjectId cast normalizes storage
```

--------------------------------

### Run tests inside Docker container

Source: https://github.com/mongodb/laravel-mongodb/blob/5.x/CONTRIBUTING.md

Enters the tests container interactively, installs dependencies, and runs the test suite. Requires PHP CLI with the MongoDB extension and a running MongoDB server; a replica set is needed for transaction tests.

```bash
$ docker-compose run -it tests bash
# Inside the container
$ composer install
$ composer run test
```

--------------------------------

### Using transaction() with a closure

Source: https://github.com/mongodb/laravel-mongodb/blob/5.x/_autodocs/api-reference/connection.md

Example of using the transaction method with a closure to perform atomic balance updates.

```php
DB::connection('mongodb')->transaction(function ($connection) {
    $connection->table('accounts')->where('_id', $from)->decrement('balance', 100);
    $connection->table('accounts')->where('_id', $to)->increment('balance', 100);
});
```

--------------------------------

### Unset a field and save

Source: https://github.com/mongodb/laravel-mongodb/blob/5.x/_autodocs/api-reference/eloquent-model.md

Example usage of unset() followed by save() to issue a $unset operation on the server.

```php
$user->unset('temporary_field');
$user->save(); // issues $unset: {temporary_field: true}
```

--------------------------------

### enableQueryLog() method signature

Source: https://github.com/mongodb/laravel-mongodb/blob/5.x/_autodocs/api-reference/connection.md

Method signature for enableQueryLog(). Enables the query log and installs a MongoDB\Laravel\CommandSubscriber on the client.

```php
public function enableQueryLog()
```

--------------------------------

### get

Source: https://github.com/mongodb/laravel-mongodb/blob/5.x/_autodocs/api-reference/aggregation-builder.md

Executes the aggregation pipeline and returns the results as a collection.

```APIDOC
## `get(array $options = []): LaravelCollection|LazyCollection`

### Description
Executes the pipeline and returns a collection of result documents.

### Parameters
- `$options` (array) - Optional - Execution options to merge with defaults

### Returns
- `LaravelCollection|LazyCollection` - The result set

### Example
```php
$results = $builder->get();
```
```

--------------------------------

### Random sampling with $sample aggregate

Source: https://github.com/mongodb/laravel-mongodb/blob/5.x/resources/boost/skills/laravel-mongodb/references/query-builder.md

Shows the correct way to get random records. inRandomOrder() is not supported; use raw() with an aggregate pipeline containing $sample.

```php
// WRONG
$movies = Movie::inRandomOrder()->take(5)->get();

// CORRECT
$movies = Movie::raw(fn ($c) => $c->aggregate([
    ['$sample' => ['size' => 5]],
]));
```

--------------------------------

### BinaryUuid Usage Example

Source: https://github.com/mongodb/laravel-mongodb/blob/5.x/_autodocs/api-reference/casts.md

Example of setting and retrieving a UUID attribute with the BinaryUuid cast. The UUID string is stored as a Binary UUID and retrieved back as the same string.

```php
$model->uuid = 'c9bf9e57-1685-4c89-bafb-ff5af830be8a';
$model->save();                       // stored as Binary UUID
echo $model->uuid;                     // 'c9bf9e57-1685-4c89-bafb-ff5af830be8a'
```

--------------------------------

### Set timeouts in MongoDB URI

Source: https://github.com/mongodb/laravel-mongodb/blob/5.x/resources/boost/skills/laravel-mongodb/references/connection.md

Example URI with timeout options. serverSelectionTimeoutMS and socketTimeoutMS are set in the URI. maxPoolSize and minPoolSize have no effect because the PHP extension drives libmongoc in single-threaded mode.

```text
mongodb+srv://.../db?serverSelectionTimeoutMS=5000&socketTimeoutMS=30000
```

--------------------------------

### getServerVersion(): string

Source: https://github.com/mongodb/laravel-mongodb/blob/5.x/_autodocs/api-reference/connection.md

Runs the buildInfo command and returns the server version string. Marked @internal.

```php
public function getServerVersion(): string
```

--------------------------------

### Inspect generated query with dump() and toMql()

Source: https://github.com/mongodb/laravel-mongodb/blob/5.x/resources/boost/skills/laravel-mongodb/references/query-builder.md

Shows the correct way to inspect the generated MongoDB query. toSql() does not exist; use dump() to output the query or toMql() to get the MongoDB query language representation.

```php
// WRONG — toSql() does not exist
$sql = User::where('active', true)->toSql();

// CORRECT
User::query()->where('active', true)->dump();
dd(User::query()->where('active', true)->toMql());
```

--------------------------------

### Raw aggregation entry point with Post::raw()

Source: https://github.com/mongodb/laravel-mongodb/blob/5.x/resources/boost/skills/laravel-mongodb/references/query-builder.md

Shows how to use the raw() method to run an aggregation pipeline directly on the collection, including $match, $group, $sort, and $limit stages.

```php
$result = Post::raw(fn ($collection) => $collection->aggregate([
    ['$match'  => ['published' => true]],
    ['$group'  => ['_id' => '$author_id', 'total' => ['$sum' => 1]]],
    ['$sort'   => ['total' => -1]],
    ['$limit'  => 10],
]));
```

--------------------------------

### EmbedsMany usage example

Source: https://github.com/mongodb/laravel-mongodb/blob/5.x/_autodocs/api-reference/relations.md

Shows how to create, retrieve, save, and destroy embedded addresses using the EmbedsMany relation. Demonstrates the create, getResults, save, and destroy methods.

```php
$user = User::find($id);
$user->addresses()->create(['street' => 'Main St']);         // EmbedsMany::create
$address = $user->addresses()->getResults()->first();
$user->addresses()->save($address);
$user->addresses()->destroy($address->getKey());
```

--------------------------------

### get($columns = [])

Source: https://github.com/mongodb/laravel-mongodb/blob/5.x/_autodocs/api-reference/query-builder.md

Executes the query and returns a collection of results.

```APIDOC
## get($columns = [])

### Description
Runs the query and returns an `Illuminate\Support\Collection` of row objects. The `*` column is dropped because MongoDB returns full documents.

### Method
PHP method

### Endpoint
`Builder::get($columns = [])`

### Parameters
- **$columns** (array) - Optional - Columns to select; `*` is dropped.

### Returns
`Illuminate\Support\Collection` of row objects (root type `object`, nested documents `array`, aliases `_id` → `id`).
```

--------------------------------

### Define embedded relations with embedsMany and embedsOne

Source: https://github.com/mongodb/laravel-mongodb/blob/5.x/_autodocs/api-reference/eloquent-traits.md

Shows the method signatures for embedsMany and embedsOne, and a usage example defining a User model with addresses and profile relations. The signatures list parameters with defaults: $localKey defaults to the relation name, $foreignKey to Str::snake(class_basename($this)), and $relation to the calling method name. The example returns EmbedsMany and EmbedsOne relations respectively.

```php
public function embedsMany($related, $localKey = null, $foreignKey = null, $relation = null)
```

```php
public function embedsOne($related, $localKey = null, $foreignKey = null, $relation = null)
```

```php
class User extends Model
{
    public function addresses()
    {
        return $this->embedsMany(Address::class);
    }

    public function profile()
    {
        return $this->embedsOne(Profile::class);
    }
}
```

--------------------------------

### Catch errors in consumer code

Source: https://github.com/mongodb/laravel-mongodb/blob/5.x/_autodocs/errors.md

Example try/catch blocks for handling BulkWriteException (duplicate key code 11000) and InvalidArgumentException from whereBetween, which requires a [min, max] array.

```php
<?php

use Illuminate\Support\Facades\DB;
use InvalidArgumentException;
use MongoDB\Driver\Exception\BulkWriteException;

try {
    $user = User::firstOrCreate(['email' => $email]);
} catch (BulkWriteException $e) {
    if ($e->getCode() === 11000) {
        // duplicate key — handle race condition
    }
    throw $e;
}

try {
    DB::connection('mongodb')->table('users')->whereBetween('age', $min)->get();
} catch (InvalidArgumentException $e) {
    // whereBetween requires [min, max]
}
```

--------------------------------

### Check Claude CLI availability

Source: https://github.com/mongodb/laravel-mongodb/blob/5.x/tools/review-skill/SKILL.md

Verifies the Claude CLI is available when LLM_SCORING=true. If not found, instruct the user to install Claude Code and authenticate by running claude interactively. Do not proceed with LLM scoring until this succeeds.

```bash
claude --version
```

--------------------------------

### Define IndexPostJob class for MongoDB queue

Source: https://github.com/mongodb/laravel-mongodb/blob/5.x/resources/boost/skills/laravel-mongodb/references/queues.md

Example job class for MongoDB queues. Implements ShouldQueue with 3 tries and a 60-second timeout. The constructor accepts a string post ID; the comment warns to pass string IDs, never ObjectId instances, for clean serialization.

```php
<?php

namespace App\Jobs;

use Illuminate\Bus\Queueable;
use Illuminate\Contracts\Queue\ShouldQueue;
use Illuminate\Foundation\Bus\Dispatchable;
use Illuminate\Queue\InteractsWithQueue;
use Illuminate\Queue\SerializesModels;

final class IndexPostJob implements ShouldQueue
{
    use Dispatchable, InteractsWithQueue, Queueable, SerializesModels;

    public int $tries   = 3;
    public int $timeout = 60;

    public function __construct(public readonly string $postId) {}
    // Pass string IDs, never ObjectId instances — they must serialize cleanly.

    public function handle(): void
    {
        // ...
    }
}
```

--------------------------------

### get method signature

Source: https://github.com/mongodb/laravel-mongodb/blob/5.x/_autodocs/api-reference/aggregation-builder.md

Method signature for get. Executes the pipeline and returns a LaravelCollection or LazyCollection of results.

```php
public function get(array $options = []): LaravelCollection|LazyCollection
```

--------------------------------

### Sample Recipe Document

Source: https://github.com/mongodb/laravel-mongodb/wiki/Matching-by-ObjectId-When-Using-Raw-Query-or-Aggregation

Sample document from the 'recipes' collection used to demonstrate matching by ObjectId in raw queries or aggregations. Contains fields like _id, title, reviews array, and user information.

```json
{
    "_id" : ObjectId("57f79499cd3aa1000a5643b7"),
    "_class" : "ng.supermart.recipes.DModels.Recipe",
    "title" : "Oyelaking's Noodles Special",
    "description" : "My special indomie recipe",
    "durationHrs" : 0,
    "durationMins" : 25,
    "cat" : [ 
        "Main dish", 
        "Breakfast"
    ],
    "tags" : [ 
        "noodles", 
        "short preparation time", 
        "easy to prepare"
    ],
    "user" : {
        "userId" : 10007,
        "userName" : "Dean Marko"
    },
    "enabled" : true,
    "updated_at" : ISODate("2016-10-10T21:29:15.176Z"),
    "created" : ISODate("2016-10-07T12:27:05.906Z"),
    "reviews" : [ 
        {
            "rating" : 4.0,
            "comment" : "This is just excellent, I tell you.",
            "user" : {
                "userId" : 10007,
                "userName" : "Dean Marko"
            }
        }, 
        {
            "rating" : 5,
            "comment" : "This is just excellent, I tell you.",
            "user" : {
                "userId" : 10008,
                "userName" : "Dean Marko"
            }
        }, 
        {
            "rating" : 5,
            "comment" : "This is just excellent, I tell you.",
            "user" : {
                "userId" : 10009,
                "userName" : "Dean Marko"
            }
        }, 
        {
            "rating" : 5,
            "comment" : "This is just excellent, I tell you.",
            "user" : {
                "userId" : 10010,
                "userName" : "Dean Marko"
            }
        }
    ],
        "url" : "oyelakings-indomie-special"
    }
```

--------------------------------

### create method signature

Source: https://github.com/mongodb/laravel-mongodb/blob/5.x/_autodocs/api-reference/schema.md

Signature for create(), which creates the collection via blueprint->create($options) and runs the callback.

```php
public function create($table, ?Closure $callback = null, array $options = [])
```

--------------------------------

### hasColumns usage example

Source: https://github.com/mongodb/laravel-mongodb/blob/5.x/_autodocs/api-reference/schema.md

Example usage of hasColumns() to check if the 'email' and 'name' fields exist in the 'users' collection. Returns a boolean.

```php
Schema::connection('mongodb')->hasColumns('users', ['email', 'name']); // bool
```

--------------------------------

### threadCount()

Source: https://github.com/mongodb/laravel-mongodb/blob/5.x/_autodocs/api-reference/connection.md

Runs the serverStatus command and returns connections.current as reported by the server.

```php
public function threadCount()
```

--------------------------------

### Manual transaction control with beginTransaction, commit, rollBack

Source: https://github.com/mongodb/laravel-mongodb/blob/5.x/resources/boost/skills/laravel-mongodb/references/transactions.md

Use this snippet when you need explicit control over the transaction lifecycle. Begin a transaction, perform writes, then commit or roll back on exception. The rollBack is followed by rethrowing the exception.

```php
$connection = DB::connection('mongodb');
$connection->beginTransaction();

try {
    // writes...
    $connection->commit();
} catch (\Throwable $e) {
    $connection->rollBack();
    throw $e;
}
```

--------------------------------

### createOrFirst

Source: https://github.com/mongodb/laravel-mongodb/blob/5.x/_autodocs/api-reference/eloquent-builder.md

Documentation for the createOrFirst method of the Eloquent builder.

```APIDOC
## createOrFirst(array $attributes = [], Closure|array $values = [])

### Description
Attempts to create a new model with the given attributes and values. If a duplicate key error (code 11000) occurs, it returns the first matching record instead. Inside a transaction, it falls back to `firstOrCreate()` to avoid aborting the transaction.

### Method
createOrFirst

### Signature
```php
public function createOrFirst(array $attributes = [], Closure|array $values = [])
```

### Parameters
- **$attributes** (array) - Required - The attributes to match for finding an existing record.
- **$values** (Closure|array) - Optional - Additional values to set when creating a new record.

### Behavior
- Attempts `create()` with the given attributes and values.
- On `MongoDB\Driver\Exception\BulkWriteException` with code `11000` (duplicate key), returns `$this->where($attributes)->first()`.
- Re-throws the exception if no matching record is found.
- Inside a transaction, falls back to `firstOrCreate()` because a duplicate-key error would abort the transaction.

### Example
```php
$user = User::firstOrCreate(
    ['email' => 'a@example.com'],
    ['name' => 'Alice'],
);
```
```

--------------------------------

### Get distinct values as scalars with `distinct()->pluck()`

Source: https://github.com/mongodb/laravel-mongodb/blob/5.x/resources/boost/skills/laravel-mongodb/references/query-builder.md

Shows the correct way to get distinct values as scalars. The wrong approach uses `distinct('genre')->get()` which returns model objects, not scalars. Use `->distinct()->pluck('field')` or an explicit aggregation with `$group` and `$sort` for more control.

```php
// WRONG — returns Collection of model objects, NOT ['Action', 'Comedy', 'Drama']
$genres = Movie::distinct('genre')->get();

// CORRECT — returns a flat Collection of scalar strings
$genres = Movie::distinct()->pluck('genre');

// CORRECT — explicit aggregation when you need sorting or more control
$genres = Movie::raw(fn ($c) => $c->aggregate([
    ['$group' => ['_id' => '$genre']],
    ['$sort'  => ['_id' => 1]],
]))->pluck('_id');
```

--------------------------------

### MongoDBServiceProvider boot() method

Source: https://github.com/mongodb/laravel-mongodb/blob/5.x/_autodocs/api-reference/service-providers.md

Method signature for the boot method of MongoDBServiceProvider. It sets the connection resolver and event dispatcher on MongoDB\Laravel\Eloquent\Model.

```php
public function boot()
```

--------------------------------

### first method signature

Source: https://github.com/mongodb/laravel-mongodb/blob/5.x/_autodocs/api-reference/aggregation-builder.md

Method signature for first. Runs a clone of the pipeline with a limit(1) stage and returns the first result.

```php
public function first(array $options = []): mixed
```

--------------------------------

### get method signature

Source: https://github.com/mongodb/laravel-mongodb/blob/5.x/_autodocs/api-reference/query-builder.md

Signature of the get method. Runs the query and returns an Illuminate\Support\Collection of row objects. The $columns parameter is optional and defaults to an empty array; '*' is dropped because MongoDB returns full documents.

```php
public function get($columns = [])
```

--------------------------------

### MongoDB model belongsToMany example

Source: https://github.com/mongodb/laravel-mongodb/blob/5.x/_autodocs/api-reference/eloquent-traits.md

Example of a MongoDB model using belongsToMany to store the relation in an array field. The method call passes 'users' as the foreign pivot key and 'roles' as the related pivot key.

```php
// MongoDB model (storing the relation in an array field):
public function roles()
{
    return $this->belongsToMany(Role::class, null, 'users', 'roles');
}
```

--------------------------------

### getMongoClient()

Source: https://github.com/mongodb/laravel-mongodb/blob/5.x/_autodocs/api-reference/connection.md

Deprecated method to get the MongoDB client.

```APIDOC
## `getMongoClient()`

### Description
Deprecated since 5.2. Returns the underlying MongoDB\Client. Use `getClient()` instead.

### Method
getMongoClient

### Returns
- `MongoDB\Client` - The client object.
```

--------------------------------

### getMongoDB()

Source: https://github.com/mongodb/laravel-mongodb/blob/5.x/_autodocs/api-reference/connection.md

Deprecated method to get the MongoDB database.

```APIDOC
## `getMongoDB()`

### Description
Deprecated since 5.2. Returns the MongoDB\Database object. Use `getDatabase()` instead.

### Method
getMongoDB

### Returns
- `MongoDB\Database` - The database object.
```

--------------------------------

### disableQueryLog() method signature

Source: https://github.com/mongodb/laravel-mongodb/blob/5.x/_autodocs/api-reference/connection.md

Method signature for disableQueryLog(). Disables the query log and removes the CommandSubscriber if installed.

```php
public function disableQueryLog()
```

--------------------------------

### firstOrCreate method signature

Source: https://github.com/mongodb/laravel-mongodb/blob/5.x/_autodocs/api-reference/eloquent-builder.md

Finds a matching instance, else creates. Inside a transaction, uses create() (regular create path guarded by the transaction); outside transactions, uses createOrFirst().

```php
public function firstOrCreate(array $attributes = [], Closure|array $values = [])
```

--------------------------------

### Applying jsonSchema validator

Source: https://github.com/mongodb/laravel-mongodb/blob/5.x/_autodocs/api-reference/schema.md

Example of applying a JSON Schema validator requiring an email string field.

```php
Schema::table('users', function (Blueprint $c) {
    $c->jsonSchema([
        'bsonType' => 'object',
        'required' => ['email'],
        'properties' => ['email' => ['bsonType' => 'string']],
    ]);
});
```

--------------------------------

### Create Atlas Search index

Source: https://github.com/mongodb/laravel-mongodb/blob/5.x/resources/boost/skills/laravel-mongodb/references/search-engine.md

Create an Atlas Search index named 'scout' on the 'products' collection with explicit field mappings. This is required for Scout to work.

```php
Schema::connection('mongodb')->create('products', function (Blueprint $c): void {
    $c->searchIndex([
        'mappings' => [
            'dynamic' => false,
            'fields'  => [
                'name'        => ['type' => 'string'],
                'description' => ['type' => 'string'],
                'tags'        => ['type' => 'string'],
                'price'       => ['type' => 'number'],
            ],
        ],
    ], 'scout');
});
```

--------------------------------

### sparse() and sparse_and_unique() method signatures

Source: https://github.com/mongodb/laravel-mongodb/blob/5.x/_autodocs/api-reference/schema.md

Method signatures for sparse and sparse_and_unique indexes. sparse creates an index with sparse => true; sparse_and_unique adds unique as well.

```php
public function sparse($columns = null, $options = [])
```

```php
public function sparse_and_unique($columns = null, $options = [])
```

--------------------------------

### ScoutEngine constructor

Source: https://github.com/mongodb/laravel-mongodb/blob/5.x/_autodocs/api-reference/scout-engine.md

Constructor for the ScoutEngine class. Requires a MongoDB Database instance and a boolean for soft-delete filtering; the index definitions array is optional and defaults to an empty array.

```php
public function __construct(
    private Database $database,
    private bool $softDelete,
    private array $indexDefinitions = [],
)
```

--------------------------------

### Configure MongoDB connection in config/database.php

Source: https://github.com/mongodb/laravel-mongodb/blob/5.x/resources/boost/skills/laravel-mongodb/references/installation.md

Adds a 'mongodb' entry to the 'connections' array in config/database.php to configure the MongoDB connection using environment variables.

```php
'connections' => [
    'mongodb' => [
        'driver'   => 'mongodb',
        'dsn'      => env('MONGODB_URI', 'mongodb://localhost:27017'),
        'database' => env('MONGODB_DATABASE', 'laravel'),
    ],
],
```

--------------------------------

### MongoStore::getPrefix

Source: https://github.com/mongodb/laravel-mongodb/blob/5.x/_autodocs/api-reference/cache.md

Returns the key prefix.

```APIDOC
## MongoStore::getPrefix

### Description
Returns the key prefix used for cache items.

### Method
getPrefix

### Signature
```php
public function getPrefix(): string
```

### Returns
- **string** - The key prefix.
```

--------------------------------

### Get latest record with first()

Source: https://github.com/mongodb/laravel-mongodb/blob/5.x/_autodocs/api-reference/aggregation-builder.md

Retrieves the most recent sales record by sorting by date descending and calling first().

```php
$latest = DB::table('sales')->aggregate()
    ->sort(date: -1)
    ->first();
```

--------------------------------

### Import MongoDB PHP driver GPG key

Source: https://github.com/mongodb/laravel-mongodb/blob/5.x/README.md

Imports MongoDB's PHP driver GPG key to verify release tag signatures. Download the key from https://pgp.mongodb.com/php-driver.asc before running.

```shell
gpg --import php-driver.asc
```

--------------------------------

### toMql() method signature

Source: https://github.com/mongodb/laravel-mongodb/blob/5.x/_autodocs/api-reference/query-builder.md

Returns the MongoDB command as an array. Possible command keys include find, distinct, countDocuments, or aggregate.

```php
public function toMql(): array
```

--------------------------------

### Query MongoDB collection with table()

Source: https://github.com/mongodb/laravel-mongodb/blob/5.x/_autodocs/api-reference/connection.md

Example of using table() to query a MongoDB collection. Returns a collection of documents matching the where condition.

```php
$users = DB::connection('mongodb')->table('users')->where('age', '>', 21)->get();
```

--------------------------------

### threadCount()

Source: https://github.com/mongodb/laravel-mongodb/blob/5.x/_autodocs/api-reference/connection.md

Runs the `serverStatus` command and returns `connections.current` as reported by the server.

```APIDOC
## threadCount()

### Description
Runs the `serverStatus` command and returns `connections.current` as reported by the server.

### Method
N/A (PHP method)

### Endpoint
N/A

### Parameters
None

### Request Example
N/A

### Response
#### Success Response
- **return** (int) - The current number of connections to the server.

#### Response Example
```php
42
```
```

--------------------------------

### addRawStage method signature

Source: https://github.com/mongodb/laravel-mongodb/blob/5.x/_autodocs/api-reference/aggregation-builder.md

Method signature for addRawStage. Appends a raw stage to the pipeline; the operator must start with '$' or an InvalidArgumentException is thrown.

```php
public function addRawStage(string $operator, mixed $value): static
```

--------------------------------

### index() method signature

Source: https://github.com/mongodb/laravel-mongodb/blob/5.x/_autodocs/api-reference/schema.md

Method signature for creating an index. The $algorithm parameter is unused. $options can include extra createIndex() options like ['unique' => true].

```php
public function index($columns = null, $name = null, $algorithm = null, $options = [])
```

--------------------------------

### Check if a class is a document model

Source: https://github.com/mongodb/laravel-mongodb/blob/5.x/_autodocs/api-reference/eloquent-model.md

Example call to isDocumentModel with a User model class, returning true. Demonstrates the static usage of the method.

```php
Model::isDocumentModel(User::class); // true

```

--------------------------------

### Locate skill SKILL.md

Source: https://github.com/mongodb/laravel-mongodb/blob/5.x/tools/review-skill/SKILL.md

Verifies the provided skill path contains a SKILL.md file. If not, tell the user the path is not a valid skill directory and ask for the correct path.

```bash
ls <path>/SKILL.md
```

--------------------------------

### Attach, sync, and detach roles

Source: https://github.com/mongodb/laravel-mongodb/blob/5.x/_autodocs/api-reference/relations.md

Example usage of BelongsToMany: attach adds to both arrays, sync replaces the related set, and detach removes a role.

```php
$user->roles()->attach($role);              // adds to both arrays
$user->roles()->sync([$role1, $role2]);
$user->roles()->detach($role1);
```

--------------------------------

### Base class import

Source: https://github.com/mongodb/laravel-mongodb/blob/5.x/resources/boost/skills/laravel-mongodb/references/eloquent-models.md

Use MongoDB\Laravel\Eloquent\Model instead of the standard Eloquent Model to enable MongoDB support.

```php
// WRONG — standard Eloquent does not understand MongoDB types
use Illuminate\Database\Eloquent\Model;

// CORRECT
use MongoDB\Laravel\Eloquent\Model;
```

--------------------------------

### MongoDBBusServiceProvider provides method

Source: https://github.com/mongodb/laravel-mongodb/blob/5.x/_autodocs/api-reference/bus.md

Provides method of MongoDBBusServiceProvider. Returns [BatchRepository::class, MongoBatchRepository::class].

```php
public function provides()
```

--------------------------------

### getFresh method signature

Source: https://github.com/mongodb/laravel-mongodb/blob/5.x/_autodocs/api-reference/query-builder.md

Signature of the getFresh method. It is the implementation of get() and executes the command returned by toMql() against the MongoDB\Collection. When $returnLazy is true, it returns a LazyCollection.

```php
public function getFresh($columns = [], $returnLazy = false)
```

--------------------------------

### Scout search queries

Source: https://github.com/mongodb/laravel-mongodb/blob/5.x/resources/boost/skills/laravel-mongodb/references/search-engine.md

Perform basic Scout searches: get all results or paginate them. The search method uses the configured Atlas Search index.

```php
$results = Product::search('wireless headphones')->get();
$page    = Product::search('headphones')->paginate(15);
```

--------------------------------

### enableQueryLog()

Source: https://github.com/mongodb/laravel-mongodb/blob/5.x/_autodocs/api-reference/connection.md

Enables the query log.

```APIDOC
## `enableQueryLog()`

### Description
Enables the query log and installs a MongoDB\Laravel\CommandSubscriber on the client so MongoDB commands are recorded via logQuery().

### Method
enableQueryLog
```

--------------------------------

### Get MongoDB connection via DB facade

Source: https://github.com/mongodb/laravel-mongodb/blob/5.x/_autodocs/api-reference/connection.md

Retrieves the MongoDB connection instance using the Laravel DB facade. The connection is configured with 'driver' => 'mongodb'.

```php
use Illuminate\Support\Facades\DB;

$connection = DB::connection('mongodb'); // MongoDB\Laravel\Connection
```

--------------------------------

### getTables and getViews method signatures

Source: https://github.com/mongodb/laravel-mongodb/blob/5.x/_autodocs/api-reference/schema.md

Signatures for getTables() and getViews(), which return rows with keys name, schema, schema_qualified_name, size (via $collStats, null for views), comment, collation (string like l=en;s=1), and engine.

```php
public function getTables($schema = null)
public function getViews($schema = null)
```

--------------------------------

### transformModelValue method signature

Source: https://github.com/mongodb/laravel-mongodb/blob/5.x/_autodocs/api-reference/eloquent-model.md

Signature of the protected transformModelValue method. Adjusts the toStringFormat of Carbon values from date casts and resets date casts to start of day.

```php
protected function transformModelValue($key, $value)

```

--------------------------------

### Movie model definition

Source: https://github.com/mongodb/laravel-mongodb/blob/5.x/resources/boost/skills/laravel-mongodb/references/eloquent-models.md

Example model class extending MongoDB\Laravel\Eloquent\Model with connection, table, keyType, fillable, and casts. Note the comment about not casting native arrays to 'array'.

```php
<?php

namespace App\Models;

use MongoDB\Laravel\Eloquent\Model;

final class Movie extends Model
{
    protected $connection = 'mongodb';
    protected $table      = 'movies';   // $table not $collection
    protected $keyType    = 'string';   // ObjectId surfaced as string (already default)

    protected $fillable = ['title', 'year', 'released_at'];

    protected $casts = [
        'year'        => 'integer',
        'released_at' => 'datetime',
        // Do NOT cast native MongoDB arrays to 'array' — stored natively;
        // 'array' cast triggers deprecation and may serialize as JSON.
    ];
}
```

--------------------------------

### Verify release tag signature with git show

Source: https://github.com/mongodb/laravel-mongodb/blob/5.x/README.md

Verifies the signature of a given release tag (e.g., 4.4.0) in a local clone. Requires the GPG key to be imported first.

```shell
git show --show-signature 4.4.0
```

--------------------------------

### Register MongoDBServiceProvider in bootstrap/providers.php

Source: https://github.com/mongodb/laravel-mongodb/blob/5.x/resources/boost/skills/laravel-mongodb/references/connection.md

Manual registration of the MongoDB service provider in bootstrap/providers.php. Only needed if package discovery is opted out.

```php
return [
    MongoDB\Laravel\MongoDBServiceProvider::class,
];
```

--------------------------------

### Using MongoDB Casts in Model $casts Array

Source: https://github.com/mongodb/laravel-mongodb/blob/5.x/_autodocs/api-reference/casts.md

Example of using the MongoDB cast classes in a Laravel model's $casts array. The cast classes are in the MongoDB\Laravel\Eloquent\Casts namespace.

```php
use MongoDB\Laravel\Eloquent\Casts\ObjectId;

class User extends Model
{
    protected $casts = [
        'id' => ObjectId::class,
        'uuid' => BinaryUuid::class,
        'metadata' => AsBsonDocument::class,
        'items' => AsBsonArray::class,
    ];
}
```

--------------------------------

### MongoBatchRepository constructor

Source: https://github.com/mongodb/laravel-mongodb/blob/5.x/_autodocs/api-reference/bus.md

Constructor for MongoBatchRepository. Requires a BatchFactory, a MongoDB connection, and the collection name for batches.

```php
public function __construct(
    BatchFactory $factory,
    Connection $connection,
    string $collection,
)
```

--------------------------------

### assertKeyIsNotOperator(mixed $value): void method signature

Source: https://github.com/mongodb/laravel-mongodb/blob/5.x/_autodocs/api-reference/query-builder.md

Throws InvalidArgumentException when any nested array key starts with $, rejecting MongoDB operators as document id or relation key values.

```php
public static function assertKeyIsNotOperator(mixed $value): void
```

--------------------------------

### Create sessions collection with indexes and TTL

Source: https://github.com/mongodb/laravel-mongodb/blob/5.x/resources/boost/skills/laravel-mongodb/references/cache-sessions.md

Creates the 'sessions' collection with indexes on 'user_id' and 'last_activity', plus a TTL index on 'expires_at'. Session IDs are stored in '_id', so do not add a unique index on 'id'.

```php
Schema::connection('mongodb')->create('sessions', function (Blueprint $c): void {
    $c->index('user_id');
    $c->index('last_activity');
    $c->expire('expires_at', 0);
});
```

--------------------------------

### createIndex() signature – Scout Engine

Source: https://github.com/mongodb/laravel-mongodb/blob/5.x/_autodocs/api-reference/scout-engine.md

Creates the collection if needed, creates a search index, and optionally polls listSearchIndexes until READY. $options['wait'] defaults to true; timeout 300s throws RuntimeException.

```php
public function createIndex($name, array $options = []): void
```

--------------------------------

### Use Cache facade with MongoDB

Source: https://github.com/mongodb/laravel-mongodb/blob/5.x/resources/boost/skills/laravel-mongodb/references/cache-sessions.md

Example usage of the Laravel Cache facade with MongoDB. Stores a user object for 10 minutes and caches the top 10 movies by rating for 300 seconds using a closure.

```php
use Illuminate\Support\Facades\Cache;

Cache::put('user:1', $user, now()->addMinutes(10));
Cache::remember('movies:top10', 300, fn () => Movie::orderBy('rating', 'desc')->take(10)->get());
```

--------------------------------

### MongoStore::__construct

Source: https://github.com/mongodb/laravel-mongodb/blob/5.x/_autodocs/api-reference/cache.md

Constructor for the MongoStore cache store.

```APIDOC
## MongoStore::__construct

### Description
Creates a new MongoStore instance with the given MongoDB connection, collection name, prefix, and optional lock configuration.

### Method
Constructor

### Signature
```php
public function __construct(
    private readonly Connection $connection,
    private readonly string $collectionName = 'cache',
    private readonly string $prefix = '',
    private readonly ?Connection $lockConnection = null,
    private readonly string $lockCollectionName = 'cache_locks',
    private readonly array $lockLottery = [2, 100],
    private readonly int $defaultLockTimeoutInSeconds = 86400,
    private readonly array|bool|null $serializableClasses = null,
)
```

### Parameters
- **$connection** (MongoDB\Laravel\Connection) - Required - MongoDB connection for cache items
- **$collectionName** (string) - Optional - Cache collection (default: 'cache')
- **$prefix** (string) - Optional - Key prefix (default: '')
- **$lockConnection** (Connection|null) - Optional - Connection for locks (defaults to the cache connection)
- **$lockCollectionName** (string) - Optional - Locks collection (default: 'cache_locks')
- **$lockLottery** (array{int, int}) - Optional - Probability [chance, total] of pruning expired lock documents; [0, 0] disables (default: [2, 100])
- **$defaultLockTimeoutInSeconds** (int) - Optional - Default lock TTL (default: 86400)
- **$serializableClasses** (array|bool|null) - Optional - allowed_classes for unserialize(); null = all classes (default: null)
```

--------------------------------

### prepareFieldsForQuery method signature

Source: https://github.com/mongodb/laravel-mongodb/blob/5.x/_autodocs/api-reference/query-grammar.md

Method signature for preparing fields for queries. It recursively renames 'id' to '_id', converts arrow notation to dot notation, and converts DateTimeInterface values to UTCDateTime.

```php
public function prepareFieldsForQuery(array $values, bool $root = true): array
```

--------------------------------

### map() and lazyMap() signatures – Scout Engine

Source: https://github.com/mongodb/laravel-mongodb/blob/5.x/_autodocs/api-reference/scout-engine.md

Re-queries models by Scout ids, filters to ids present in results, attaches metadata fields starting with _ (except _id), and re-sorts to search result order.

```php
public function map(Builder $builder, $results, $model): Collection
```

```php
public function lazyMap(Builder $builder, $results, $model): LazyCollection
```

--------------------------------

### whereBetween($column, iterable $values, $boolean = 'and', $not = false) method signature

Source: https://github.com/mongodb/laravel-mongodb/blob/5.x/_autodocs/api-reference/query-builder.md

Adds a where between clause. Throws InvalidArgumentException unless $values is a list of exactly two elements [min, max]. CarbonPeriod values are converted to [start, end].

```php
public function whereBetween($column, iterable $values, $boolean = 'and', $not = false)
```

--------------------------------

### project($columns)

Source: https://github.com/mongodb/laravel-mongodb/blob/5.x/_autodocs/api-reference/query-builder.md

Sets the projection fields for the query.

```APIDOC
## project($columns)

### Description
Sets the projection fields for the query. Accepts an array or variadic columns.

### Method
project

### Parameters
- **$columns** (array|string) - Required - The columns to project.
```

--------------------------------

### divide() method signature

Source: https://github.com/mongodb/laravel-mongodb/blob/5.x/_autodocs/api-reference/query-builder.md

Signature for dividing a column. Delegates to multiply($column, 1 / $amount, ...).

```php
public function divide($column, $amount, array $extra = [], array $options = [])
```
Tokens:
Raw