Struct Schema 

pub struct Schema { /* private fields */ }

This is a helper struct to convert EntityTrait into different sea_query statements.

Implementations

impl Schema

pub fn create_enum_from_active_enum<A>(&self) -> Option<TypeCreateStatement>

where A: ActiveEnum,

Creates Postgres enums from an ActiveEnum. See TypeCreateStatement for more details. Returns None if not Postgres.

pub fn create_enum_from_entity<E>(&self, entity: E) -> Vec<TypeCreateStatement>

where E: EntityTrait,

Creates Postgres enums from an Entity. See TypeCreateStatement for more details. Returns empty vec if not Postgres.

pub fn create_table_from_entity<E>(&self, entity: E) -> TableCreateStatement

where E: EntityTrait,

Creates a table from an Entity. See TableCreateStatement for more details.

pub fn create_index_from_entity<E>( &self, entity: E, ) -> Vec<IndexCreateStatement>

where E: EntityTrait,

Creates the indexes from an Entity, returning an empty Vec if there are none to create. See IndexCreateStatement for more details

pub fn get_column_def<E>(&self, column: E::Column) -> ColumnDef

where E: EntityTrait,

Creates a column definition for example to update a table.

use sea_orm::sea_query::TableAlterStatement;
use sea_orm::{DbBackend, Schema, Statement};

mod post {
    use sea_orm::entity::prelude::*;

    #[sea_orm::model]
    #[derive(Clone, Debug, PartialEq, DeriveEntityModel)]
    #[sea_orm(table_name = "posts")]
    pub struct Model {
        #[sea_orm(primary_key)]
        pub id: u32,
        pub title: String,
    }

    impl ActiveModelBehavior for ActiveModel {}
}

let schema = Schema::new(DbBackend::MySql);

let alter_table: Statement = DbBackend::MySql.build(
    TableAlterStatement::new()
        .table(post::Entity)
        .add_column(&mut schema.get_column_def::<post::Entity>(post::Column::Title)),
);
assert_eq!(
    alter_table.to_string(),
    "ALTER TABLE `posts` ADD COLUMN `title` varchar(255) NOT NULL"
);

impl Schema

pub fn json_schema_from_entity<E>(&self, entity: E) -> Value

where E: EntityTrait,

Available on crate feature serde_json only.

Construct a schema description in json for the given Entity.

impl Schema

pub fn new(backend: DbBackend) -> Self

Create a helper for a specific database backend

pub fn builder(self) -> SchemaBuilder

Creates a schema builder that can apply schema changes to database

Trait Implementations

impl Debug for Schema

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

Formats the value using the given formatter.