fraiseql-db 2.16.0

Database abstraction layer for FraiseQL v2
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104

//! # fraiseql-db
//!
//! Database abstraction layer for FraiseQL v2.
//!
//! This crate provides database-agnostic access to multiple database backends:
//! - PostgreSQL (primary, full feature set)
//! - SQL Server (enterprise)
//!
//! It also provides the shared DB-level types used by the compilation and
//! execution layers: SQL hint types and extended filter operators.

#![forbid(unsafe_code)]
#![deny(missing_docs)]
// Reason: SQL identifiers in doc comments (e.g. `SELECT`, `WHERE`) are not Rust
//         items and should not be linked; forcing backtick wrapping on every SQL
//         keyword is noisier than the lint prevents.
#![allow(clippy::doc_markdown)]
// Reason: Multiple `match` arms return identical values in dialect dispatch
//         blocks because dialects share a default behaviour; merging with `|`
//         would lose the explicit per-dialect annotation.
#![allow(clippy::match_same_arms)]
// Reason: `DatabaseAdapter` implementations take many configuration parameters
//         (view name, WHERE clause, projection, limit, offset, params…).
//         Breaking them into per-call builder structs would add wrapper
//         complexity without clarity gains on the hot path.
#![allow(clippy::too_many_arguments)]
// Reason: `match` arms that match a single enum variant and a wildcard `_`
//         appear in dialect dispatch where the wildcard carries an explicit
//         comment explaining the fallthrough intent (forward-compat guard on
//         `DatabaseType`).
#![allow(clippy::match_wildcard_for_single_variants)]

/// A type alias for `Result<T, fraiseql_error::FraiseQLError>`, used throughout this crate.
pub type Result<T> = std::result::Result<T, fraiseql_error::FraiseQLError>;

// New modules (types extracted from fraiseql-core)
pub mod changelog;
pub mod dialect;
pub mod introspector;
pub mod types;
pub mod where_generator;

// Shared utilities. `utils::to_snake_case` is the canonical field-name → JSONB
// key rule, re-used by `fraiseql-core`'s entity projector so SQL and Rust
// projection can never disagree on a source key.
pub mod utils;

// DB adapter modules (from the old db/ directory)
pub mod identifier;
pub mod order_by;
pub mod path_escape;
pub mod projection_generator;
pub mod traits;
pub mod view_name;
pub mod where_clause;
pub mod where_sql_generator;

#[cfg(feature = "postgres")]
pub mod postgres;

#[cfg(feature = "wire-backend")]
pub mod wire_pool;

#[cfg(feature = "wire-backend")]
pub mod fraiseql_wire_adapter;

// Re-export commonly used types
pub use changelog::{
    CDC_MEDIATED_ON, CDC_MEDIATED_VAR, CLOCK_TIMESTAMP_DIRECTIVE, DURATION_CALC_VERSION,
    STARTED_AT_VAR, duration_ms_sql,
};
pub use dialect::{PostgresDialect, SqlDialect, UnsupportedOperator};
#[cfg(feature = "wire-backend")]
pub use fraiseql_wire_adapter::FraiseWireAdapter;
pub use identifier::quote_postgres_identifier;
pub use introspector::{DatabaseIntrospector, RelationInfo, RelationKind};
#[cfg(feature = "postgres")]
pub use postgres::{PostgresAdapter, PostgresIntrospector};
pub use projection_generator::{FieldKind, PostgresProjectionGenerator, ProjectionField};
/// The `serde_json` this crate's public API is built against (#1198).
pub use serde_json;
/// The `tokio_postgres` this crate's public API is built against (#1198).
#[cfg(feature = "postgres")]
pub use tokio_postgres;
pub use traits::{
    AdminSqlOutcome, AdminSqlRequest, ArcDatabaseAdapter, BoxDatabaseAdapter,
    COMPOSED_DOCUMENT_KEY, COMPOSED_EMBEDS_KEY, ChangeLogWrite, ColumnRowStream, ComposedEmbed,
    ComposedKeyset, ComposedLevel, CursorValue, DatabaseAdapter, EmbedShape, EmbedSource,
    JsonbRowStream, LevelKeys, MutationRowGate, ProjectionRequest, RelayDatabaseAdapter,
    RelayPageResult, ResultCacheStats, WriteMode, WriteRequest, Writer, composed_read_unsupported,
};
pub use types::{
    DatabaseType, JsonbValue, PoolMetrics, QueryStatEntry,
    sql_hints::{
        OrderByClause, OrderDirection, RelevanceOrder, ScalarFieldType, SqlProjectionHint,
        VectorDistanceOrder, VectorOperandKind,
    },
};
/// The `uuid` this crate's public API is built against (#1198).
pub use uuid;
pub use view_name::ViewName;
pub use where_clause::{HavingClause, WhereClause, WhereOperator};
pub use where_generator::GenericWhereGenerator;
pub use where_sql_generator::WhereSqlGenerator;