vendure-entity-writing

Creating a custom database entity in Vendure involves generating a TypeScript class that extends VendureEntity, applying TypeORM decorators like @Entity() and @Column(), and implementing a constructor using DeepPartial for type-safe initialization.

VendureEntity is the base class used to ensure custom database models comply with Vendure framework conventions, providing necessary channel-awareness and structural consistency for TypeORM schema generation.

Yes, Vendure requires migration files for new TypeORM entities to properly apply schema changes to the database, ensuring that custom database tables like a ProductReview model are tracked and updated systematically.

To add relations to a Vendure database entity, you use TypeORM relation decorators within your TypeScript class, ensuring the custom model correctly maps foreign keys and associations while extending VendureEntity.

The best way to ensure channel-awareness in a Vendure custom entity is to extend the VendureEntity base class, which inherently manages multi-channel data isolation and framework compliance during TypeORM schema definition.

Custom Vendure entities fail to save when they do not extend VendureEntity or lack proper TypeORM decorators, which breaks framework conventions and prevents the ORM from mapping the TypeScript class to the database schema.