Skip to main content

cratestack_sql/
lib.rs

1//! Dialect-agnostic SQL primitives shared by the Postgres (`cratestack-sqlx`)
2//! and SQLite (`cratestack-rusqlite`) backends.
3//!
4//! This crate carries the type definitions every backend agrees on:
5//!
6//! - [`SqlValue`] / [`SqlColumnValue`] — value envelopes used to bind data
7//! - [`CreateModelInput`] / [`UpdateModelInput`] / [`UpsertModelInput`] —
8//!   traits the codegen emits
9//! - [`Filter`] / [`FilterExpr`] / [`FieldRef`] — query AST
10//! - [`OrderClause`] / [`SortDirection`] — ordering AST
11//! - [`ModelDescriptor`] / [`ModelColumn`] / [`CreateDefault`] — schema
12//!   metadata baked into compiled code by `include_schema!`
13//!
14//! Rendering SQL strings, executing queries, and any DB-driver coupling
15//! live in the backend crates.
16
17mod descriptor;
18mod dialect;
19mod filter;
20mod idempotency;
21mod order;
22mod order_catalog;
23mod relation_path;
24mod relation_scope;
25mod values;
26
27pub use descriptor::{
28    CreateDefault, CreateDefaultType, DatabaseDefault, EventTarget, GeneratedDefault,
29    GeneratedValue, LiteralDefault, ModelColumn, ModelDescriptor, ReadSource, ViewDescriptor,
30    WriteSource,
31};
32pub use dialect::{Dialect, PostgresDialect, SqliteDialect};
33pub use filter::eval::{in_memory_columns as filter_in_memory_columns, matches as filter_matches};
34pub use filter::{
35    CoalesceExpr, CoalesceFilter, FieldRef, Filter, FilterExpr, FilterOp, IntoColumnName,
36    JsonFilter, JsonTextPath, RelationFilter, RelationQuantifier, VectorDistanceExpr,
37    VectorDistanceFilter, VectorMetric, coalesce,
38};
39/// PostGIS query surface (cratestack#842) — gated behind this crate's
40/// `postgis` feature, which the backend facades forward from their own.
41#[cfg(feature = "postgis")]
42pub use filter::{SpatialDistanceExpr, SpatialFilter, SpatialPoint, point};
43pub use idempotency::IDEMPOTENCY_TABLE_DDL;
44pub use order::{NullOrder, OrderClause, OrderTarget, SortDirection};
45pub use order_catalog::{
46    OrderCatalog, OrderRelationEdge, ResolvedOrderTarget, resolve_order_target,
47};
48pub use relation_path::{
49    Orderable, RelationHop, Unorderable, is_orderable, order_value_sql, wrap_filter,
50};
51pub use relation_scope::RelatedReadScope;
52pub use values::{
53    ConflictTarget, CreateModelInput, DecimalLike, FilterValue, IntoSqlValue, ModelPrimaryKey,
54    Projection, RelationInclude, SqlColumnValue, SqlValue, UpdateModelInput, UpsertModelInput,
55    find_duplicate_sql_value,
56};