Revision: Fri, 31 May 2024 16:10:39 GMT
v1.0 – outdated
This version of the documentation is outdated. Consider upgrading your project to Spiral Framework 3.12
Edit this page


You can scaffold ODM class Document and pre-define it's fields using spiral create:document command.

Note, there is no DocumentEntity command, simple change parent class.

spiral create:document user -f _id:MongoId -f name:string

class User extends Document
    const SCHEMA = [
        '_id'  => MongoId::class,
        'name' => 'string'

Use command option -s to automatically generate repository class.

As in case with ORM you have to update your schema to register class: spiral odm:schema.

Run spiral odm:schema -i to automatically add all requested mongo indexes. Run spiral ide-helper to generate IDE tooltips.