Struct SchemaBuilder 

pub struct SchemaBuilder { /* private fields */ }

A schema builder that can take a registry of Entities and synchronize it with database.

Implementations

impl SchemaBuilder

pub fn new(schema: Schema) -> Self

Creates a new schema builder

pub fn register<E: EntityTrait>(self, entity: E) -> Self

Register an entity to this schema

pub fn sync<C>(self, db: &C) -> Result<(), DbErr>

where C: ConnectionTrait + Connection,

Available on crate feature schema-sync only.

Synchronize the schema with database, will create missing tables, columns, unique keys, and foreign keys. This operation is addition only, will not drop any table / columns.

pub fn apply<C: ConnectionTrait>(self, db: &C) -> Result<(), DbErr>

Apply this schema to a database, will create all registered tables, columns, unique keys, and foreign keys. Will fail if any table already exists. Use [sync] if you want an incremental version that can perform schema diff.

Trait Implementations

impl Debug for SchemaBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.