Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

DOCSP-50472: schema validation #3400

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
rustagir merged 9 commits into mongodb:5.x from rustagir:DOCSP-50472-jsonSchema-method
Jun 6, 2025
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
DOCSP-50472: schema validation
  • Loading branch information
rustagir committed Jun 5, 2025
commit 1c45cb2a275de280068ee9e03f048c5cf7c2dba9
76 changes: 64 additions & 12 deletions docs/eloquent-models/schema-builder.txt
View file Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,9 @@ Overview
--------

Laravel provides a **facade** to access the schema builder class ``Schema``,
which lets you create and modify tables. Facades are static interfaces to
classes that make the syntax more concise and improve testability.
which lets you create and modify tables, or collections in MongoDB.
Facades are static interfaces to classes that make the syntax more
concise and improve testability.

The {+odm-short+} supports a subset of the index and collection management methods
in the Laravel ``Schema`` facade.
Expand All @@ -33,16 +34,10 @@ in the Laravel documentation.
The following sections describe the Laravel schema builder features available
in the {+odm-short+} and show examples of how to use them:

- :ref:`<laravel-eloquent-migrations>`
- :ref:`<laravel-eloquent-collection-exists>`
- :ref:`<laravel-eloquent-indexes>`

.. note::

The {+odm-short+} supports managing indexes and collections, but
excludes support for MongoDB JSON schemas for data validation. To learn
more about JSON schema validation, see :manual:`Schema Validation </core/schema-validation/>`
in the {+server-docs-name+}.
- :ref:`laravel-eloquent-migrations`
- :ref:`laravel-eloquent-schema-validation`
- :ref:`laravel-eloquent-collection-exists`
- :ref:`laravel-eloquent-indexes`

.. _laravel-eloquent-migrations:

Expand Down Expand Up @@ -117,6 +112,63 @@ To learn more about Laravel migrations, see
`Database: Migrations <https://laravel.com/docs/{+laravel-docs-version+}/migrations>`__
in the Laravel documentation.

.. _laravel-eloquent-schema-validation:

Implement Schema Validation
---------------------------

You can use the ``jsonSchema()`` method to implement **:manual:`schema
validation </core/schema-validation/>`** when using the following schema
builder methods:

- ``Schema::create()``: When creating a new collection.
- ``Schema::table()``: When updating collection properties.

After you implement schema validation, the server allows you to run only
those write operations which follow the validation rules. Use schema
Copy link
Contributor

@mongoKart mongoKart Jun 5, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

that/which

Suggested change
those write operations which follow the validation rules. Use schema
those write operations that follow the validation rules. Use schema

rustagir reacted with thumbs up emoji
validation to restrict data types and value ranges of document fields in
a specified collection.
Copy link
Contributor

@mongoKart mongoKart Jun 5, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

S: i wonder if the connection between these two sentences would be clearer if you switched them. something like:

Suggested change
After you implement schema validation, the server allows you to run only
those write operations which follow the validation rules. Use schema
validation to restrict data types and value ranges of document fields in
a specified collection.
You can use schema validation to restrict data types and value ranges of document fields in
a specified collection. After you implement schema validation, the server allows you to run only
those write operations which follow the validation rules.

rustagir reacted with thumbs up emoji
Copy link
Contributor Author

@rustagir rustagir Jun 6, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

makes sense


Before creating a collection with schema validation rules, you must
define a JSON schema.

The schema is a JSON object that contains key-value pairs
specifying the validation rules for your collection. At the top level,
this object must include a ``$jsonSchema`` object. The ``$jsonSchema``
Copy link
Collaborator

@paulinevos paulinevos Jun 6, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

$jsonSchema doesn't need to be included in the schema argument (see the example). Since the method is Blueprint::jsonSchema, the '$jsonSchema' operation is already implied.

So this documentation may be valid for MongoDB server but not for Laravel usage

Copy link
Collaborator

@paulinevos paulinevos Jun 6, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh also! Since this is PHP, the schema argument is not an object, but an associative array.

rustagir reacted with thumbs up emoji
object includes the following fields:

- ``title``: Sets an optional description for the schema.
- ``required``: Specifies a list of required fields for each document in your collection.
- ``properties``: Sets property requirements for individual fields.

For a full list of JSON schema object fields, see :manual:`JSON Schema
</reference/operator/query/jsonSchema/#json-schema>` in the {+server-docs-name+}.

You can optionally pass the following parameters to ``jsonSchema()``:

- ``validationLevel``: Sets the level of validation enforcement.
Accepted values are ``"strict"`` and ``"moderate"``.
- ``validationAction``: Specifies the action to take when invalid
operations are attempted. Accepted values are ``"error"`` and
``"warn"``.

This example demonstrates how to pass a JSON schema to the
``jsonSchema()`` method when creating a collection. The schema
validation specifies that documents in the ``pilots`` collection must
contain the ``license_number`` field with an integer value between
Copy link
Contributor

@mongoKart mongoKart Jun 5, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

S:

Suggested change
contain the ``license_number`` field with an integer value between
contain the ``license_number`` field, and the field must have an integer value between

rustagir reacted with thumbs up emoji
Copy link
Contributor Author

@rustagir rustagir Jun 6, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

changed to a list

``1000`` and ``9999``.

.. literalinclude:: /includes/schema-builder/flights_migration.php
:language: php
:dedent:
:start-after: begin-json-schema
:end-before: end-json-schema

If you attempt to insert a document into the ``pilots`` collection that
violates the schema validation rule, {+odm-long+} returns a
:php:`mongodb-driver-exception-bulkwriteexception` because the
validation level is set to ``"error"``.

.. _laravel-eloquent-collection-exists:

Check Whether a Collection Exists
Expand Down
20 changes: 20 additions & 0 deletions docs/includes/schema-builder/flights_migration.php
View file Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,26 @@ public function up(): void
$collection->unique('mission_id', options: ['name' => 'unique_mission_id_idx']);
});
// end create index

// begin-json-schema
Schema::create('pilots', function (Blueprint $collection) {
$collection->jsonSchema(
schema: [
'bsonType' => 'object',
'required' => ['license_number'],
'properties' => [
'license_number' => [
'bsonType' => 'integer',
'minimum' => 1000,
'maximum' => 9999,
'description' => 'requires the license_number field with an int value 1000-9999',
]
]
],
validationAction: 'error'
);
});
// end-json-schema
}

public function down(): void
Expand Down
Loading

AltStyle によって変換されたページ (->オリジナル) /