pub struct Schema { /* private fields */ }
Expand description

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

Implementations§

source§

impl Schema

source

pub fn create_enum_from_active_enum<A>(&self) -> TypeCreateStatementwhere A: ActiveEnum,

Creates Postgres enums from an ActiveEnum. See TypeCreateStatement for more details

source

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

Creates Postgres enums from an Entity. See TypeCreateStatement for more details

source

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

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

source

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

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

source

pub fn get_column_def<E>(&self, column: <E as EntityTrait>::Column) -> ColumnDefwhere E: EntityTrait,

Creates a column definition for example to update a table.

use crate::sea_orm::IdenStatic;
use sea_orm::{
    ActiveModelBehavior, ColumnDef, ColumnTrait, ColumnType, DbBackend, EntityName,
    EntityTrait, EnumIter, PrimaryKeyTrait, RelationDef, RelationTrait, Schema,
};
use sea_orm_macros::{DeriveEntityModel, DerivePrimaryKey};
use sea_query::{MysqlQueryBuilder, TableAlterStatement};

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

#[derive(Copy, Clone, Debug, EnumIter)]
pub enum Relation {}

impl RelationTrait for Relation {
    fn def(&self) -> RelationDef {
        panic!("No RelationDef")
    }
}
impl ActiveModelBehavior for ActiveModel {}

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

let mut alter_table = TableAlterStatement::new()
    .table(Entity)
    .add_column(&mut schema.get_column_def::<Entity>(Column::Title))
    .take();
assert_eq!(
    alter_table.to_string(MysqlQueryBuilder::default()),
    "ALTER TABLE `posts` ADD COLUMN `title` varchar(255) NOT NULL"
);
source§

impl Schema

source

pub fn new(backend: DatabaseBackend) -> Schema

Create a helper for a specific database backend

Trait Implementations§

source§

impl Debug for Schema

source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for Twhere T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for Twhere T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T> Instrument for T

source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> for Twhere U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

§

impl<T> Pointable for T

§

const ALIGN: usize = mem::align_of::<T>()

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
source§

impl<T, U> TryFrom<U> for Twhere U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<T> WithSubscriber for T

source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more