Schema validation migration like

[jleonardolemos]

MongoDB has built in schema validations.
Today is possible to use these schema validations at the Driver level but would be nice if the Laravel Mongodb package has some "Migration Like" approach to deal with this.

@alcaeus Is it something the the maintainers would like to have?? Are you open to a PR at this subject?

[GromNaN]

The schema validation in MongoDB is optional. I understand that you'd like to use the same schema methods as for a SQL database to define fields and impose their name and type.

Currently this is effectively ignored.

What you want:

Schema::create('users', function (Blueprint $table) {
    $table->id();
    $table->string('name')->comment('Name is required and must be a string');
    $table->string('email')->regex('^.+@.+\..+$')->unique();
    $table->timestamp('email_verified_at')->nullable();
    $table->string('password');
    $table->rememberToken();
    $table->timestamps();
});

To create the collection like this:

$jsonSchema = [
    'bsonType' => 'object',
    'required' => ['_id', 'name', 'email', 'password'],
    'properties' => [
        '_id' => [
            'bsonType' => 'objecId',
        ],
        'name' => [
            'bsonType' => 'string',
            'description' => 'Name is required and must be a string',
        ],
        'email' => [
            'bsonType' => 'string',
            'pattern' => '^.+@.+\..+$',
        ],
        'email_verified_at' => [
            'bsonType' => ['date', 'null'],
        ],
        'password' => [
            'bsonType' => 'string',
        ],
        'remember_token' => [
            'bsonType' => ['string', 'null'],
        ],
        'created_at' => [
            'bsonType' => 'date',
        ],
        'updated_at' => [
            'bsonType' => 'date',
        ],
    ],
];

// Create collection with validation
$database->createCollection('users', ['validator' => ['$jsonSchema' => $jsonSchema]]);

[GromNaN]

We have an open ticket for this feature request: PHPORM-72

[jleonardolemos]

OK. I will use the createCollection approach for now. Thanks by the response.

[dercoder]

I was working on some proof of concept here: dercoder#1

1. Nested Object Validation
   You can define validation for nested fields using dot-notation. Intermediate objects are automatically created if not explicitly defined.

Schema::create('users', function (Blueprint $collection) {
    $collection->string('name');
    $collection->object('address'); // Optional: explicitly define the object
    $collection->string('address.street');
    $collection->string('address.city')->nullable();
    $collection->string('address.zip', 10);
    $collection->array('phoneNumbers', 'string');
});

Result: MongoDB will enforce that address is an object, address.street is a required string, and address.zip has a maximum length of 10.

2. Validating Array Items (Wildcards)
   Using the * wildcard, you can define the schema for items within an array.

Schema::create('posts', function (Blueprint $collection) {
    $collection->string('title');
    $collection->array('tags', 'object'); // Define 'tags' as an array of objects
    $collection->string('tags.*.name');
    $collection->string('tags.*.slug')->nullable();
});

Result: Every object inside the tags array must have a name string. If an item does not match this schema, MongoDB will reject the write.

3. Deeply Nested Structures
   The builder supports deep nesting by combining dot-notation and wildcards.

Schema::create('orders', function (Blueprint $collection) {
    $collection->array('items', 'object');
    $collection->string('items.*.product.name');
    $collection->integer('items.*.product.id');
    $collection->decimal('items.*.price');
});

4. Drop Columns

Schema::table('users', function (Blueprint $collection) {
    // 1. Removes 'phoneNumbers' from documents and from the required properties in the schema
    $collection->dropColumn('phoneNumbers');

    // 2. Removes 'zip' from the nested 'address' object in both schema and data
    $collection->dropColumn('address.zip');

    // 3. Removes 'metadata' from all items within the 'items' array
    $collection->dropColumn('items.*.metadata');
});