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 async fn sync<C>(self, db: &C) -> Result<(), DbErr>

where C: ConnectionTrait + Connection,

Available on crate feature schema-sync only.

Synchronize the schema with the database: creates any missing tables, columns, unique keys, and foreign keys.

Non-destructive by design. Sync only adds — it never drops or alters existing tables or columns. If a column already exists but its type or constraints differ from the entity, sync leaves it untouched and logs a warning; apply such changes with a migration. Destructive operations (ALTER / DROP) are intentionally out of scope and would be a separate, explicitly-named API.

Unstable: schema sync is experimental and exempt from semver — its behaviour and signature may change in a minor (2.x) release.

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

Create all registered tables, columns, unique keys, and foreign keys. Fails if any table already exists. Use sync (feature schema-sync) instead for an incremental version that diffs against the live schema.

Trait Implementations

impl Debug for SchemaBuilder

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

Formats the value using the given formatter.