tideorm 0.9.4

A developer-friendly ORM for Rust with clean, expressive syntax
Documentation
//! TideORM is a Rust ORM with macro-generated models, a query builder, and
//! field-declared relation helpers.
//!
//! When you are trying to debug behavior, start with:
//! - `query::QueryBuilder::debug()` to inspect generated SQL before execution
//! - `logging::QueryLogger` to see executed queries and slow-query timing
//! - `database::Database::init()` or `Database::set_global()` errors when models
//!   report that no global database has been configured
//!
//! The module docs below cover the public surface area in more detail.

#![recursion_limit = "256"]
#![warn(missing_docs)]
#![warn(clippy::all)]
#![deny(unsafe_code)]

#[doc(hidden)]
#[macro_export]
macro_rules! __doctest_prelude {
    () => {
        use std::time::Duration;
        use tideorm::prelude::*;

        #[tideorm::model(table = "users", soft_delete)]
        struct User {
            #[tideorm(primary_key, auto_increment)]
            id: i64,
            email: String,
            name: String,
            active: bool,
            age: i32,
            status: String,
            role: String,
            tier: String,
            created_at: chrono::DateTime<chrono::Utc>,
            deleted_at: Option<chrono::DateTime<chrono::Utc>>,
            metadata: tideorm::prelude::Json,
            settings: tideorm::prelude::Json,
            preferences: tideorm::prelude::Json,
            tags: tideorm::prelude::TextArray,
            skills: tideorm::prelude::TextArray,
            permissions: tideorm::prelude::TextArray,
            last_login_at: Option<chrono::DateTime<chrono::Utc>>,
        }

        #[tideorm::model(table = "products")]
        struct Product {
            #[tideorm(primary_key, auto_increment)]
            id: i64,
            category: String,
            price: f64,
            in_stock: bool,
        }

        #[tideorm::model(table = "orders")]
        struct Order {
            #[tideorm(primary_key, auto_increment)]
            id: i64,
            status: String,
            category: String,
            customer_id: i64,
            total: f64,
            amount: f64,
            created_at: chrono::DateTime<chrono::Utc>,
        }

        #[tideorm::model(table = "cakes")]
        struct Cake {
            #[tideorm(primary_key, auto_increment)]
            id: i64,
            name: String,
            bakery_id: i64,
        }

        #[tideorm::model(table = "posts")]
        struct Post {
            #[tideorm(primary_key, auto_increment)]
            id: i64,
            user_id: i64,
            title: String,
        }

        #[tideorm::model(table = "profiles")]
        struct Profile {
            #[tideorm(primary_key, auto_increment)]
            id: i64,
            user_id: i64,
            bio: String,
        }

        #[tideorm::model(table = "employees")]
        struct Employee {
            #[tideorm(primary_key, auto_increment)]
            id: i64,
            name: String,
            manager_id: Option<i64>,
            department_id: i64,
            salary: f64,
        }

        #[tideorm::model(table = "appointments")]
        struct Appointment {
            #[tideorm(primary_key, auto_increment)]
            id: i64,
            patient_id: i64,
            date: chrono::DateTime<chrono::Utc>,
        }

        #[tideorm::model(table = "sales")]
        struct Sale {
            #[tideorm(primary_key, auto_increment)]
            id: i64,
            amount: f64,
            date: chrono::DateTime<chrono::Utc>,
            created_at: chrono::DateTime<chrono::Utc>,
        }
    };
}

#[doc(hidden)]
#[macro_export]
macro_rules! __doctest_async {
    ($($body:tt)*) => {
        async fn demo() -> tideorm::Result<()> {
            $($body)*
            Ok(())
        }
    };
}

#[doc(hidden)]
#[macro_export]
macro_rules! __doctest_tokenizable_user {
    () => {
        use tideorm::prelude::*;

        #[tideorm::model(table = "users", tokenize)]
        struct User {
            #[tideorm(primary_key, auto_increment)]
            id: i64,
            email: String,
            name: String,
        }
    };
}

#[doc(hidden)]
pub mod internal;

/// Re-export sea_orm for internal macro use only
#[doc(hidden)]
pub use sea_orm;

// ============================================================================
// PUBLIC MODULES
// ============================================================================

/// Error types for TideORM
pub mod error;

/// Database connection and pool management
pub mod database;

/// Model trait and utilities
pub mod model;

/// Fluent query builder
pub mod query;

/// Attribute types and casting
pub mod types;

/// Soft delete support
pub mod soft_delete;

/// Callbacks and hooks for model lifecycle events
pub mod callbacks;

/// Database schema synchronization (DB_SYNC=true)
pub mod sync;

/// Schema generation (SQL file export)
pub mod schema;

/// Model relations (belongs_to, has_one, has_many)
pub mod relations;

extern crate self as tideorm;

/// File attachments system (attach, detach, sync)
#[cfg(feature = "attachments")]
pub mod attachments;

/// Translations system for multi-language support
#[cfg(feature = "translations")]
pub mod translations;

/// Global configuration
pub mod config;

/// Database migrations
pub mod migration;

/// Query logging and debugging
pub mod logging;

/// Performance profiling
pub mod profiling;

/// Query caching and prepared statement caching
pub mod cache;

/// Database seeding system
pub mod seeding;

/// Model validation system
pub mod validation;

/// Full-text search support
#[cfg(feature = "fulltext")]
pub mod fulltext;

/// Strongly-typed columns for compile-time type safety
pub mod columns;

/// Record tokenization for secure ID encoding
pub mod tokenization;

/// Re-exports for convenience
pub mod prelude;

// ============================================================================
// PUBLIC RE-EXPORTS
// ============================================================================

pub use database::Database;
// Global database access functions
#[cfg(feature = "attachments")]
pub use attachments::{AttachmentError, FileAttachment, FilesData, HasAttachments};
pub use callbacks::{CallbackRunner, Callbacks};
pub use config::{Config, TideConfig};
pub use database::{db, has_global_db, require_db, try_db};
pub use error::{Error, Result};
pub use migration::{ColumnType, Migration, Migrator, Schema};
pub use model::{Model, ModelMeta};
pub use query::{AggregateFunction, JoinClause, JoinType, Order, QueryBuilder};
pub use relations::{BelongsTo, EagerLoadExt, HasMany, HasOne, RelationExt, WithRelations};
pub use schema::SchemaWriter;
pub use soft_delete::SoftDelete;
#[cfg(feature = "translations")]
pub use translations::{
    ApplyTranslations, FieldTranslations, HasTranslations, TranslationError, TranslationInput,
    TranslationsData,
};

// Query logging and debugging
pub use logging::{
    LogLevel, QueryDebugInfo, QueryLogEntry, QueryLogger, QueryOperation, QueryStats, QueryTimer,
};

// Performance profiling
pub use profiling::{
    GlobalProfiler, GlobalStats, ProfileReport, ProfiledQuery, Profiler, QueryAnalyzer,
    QueryComplexity, QuerySuggestion, SuggestionLevel,
};

// Query and statement caching
pub use cache::{
    CacheConfig, CacheKeyBuilder, CacheOptions, CacheStats, CacheStrategy, CacheWarmer,
    CachedStatementInfo, PreparedStatementCache, PreparedStatementConfig, PreparedStatementStats,
    QueryCache,
};

// Validation
pub use validation::{
    ValidatableValue, Validate, ValidationBuilder, ValidationErrors, ValidationRule, Validator,
};

// Tokenization
pub use tokenization::{TokenConfig, TokenDecoder, TokenEncoder, Tokenizable};

// Re-export the derive macro
pub use tideorm_macros::Model;

// Re-export the attribute macro
pub use tideorm_macros::model;

// Re-export async_trait for macro use
pub use async_trait;

// Re-export chrono for macro use (timestamps)
pub use chrono;

// Re-export common types that users need
pub use chrono::{DateTime, NaiveDateTime, Utc};
pub use rust_decimal::Decimal;
pub use serde::{Deserialize, Serialize};
pub use uuid::Uuid;