DOCSP-41306: schema version trait

docs/eloquent-models/model-class.txt

@@ -33,6 +33,8 @@ to {+odm-short+} models:
 - :ref:`laravel-model-customize` explains several model class customizations.
 - :ref:`laravel-model-pruning` shows how to periodically remove models that
   you no longer need.
+- :ref:`laravel-schema-versioning` shows how to implement model schema
+  versioning.
 
 .. _laravel-model-define:
 
@@ -67,7 +69,6 @@ This model is stored in the ``planets`` MongoDB collection.
 To learn how to specify the database name that your Laravel application uses,
 :ref:`laravel-quick-start-connect-to-mongodb`.
 
-
 .. _laravel-authenticatable-model:
 
 Extend the Authenticatable Model
@@ -333,3 +334,94 @@ models that the prune action deletes:
    :emphasize-lines: 5,10,12
    :dedent:
 
+.. _laravel-schema-versioning:
+
+Create a Versioned Model Schema
+-------------------------------
+
+You can implement a schema versioning pattern into your application by
+using the ``HasSchemaVersion`` trait on an Eloquent model. You might
+choose to implement a schema version to organize or standardize a
+collection that contains data with different schemas.
+
+.. tip::
+
+   To learn more about schema versioning, see the :manual:`Model Data for
+   Schema Versioning </tutorial/model-data-for-schema-versioning/>`
+   tutorial in the {+server-docs-name+}.
+
+To use this feature with models that use MongoDB as a database, add the
+``MongoDB\Laravel\Eloquent\HasSchemaVersion`` import to your model.
+Then, set the ``SCHEMA_VERSION`` constant to ``1`` to set the first
+schema version on your collection. If your collection evolves to contain
+multiple schemas, you can update the value of the ``SCHEMA_VERSION``
+constant in subsequent model classes.
+
+When creating your model, you can define the ``migrateSchema()`` method
+to specify a migration to the current schema version upon saving a
+model. In this method, you can specify the changes to make to an older
+model to update it to match the current schema version.
+
+Schema Versioning Example
+~~~~~~~~~~~~~~~~~~~~~~~~~
+
+In this sample situation, you are working with a collection that was
+first modeled by the following class:
+
+.. literalinclude:: /includes/eloquent-models/PlanetSchemaVersion1.php
+   :language: php
+   :dedent:
+
+Now, you want to implement a new schema version on the collection.
+You can define the new model class with the following behavior:
+
+- Implements the ``HasSchemaVersion`` trait and sets the current
+  ``SCHEMA_VERSION`` to ``2``
+
+- Defines the ``migrateSchema()`` method to migrate models in which the
+  schema version is less than ``2`` to have a ``galaxy`` field that has a value
+  of ``'Milky Way'``
+
+.. literalinclude:: /includes/eloquent-models/PlanetSchemaVersion2.php
+   :language: php
+   :emphasize-lines: 10,12,20
+   :dedent:
+
+When you save or retrieve a model that does not have a schema version
+specified, Laravel assumes that it follows the latest schema version.
+
+When you save or retrieve a model in which the ``schema_version`` field
+value is less than ``2``, Laravel adds the ``galaxy``
+field and updates the schema version to the current version (``2``).
+
+The following code inserts two instances of the ``Planet`` model, then
+retrieves the models from the collection to demonstrate the changes:
+
+.. io-code-block::
+   :copyable: true
+
+   .. input:: /includes/eloquent-models/SchemaVersionTest.php
+      :language: php
+      :dedent:
+      :start-after: begin-schema-version
+      :end-before: end-schema-version
+
+   .. output::
+      :language: none
+      :visible: false
+
+      [
+        {
+          "_id": ...,
+          "name": "WASP-39 b",
+          "type": "gas",
+          "galaxy": "Milky Way",
+          "schema_version": 2,
+        },
+        {
+          "_id": ...,
+          "name": "Saturn",
+          "type": "gas",
+          "schema_version": 2,
+        }
+      ]

docs/includes/eloquent-models/PlanetSchemaVersion1.php

@@ -0,0 +1,10 @@
+<?php
+
+namespace App\Models;
+
+use MongoDB\Laravel\Eloquent\Model;
+
+class Planet extends Model
+{
+    protected $fillable = ['name', 'type'];
+}

docs/includes/eloquent-models/PlanetSchemaVersion2.php

@@ -0,0 +1,26 @@
+<?php
+
+namespace App\Models;
+
+use MongoDB\Laravel\Eloquent\HasSchemaVersion;
+use MongoDB\Laravel\Eloquent\Model;
+
+class Planet extends Model
+{
+    use HasSchemaVersion;
+
+    public const SCHEMA_VERSION = 2;
+
+    protected $fillable = ['name', 'type', 'galaxy'];
+
+    /**
+     * Migrate documents with a lower schema version to the most current
+     * schema when inserting new data or retrieving from the database.
+     */
+    public function migrateSchema(int $fromVersion): void
+    {
+        if ($fromVersion < 2) {
+            $this->galaxy = 'Milky Way';
+        }
+    }
+}

docs/includes/eloquent-models/SchemaVersionTest.php

@@ -0,0 +1,54 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Tests;
+
+use App\Models\Planet;
+use MongoDB\Laravel\Tests\TestCase;
+
+class SchemaVersionTest extends TestCase
+{
+    /**
+     * @runInSeparateProcess
+     * @preserveGlobalState disabled
+     */
+    public function testSchemaVersion(): void
+    {
+        require_once __DIR__ . '/PlanetSchemaVersion2.php';
+
+        Planet::truncate();
+
+        // begin-schema-version
+        // Simulates a document in the collection with schema version 1
+        Planet::insert([
+            [
+                'name' => 'WASP-39 b',
+                'type' => 'gas',
+                'schema_version' => 1,
+            ],
+        ]);
+
+        // Saves a document with no specified schema version
+        $saturn = Planet::create([
+            'name' => 'Saturn',
+            'type' => 'gas',
+        ]);
+
+        // Retrieves both models from the collection
+        $planets = Planet::where('type', 'gas')
+            ->get();
+        // end-schema-version
+
+        $this->assertCount(2, $planets);
+
+        $p1 = Planet::where('name', 'Saturn')->first();
+
+        $this->assertEquals(2, $p1->schema_version);
+
+        $p2 = Planet::where('name', 'WASP-39 b')->first();
+
+        $this->assertEquals(2, $p2->schema_version);
+        $this->assertEquals('Milky Way', $p2->galaxy);
+    }
+}