fraiseql_db/
lib.rs

1//! # fraiseql-db
2//!
3//! Database abstraction layer for FraiseQL v2.
4//!
5//! This crate provides database-agnostic access to multiple database backends:
6//! - PostgreSQL (primary, full feature set)
7//! - MySQL (secondary support)
8//! - SQLite (local dev, testing)
9//! - SQL Server (enterprise)
10//!
11//! It also provides the shared DB-level types used by the compilation and
12//! execution layers: collation configuration, SQL hint types, and extended
13//! filter operators.
14
15#![forbid(unsafe_code)]
16#![deny(missing_docs)]
17// Reason: SQL identifiers in doc comments (e.g. `SELECT`, `WHERE`) are not Rust
18//         items and should not be linked; forcing backtick wrapping on every SQL
19//         keyword is noisier than the lint prevents.
20#![allow(clippy::doc_markdown)]
21// Reason: Multiple `match` arms return identical values in dialect dispatch
22//         blocks because dialects share a default behaviour; merging with `|`
23//         would lose the explicit per-dialect annotation.
24#![allow(clippy::match_same_arms)]
25// Reason: `DatabaseAdapter` implementations take many configuration parameters
26//         (view name, WHERE clause, projection, limit, offset, params…).
27//         Breaking them into per-call builder structs would add wrapper
28//         complexity without clarity gains on the hot path.
29#![allow(clippy::too_many_arguments)]
30// Reason: `match` arms that match a single enum variant and a wildcard `_`
31//         appear in dialect dispatch where the wildcard carries an explicit
32//         comment explaining the fallthrough intent (forward-compat guard on
33//         `DatabaseType`).
34#![allow(clippy::match_wildcard_for_single_variants)]
35
36/// A type alias for `Result<T, fraiseql_error::FraiseQLError>`, used throughout this crate.
37pub type Result<T> = std::result::Result<T, fraiseql_error::FraiseQLError>;
38
39// New modules (types extracted from fraiseql-core)
40pub mod collation_config;
41pub mod dialect;
42pub mod filters;
43pub mod introspector;
44pub mod types;
45pub mod where_generator;
46
47// Shared utilities
48pub(crate) mod utils;
49
50// DB adapter modules (from the old db/ directory)
51pub mod collation;
52pub mod identifier;
53pub mod order_by;
54pub mod path_escape;
55pub mod projection_generator;
56pub mod traits;
57pub mod where_clause;
58pub mod where_sql_generator;
59
60#[cfg(feature = "postgres")]
61pub mod postgres;
62
63#[cfg(feature = "mysql")]
64pub mod mysql;
65
66#[cfg(feature = "sqlite")]
67pub mod sqlite;
68
69#[cfg(feature = "sqlserver")]
70pub mod sqlserver;
71
72#[cfg(feature = "wire-backend")]
73pub mod wire_pool;
74
75#[cfg(feature = "wire-backend")]
76pub mod fraiseql_wire_adapter;
77
78// Re-export commonly used types
79pub use collation::{CollationCapabilities, CollationMapper};
80pub use collation_config::{
81    CollationConfig, DatabaseCollationOverrides, InvalidLocaleStrategy, MySqlCollationConfig,
82    PostgresCollationConfig, SqlServerCollationConfig, SqliteCollationConfig,
83};
84pub use dialect::{
85    DialectCapabilityGuard, Feature, MySqlDialect, PostgresDialect, SqlDialect, SqlServerDialect,
86    SqliteDialect, UnsupportedOperator,
87};
88#[cfg(feature = "wire-backend")]
89pub use fraiseql_wire_adapter::FraiseWireAdapter;
90pub use identifier::{
91    quote_mysql_identifier, quote_postgres_identifier, quote_sqlite_identifier,
92    quote_sqlserver_identifier,
93};
94pub use introspector::{DatabaseIntrospector, RelationInfo, RelationKind};
95#[cfg(feature = "mysql")]
96pub use mysql::{MySqlAdapter, MySqlIntrospector};
97#[cfg(feature = "postgres")]
98pub use postgres::{PostgresAdapter, PostgresIntrospector};
99pub use projection_generator::{
100    FieldKind, MySqlProjectionGenerator, PostgresProjectionGenerator, ProjectionField,
101    SqliteProjectionGenerator,
102};
103#[cfg(feature = "sqlite")]
104pub use sqlite::{SqliteAdapter, SqliteIntrospector};
105#[cfg(feature = "sqlserver")]
106pub use sqlserver::{SqlServerAdapter, SqlServerIntrospector};
107pub use traits::{
108    ArcDatabaseAdapter, BoxDatabaseAdapter, CursorValue, DatabaseAdapter, DatabaseCapabilities,
109    DirectMutationContext, DirectMutationOp, MutationStrategy, RelayDatabaseAdapter,
110    RelayPageResult, SupportsMutations,
111};
112pub use types::{
113    DatabaseType, JsonbValue, PoolMetrics,
114    sql_hints::{OrderByClause, OrderByFieldType, OrderDirection, SqlProjectionHint},
115};
116pub use where_clause::{HavingClause, WhereClause, WhereOperator};
117pub use where_generator::GenericWhereGenerator;
118pub use where_sql_generator::WhereSqlGenerator;
fraiseql_db/lib.rs

fraiseql_db/
lib.rs
