Skip to main content

fraiseql_wire/
lib.rs

1//! fraiseql-wire: Streaming JSON query engine for Postgres 17
2//!
3//! This crate provides a minimal, async Rust query engine that streams JSON
4//! data from Postgres with low latency and bounded memory usage.
5//!
6//! # Supported Query Shape
7//!
8//! ```sql
9//! SELECT data
10//! FROM v_{entity}
11//! WHERE predicate
12//! [ORDER BY expression]
13//! ```
14
15#![warn(missing_docs, rust_2018_idioms)]
16#[cfg(not(unix))]
17compile_error!("fraiseql-wire only supports Unix-like operating systems (Linux, macOS).");
18
19pub mod auth;
20pub mod client;
21pub mod connection;
22pub mod error;
23pub mod json;
24pub mod metrics;
25pub mod operators;
26pub mod protocol;
27pub mod stream;
28pub mod util;
29
30// Re-export commonly used types
31pub use client::FraiseClient;
32pub use error::{Error, Result};
33pub use operators::{Field, OrderByClause, SortOrder, Value, WhereOperator};
34
35/// Library version
36pub const VERSION: &str = env!("CARGO_PKG_VERSION");