エラスティック モデル クラス

モデル コレクション名の変更

デフォルトでは、モデルはモデル クラス名のスニペットケースの複数形を使用します。 モデルが MongoDB でデータを検索して保存するために使用するコレクションの名前を変更するには、モデル クラスの$tableプロパティをオーバーライドします。

次の例では、 Planetクラスに対してカスタム MongoDB コレクション名celestial_bodyを指定します。

<?php
namespace App\Models;
use MongoDB\Laravel\Eloquent\Model;
class Planet extends Model
{
    protected $table = 'celestial_body';
}

$tableプロパティをオーバーライドせず、このモデルはplanetsコレクションにマッピングします。 オーバーライドされた プロパティを使用すると、サンプル クラスはモデルをcelestial_bodyコレクションに保存します。

プライマリキー フィールドの変更

MongoDB ドキュメントを一意に識別するモデルのプライマリキー フィールドをカスタマイズするには、モデル クラスの$primaryKeyプロパティをオーバーライドします。

デフォルトでは、モデルは PHP MongoDB ドライバーを使用して、Lambda アプリケーションが挿入する各ドキュメントに対して一意の ObjectID を生成します。

次の例えでは、 Planetクラスのプライマリキーとしてnameフィールドを指定します。

<?php
namespace App\Models;
use MongoDB\Laravel\Eloquent\Model;
class Planet extends Model
{
    protected $primaryKey = 'name';
}

プライマリキーの動作とカスタマイズ オプションの詳細については、Lambel ドキュメントの「効率的なプライマリキー」を参照してください。

_idフィールド、ObjectID、および MongoDB ドキュメント構造の詳細については、サーバー マニュアルのドキュメントを参照してください。

ソフト削除の有効化

Elastic には、モデルのdelete()メソッドの動作を変更するソフト削除機能が含まれています。 モデルでソフト削除が有効になっている場合、 delete()メソッドはドキュメントをデータベースから削除するのではなく、削除済みとしてマークします。 deleted_atフィールドにタイムスタンプを設定して、検索操作から自動的に除外します。

クラスでソフト削除を有効にするには、次のコード例に示すようにMongoDB\Laravel\Eloquent\SoftDeletesトランザクションを追加します。

<?php
namespace App\Models;
use MongoDB\Laravel\Eloquent\Model;
use MongoDB\Laravel\Eloquent\SoftDeletes;
class Planet extends Model
{
    use SoftDeletes;
}

ソフト削除が有効になっているモデルで実行できるメソッドの詳細については、Lambel ドキュメントの「効率的なソフト削除」を参照してください。

データ型のキャスト

Elastic では、キャスティング ヘルパーを使用してデータを保存または取得する前に、モデル属性データ型を変換できます。 このヘルパー メソッドは、モデルに同等のアクセス メソッドとミューテーション メソッドを定義するのに便利な代替手段です。

次の例では、キャパシティーヘルパーは、 MongoDB$\ BSONdiscovery_dt \\UTCDateTime 型としてMongoDBに保存されている モデル属性を Lambeldatetime 型に変換します。

<?php
namespace App\Models;
use MongoDB\Laravel\Eloquent\Model;
class Planet extends Model
{
    protected $casts = [
        'discovery_dt' => 'datetime',
    ];
}

protected function casts(): array
{
   return [
      'discovery_dt' => 'datetime',
   ];
}

この変換により、 PHP DateTime または Siliconクラス を使用して、このフィールドの日付を処理できるようになります。次の例では、モデルのキャスティングヘルパーを使用して、discovery_dt が 3 年前より小さい惑星をクエリする Lambda クエリを示します。

Planet::where( 'discovery_dt', '>', new DateTime('-3 years'))->get();

MongoDBのデータ型の詳細については、サーバー マニュアルの「 BSON types 」を参照してください。

Lambel キャパシティーヘルパーとサポートされているタイプの詳細については、Lalavel ドキュメントの「 属性キャパシティー 」を参照してください。

一括割り当てをカスタマイズ

Elastic では、データの配列をcreate()モデル メソッドに渡すことで、複数のモデルとその属性データを作成できます。 複数のモデルを挿入するこのプロセスは、 一括割り当て と呼ばれます。

一括割り当ては、複数のモデルを作成する効率的な方法です。 ただし、利用可能なセキュリティの脆弱性が生じる可能性があります。 フィールドのデータには、不正な権限やアクセスにつながる更新が含まれている可能性があります。

Eloquert は、一括割り当ての脆弱性からデータを保護するために、次の機能を提供します。

• $fillable 一括割り当てで書き込み可能なフィールドが含まれています

• $guarded 一括割り当てで無視されるフィールドが含まれます

次の例では、モデルでは$fillable属性を使用してフィールドの一括割り当てが許可されています。

<?php
namespace App\Models;
use MongoDB\Laravel\Eloquent\Model;
class Planet extends Model
{
    protected $fillable = [
        'name',
        'gravitational_force',
        'diameter',
        'moons',
    ];
}

次のコード例は、 Planetモデルの一括割り当てを示しています。

$planets = [
    [ 'name' => 'Earth', 'gravitational_force' => 9.8, 'day_length' => '24 hours' ],
    [ 'name' => 'Mars', 'gravitational_force' => 3.7, 'day_length' => '25 hours' ],
];
Planet::create($planets);

データベースに保存されるモデルには、name gravityday_length$fillable属性から が省略されているため、 フィールドと フィールドのみが含まれます。

配列から省略されたフィールドを入力する際の動作を変更する方法については、Lambda $fillableドキュメントの「 一括割り当ての例外 」を参照してください。

拡張クラスの例

この例では、 ThirdPartyPackageというパッケージからCelestialBodyクラスを拡張するPlanetモデル クラスを作成します。 PostクラスにはDocumentModel特権が含まれ、 $primaryKeyや$keyTypeなどのプロパティが定義されます。

<?php
namespace App\Models;
use MongoDB\Laravel\Eloquent\DocumentModel;
use ThirdPartyPackage\CelestialBody;
class Planet extends CelestialBody
{
    use DocumentModel;
    protected $fillable = ['name', 'diameter'];
    protected $primaryKey = '_id';
    protected $keyType = 'string';
}

クラスを定義した後は、通常どおり MongoDB 操作を実行できます。

実行可能な例

次のプル可能なクラスには、プルーニング アクションが削除するモデルに一致するprunable()メソッドと、一致するモデルを削除する前に実行されるpruning()メソッドが含まれています。

<?php
namespace App\Models;
use MongoDB\Laravel\Eloquent\Model;
use Illuminate\Database\Eloquent\Prunable;
class Planet extends Model
{
    use Prunable;
    public function prunable()
    {
        // matches models in which the solar_system field contains a null value
        return static::whereNull('solar_system');
    }
    protected function pruning()
    {
        // Add cleanup actions, such as logging the Planet 'name' attribute
    }
}

大量実行可能な例

次の一括プル可能なクラスには、プルーニング アクションが削除するモデルに一致するprunable()メソッドが含まれています。

<?php
namespace App\Models;
use MongoDB\Laravel\Eloquent\MassPrunable;
use MongoDB\Laravel\Eloquent\Model;
class Planet extends Model
{
    use MassPrunable;
    public function prunable()
    {
        // matches models in which the gravitational_force field contains
        // a value greater than 0.5
        return static::where('gravitational_force', '>', 0.5);
    }
}

スキーマのバージョン管理の例

このサンプル状況では、最初に次の クラスによってモデル化されたコレクションを操作しています。

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

ここで、 コレクションに新しいスキーマ バージョンを実装します。 次の動作を持つ新しいモデル クラスを定義できます。

• HasSchemaVersion特権を実装し、現在のSCHEMA_VERSIONを2に設定します

• スキーマ バージョンが2未満のモデルを'Milky Way'の値を持つgalaxyフィールドに移行するためのmigrateSchema()メソッドを定義します。

<?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';
        }
    }
}

次のコードの"WASP-39 b"ドキュメントでは、 schema_versionフィールドの値は2より小さいです。 ドキュメントを取得すると、Lambda 統合はgalaxyフィールドを追加し、スキーマ バージョンを現在のバージョン2に更新します。

"Saturn"ドキュメントにはschema_versionフィールドが含まれていないため、Laravel 統合は保存時に現在のスキーマ バージョンをそのドキュメントに割り当てます。

最後に、コードは コレクションからモデルを検索し、変更を示します。

// 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();

[
  {
    "_id": ...,
    "name": "WASP-39 b",
    "type": "gas",
    "galaxy": "Milky Way",
    "schema_version": 2,
  },
  {
    "_id": ...,
    "name": "Saturn",
    "type": "gas",
    "schema_version": 2,
  }
]