Skip to main content

Dialect

Enum Dialect 

Source
pub enum Dialect {
    Postgres,
    Sqlite,
    Mysql,
}
Expand description

Database dialect selection and dialect-specific behavior.

Type catalogs under each dialect are intentionally incomplete and frequently updated. data_types.rs lists native built-in types, aliases, and canonicalization rules; extension_types.rs lists popular extension or externally provided types. These catalogs exist for deterministic canonicalization, typo suggestions, and helpful prompts. They are not a claim that Gaman knows the full database type universe. Unknown types must not be rejected solely because they are absent from these catalogs; migration history and explicit user decisions are the project-local trust boundary. New dialect implementations must keep native data types and extension/popular external types in separate files following this layout.

Variants§

§

Postgres

§

Sqlite

§

Mysql

Implementations§

Source§

impl Dialect

Source

pub fn as_str(&self) -> &'static str

Returns the stable lowercase name for this dialect.

Source

pub fn parse(value: &str) -> Option<Self>

Parses a dialect name such as postgres, postgresql, sqlite, sqlite3, mysql, or mariadb.

Source

pub fn parse_from_url(database_url: &str) -> Result<Self, DialectParseError>

Infers the dialect from a database URL scheme.

This accepts normal URL forms such as postgres://..., postgresql://..., sqlite://..., mysql://..., and mariadb://..., plus SQLx’s SQLite shorthand such as sqlite::memory:.

Source

pub fn reorder( &self, ops: Vec<Operation>, previous: &Schema, current: &Schema, ) -> Vec<Operation>

Reorders operations to satisfy database-specific execution constraints. The default is a no-op — only databases with ordering requirements need to override. Called once per migration after diffing, before SQL generation or writing.

Source

pub fn should_merge(&self, _table_name: &str, _op: &Operation) -> bool

Whether a decomposed sub-entity op should be folded back into its parent CreateTable. Postgres can inline everything; other dialects (e.g. SQLite) may need FKs kept inline while indexes stay separate.

Source

pub fn normalize_type<'a>(&self, t: &'a str) -> &'a str

Source

pub fn canonical_type(&self, t: &str) -> String

Source

pub fn is_catalog_type(&self, t: &str) -> bool

Source

pub fn type_suggestions(&self, t: &str) -> Vec<String>

Source

pub fn validate_schema( &self, schema: &Schema, ) -> Result<(), SchemaValidationError>

Source

pub fn normalize_inspected_schema( &self, schema: Schema, ) -> Result<Schema, SchemaValidationError>

Normalizes a live inspected schema before semantic drift comparison.

Source

pub fn drift_contract(&self) -> &'static [DriftPropertyDoc]

Returns the documented semantic drift properties for this dialect.

Source

pub fn validate_migration(&self, m: &Migration) -> Result<(), DialectError>

Trait Implementations§

Source§

impl Clone for Dialect

Source§

fn clone(&self) -> Dialect

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Copy for Dialect

Source§

impl Debug for Dialect

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Eq for Dialect

Source§

impl PartialEq for Dialect

Source§

fn eq(&self, other: &Dialect) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for Dialect

Auto Trait Implementations§

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where 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.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

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

Source§

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 T
where U: TryFrom<T>,

Source§

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.