tideorm 0.9.14

A developer-friendly ORM for Rust with clean, expressive syntax
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
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84

//! Query Logging and Debugging
//!
//! Use this module when you need to answer questions like:
//! - what SQL TideORM actually executed
//! - which query is slow
//! - which parameters were bound on a failing query
//!
//! `QueryLogger` controls runtime logging. `QueryBuilder::debug()` is better
//! when you want to inspect one query locally without turning on global logs.
//!
//! Typical workflow:
//! - enable `QueryLogger` globally when you need runtime SQL history or slow-query tracking
//! - use `QueryBuilder::debug()` when you only need to inspect one query locally
//! - raise the level to `Trace` only when you need bound parameters in the output
//!
//! # Log Levels
//!
//! | Level | Output |
//! |-------|--------|
//! | `Off` | No logging |
//! | `Error` | Only errors |
//! | `Warn` | Errors and slow queries |
//! | `Info` | Errors, slow queries, and query summaries |
//! | `Debug` | All queries with timing |
//! | `Trace` | All queries with parameters and execution plan hints |
//!
//! # Environment Variables
//!
//! - `TIDE_LOG_QUERIES=true` - Enable basic query logging
//! - `TIDE_LOG_LEVEL=debug` - Set log level (off, error, warn, info, debug, trace)
//! - `TIDE_SLOW_QUERY_MS=100` - Slow query threshold in milliseconds
//!
//! `QueryBuilder::debug()` is the better first stop when a query shape looks
//! wrong but you do not want global logging enabled for the whole process.

mod debug;
mod entry;
mod format;
mod logger;

pub use self::debug::QueryDebugInfo;
pub use self::entry::{LogLevel, QueryLogEntry, QueryOperation, QueryStats, QueryTimer};
pub use self::logger::{QueryLogger, QueryLoggerBuilder};

#[cfg(test)]
#[path = "../../tests/unit/logging_tests.rs"]
mod tests;

// ============================================================================
// Internal structured logging macros
// ============================================================================
//
// These replace raw `eprintln!` usage across the crate with a consistent
// format: `[TideORM <LEVEL>] message`.
//
// Not part of the public API — these are `#[doc(hidden)]` helpers used
// internally by sync, migration, seeding, and config modules.

/// Internal info-level log (operational status messages)
#[doc(hidden)]
#[macro_export]
macro_rules! tide_info {
    ($($arg:tt)*) => {
        eprintln!("[TideORM] {}", format!($($arg)*));
    };
}

/// Internal warning-level log (non-fatal issues)
#[doc(hidden)]
#[macro_export]
macro_rules! tide_warn {
    ($($arg:tt)*) => {
        eprintln!("[TideORM WARN] {}", format!($($arg)*));
    };
}

/// Internal debug-level log (verbose operational detail)
#[doc(hidden)]
#[macro_export]
macro_rules! tide_debug {
    ($($arg:tt)*) => {
        eprintln!("[TideORM DEBUG] {}", format!($($arg)*));
    };
}