postrust_core/
lib.rs

1//! Postrust Core - PostgREST-compatible REST API for PostgreSQL in Rust.
2//!
3//! This crate provides the core functionality for Postrust, a serverless
4//! alternative to PostgREST written in Rust.
5//!
6//! # Architecture
7//!
8//! The request processing pipeline:
9//!
10//! 1. **API Request Parsing** (`api_request`) - Parse HTTP request into domain types
11//! 2. **Schema Cache** (`schema_cache`) - PostgreSQL metadata for validation
12//! 3. **Query Planning** (`plan`) - Convert request to execution plan
13//! 4. **SQL Generation** (`query`) - Generate parameterized SQL
14//! 5. **Response Formatting** - Format results for HTTP response
15//!
16//! # Example
17//!
18//! ```text
19//! use postrust_core::{ApiRequest, SchemaCache, create_action_plan};
20//!
21//! // Parse HTTP request
22//! let request = parse_request(&http_request, "public", &schemas)?;
23//!
24//! // Create execution plan
25//! let plan = create_action_plan(&request, &schema_cache)?;
26//!
27//! // Generate SQL
28//! let (sql, params) = build_query(&plan)?;
29//! ```
30
31// The `Error` enum carries a rich `DatabaseError` payload (PostgREST-style error
32// bodies), which makes it larger than clippy's `Result`/enum size thresholds.
33// Boxing it would ripple through every construction site for little benefit, so
34// the size lints are allowed crate-wide instead.
35#![allow(clippy::result_large_err)]
36#![allow(clippy::large_enum_variant)]
37
38pub mod api_request;
39pub mod config;
40pub mod embed;
41pub mod error;
42pub mod plan;
43pub mod query;
44pub mod row_json;
45pub mod schema_cache;
46
47// Re-export main types
48pub use api_request::{
49    parse_request, Action, ApiRequest, DbAction, Filter, LogicTree, MediaType, Mutation, Operation,
50    Payload, PreferRepresentation, Preferences, QualifiedIdentifier, QueryParams, Range, Resource,
51    SelectItem,
52};
53pub use config::{AppConfig, IsolationLevel, LogLevel};
54pub use error::{Error, Result};
55pub use plan::{create_action_plan, ActionPlan, CallPlan, DbActionPlan, MutatePlan, ReadPlan};
56pub use schema_cache::{Column, Relationship, Routine, SchemaCache, SchemaCacheRef, Table};
57
58/// Prelude for common imports.
59pub mod prelude {
60    pub use super::api_request::{
61        parse_request, Action, ApiRequest, Filter, MediaType, Preferences, QualifiedIdentifier,
62        QueryParams, Range, SelectItem,
63    };
64    pub use super::config::AppConfig;
65    pub use super::error::{Error, Result};
66    pub use super::plan::{create_action_plan, ActionPlan};
67    pub use super::schema_cache::{SchemaCache, SchemaCacheRef, Table};
68}
postrust_core/lib.rs

postrust_core/
lib.rs
