postrust-core 0.2.1

Core library for Postrust - PostgREST-compatible REST API for PostgreSQL
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

//! Postrust Core - PostgREST-compatible REST API for PostgreSQL in Rust.
//!
//! This crate provides the core functionality for Postrust, a serverless
//! alternative to PostgREST written in Rust.
//!
//! # Architecture
//!
//! The request processing pipeline:
//!
//! 1. **API Request Parsing** (`api_request`) - Parse HTTP request into domain types
//! 2. **Schema Cache** (`schema_cache`) - PostgreSQL metadata for validation
//! 3. **Query Planning** (`plan`) - Convert request to execution plan
//! 4. **SQL Generation** (`query`) - Generate parameterized SQL
//! 5. **Response Formatting** - Format results for HTTP response
//!
//! # Example
//!
//! ```ignore
//! use postrust_core::{ApiRequest, SchemaCache, create_action_plan};
//!
//! // Parse HTTP request
//! let request = parse_request(&http_request, "public", &schemas)?;
//!
//! // Create execution plan
//! let plan = create_action_plan(&request, &schema_cache)?;
//!
//! // Generate SQL
//! let (sql, params) = build_query(&plan)?;
//! ```

pub mod api_request;
pub mod config;
pub mod error;
pub mod plan;
pub mod query;
pub mod schema_cache;

// Re-export main types
pub use api_request::{
    parse_request, Action, ApiRequest, DbAction, Filter, LogicTree, MediaType,
    Mutation, Operation, Payload, Preferences, PreferRepresentation, QualifiedIdentifier,
    QueryParams, Range, Resource, SelectItem,
};
pub use config::{AppConfig, IsolationLevel, LogLevel};
pub use error::{Error, Result};
pub use plan::{create_action_plan, ActionPlan, CallPlan, DbActionPlan, MutatePlan, ReadPlan};
pub use schema_cache::{Column, Relationship, Routine, SchemaCache, SchemaCacheRef, Table};

/// Prelude for common imports.
pub mod prelude {
    pub use super::api_request::{
        parse_request, Action, ApiRequest, Filter, MediaType, Preferences,
        QualifiedIdentifier, QueryParams, Range, SelectItem,
    };
    pub use super::config::AppConfig;
    pub use super::error::{Error, Result};
    pub use super::plan::{create_action_plan, ActionPlan};
    pub use super::schema_cache::{SchemaCache, SchemaCacheRef, Table};
}