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//! ```ignore
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
31pub mod api_request;
32pub mod config;
33pub mod error;
34pub mod plan;
35pub mod query;
36pub mod schema_cache;
37
38// Re-export main types
39pub use api_request::{
40    parse_request, Action, ApiRequest, DbAction, Filter, LogicTree, MediaType,
41    Mutation, Operation, Payload, Preferences, PreferRepresentation, QualifiedIdentifier,
42    QueryParams, Range, Resource, SelectItem,
43};
44pub use config::{AppConfig, IsolationLevel, LogLevel};
45pub use error::{Error, Result};
46pub use plan::{create_action_plan, ActionPlan, CallPlan, DbActionPlan, MutatePlan, ReadPlan};
47pub use schema_cache::{Column, Relationship, Routine, SchemaCache, SchemaCacheRef, Table};
48
49/// Prelude for common imports.
50pub mod prelude {
51    pub use super::api_request::{
52        parse_request, Action, ApiRequest, Filter, MediaType, Preferences,
53        QualifiedIdentifier, QueryParams, Range, SelectItem,
54    };
55    pub use super::config::AppConfig;
56    pub use super::error::{Error, Result};
57    pub use super::plan::{create_action_plan, ActionPlan};
58    pub use super::schema_cache::{SchemaCache, SchemaCacheRef, Table};
59}
postrust_core/lib.rs

postrust_core/
lib.rs
