Skip to main content

DatabaseType

Enum DatabaseType 

Source
pub enum DatabaseType {
    PostgreSQL,
}
Expand description

Database types supported by FraiseQL.

FraiseQL is PostgreSQL-only: the MySQL, SQLite and SQL Server variants were removed with their adapters (G2 decision on #374 — the non-PostgreSQL dialects were never production-correct, see #721/#799). The enum is kept — rather than replaced with a unit type — so that SQL-generation seams stay explicitly tagged with the dialect they emit, and a future backend addition is a compile-time-visible change at every match site.

§Stability

This enum is intentionally not #[non_exhaustive]. All match sites in the codebase must handle every variant explicitly, giving compile-time assurance that new database backends are fully integrated before release. Adding a variant is a semver-breaking change (minor version bump with migration guide).

Variants§

§

PostgreSQL

PostgreSQL database (the only supported backend).

Implementations§

Source§

impl DatabaseType

Source

pub fn json_field_expr(self, key: &str) -> String

Return a SQL expression that extracts a text value from the data JSONB column.

The key must already be validated via OrderByClause::validate_field_name and converted to snake_case storage form via OrderByClause::storage_key.

§Examples
use fraiseql_db::DatabaseType;

assert_eq!(DatabaseType::PostgreSQL.json_field_expr("created_at"), "data->>'created_at'");
Source

pub fn dialect(self) -> &'static dyn SqlDialect

Return the SqlDialect that renders SQL for this database.

The two dialect abstractions — this enum, used by the ORDER BY renderer, and the SqlDialect trait, used by the WHERE generator — resolve to the same implementation here, so neither can carry its own copy of a rendering rule.

Source

pub fn typed_json_field_expr( self, key: &str, field_type: ScalarFieldType, ) -> String

Return a SQL expression that extracts and casts a value from the data JSONB column for ORDER BY sorting.

When field_type is ScalarFieldType::Text this is identical to json_field_expr. For numeric, date, and boolean types the expression is wrapped in a dialect-specific cast so the database sorts by the typed value instead of the raw text ("9" > "10" is wrong for numbers).

The cast itself comes from SqlDialect::cast_expr_as — the same call the WHERE generator makes — so an ORDER BY and a filter on one field agree.

§Examples
use fraiseql_db::{DatabaseType, ScalarFieldType};

assert_eq!(
    DatabaseType::PostgreSQL.typed_json_field_expr("amount", ScalarFieldType::Numeric),
    "(data->>'amount')::numeric"
);
Source§

impl DatabaseType

Source

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

Get database type as string.

Trait Implementations§

Source§

impl Clone for DatabaseType

Source§

fn clone(&self) -> Self

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 DatabaseType

Source§

impl Debug for DatabaseType

Source§

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

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

impl<'de> Deserialize<'de> for DatabaseType

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Display for DatabaseType

Source§

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

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

impl Eq for DatabaseType

Source§

impl Hash for DatabaseType

Source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl PartialEq for DatabaseType

Source§

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

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

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

Inequality operator !=. Read more
Source§

impl Serialize for DatabaseType

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for DatabaseType

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<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

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> 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 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> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

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

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

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.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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