entity-derive 0.3.1

Derive macro for generating DTOs, repositories, and SQL from a single entity definition
docs.rs failed to build entity-derive-0.3.1
Please check the build logs for more information.
See Builds for ideas on how to fix a failed build, or Metadata for how to configure docs.rs builds.
If you believe this is docs.rs' fault, open an issue.
Visit the last successful build: entity-derive-0.5.0

The Problem

Building a typical CRUD application requires writing the same boilerplate over and over: entity struct, create DTO, update DTO, response DTO, row struct, repository trait, SQL implementation, and 6+ From implementations.

That's 200+ lines of boilerplate for a single entity.

The Solution

#[derive(Entity)]
#[entity(table = "users")]
pub struct User {
    #[id]
    pub id: Uuid,

    #[field(create, update, response)]
    pub name: String,

    #[field(create, update, response)]
    pub email: String,

    #[field(skip)]
    pub password_hash: String,

    #[field(response)]
    #[auto]
    pub created_at: DateTime<Utc>,
}

Done. The macro generates everything else.

Installation

[dependencies]
entity-derive = { version = "0.3", features = ["postgres"] }

Features

Feature Description
Zero Runtime Cost All code generation at compile time
Type Safe Change a field once, everything updates
Query Filtering Type-safe #[filter], #[filter(like)], #[filter(range)]
Relations #[belongs_to] and #[has_many]
Projections Partial views with optimized SELECT
Lifecycle Events Created, Updated, Deleted events
Real-Time Streams Postgres LISTEN/NOTIFY integration
Lifecycle Hooks before_create, after_update, etc.
CQRS Commands Business-oriented command pattern
Soft Delete deleted_at timestamp support

Documentation

Topic Languages
Getting Started
Attributes 🇬🇧 🇷🇺 🇰🇷 🇪🇸 🇨🇳
Examples 🇬🇧 🇷🇺 🇰🇷 🇪🇸 🇨🇳
Features
Filtering 🇬🇧 🇷🇺 🇰🇷 🇪🇸 🇨🇳
Relations 🇬🇧 🇷🇺 🇰🇷 🇪🇸 🇨🇳
Events 🇬🇧 🇷🇺 🇰🇷 🇪🇸 🇨🇳
Streams 🇬🇧 🇷🇺 🇰🇷 🇪🇸 🇨🇳
Hooks 🇬🇧 🇷🇺 🇰🇷 🇪🇸 🇨🇳
Commands 🇬🇧 🇷🇺 🇰🇷 🇪🇸 🇨🇳
Advanced
Custom SQL 🇬🇧 🇷🇺 🇰🇷 🇪🇸 🇨🇳
Web Frameworks 🇬🇧 🇷🇺 🇰🇷 🇪🇸 🇨🇳
Best Practices 🇬🇧 🇷🇺 🇰🇷 🇪🇸 🇨🇳

Quick Reference

Entity Attributes

#[entity(
    table = "users",           // Required: table name
    schema = "public",         // Optional: schema (default: public)
    dialect = "postgres",      // Optional: database dialect
    soft_delete,               // Optional: use deleted_at instead of DELETE
    events,                    // Optional: generate lifecycle events
    streams,                   // Optional: real-time Postgres NOTIFY
    hooks,                     // Optional: before/after lifecycle hooks
    commands,                  // Optional: CQRS command pattern
)]

Field Attributes

#[id]                          // Primary key (auto-generated UUID)
#[auto]                        // Auto-generated (timestamps)
#[field(create)]               // Include in CreateRequest
#[field(update)]               // Include in UpdateRequest
#[field(response)]             // Include in Response
#[field(skip)]                 // Exclude from all DTOs
#[filter]                      // Exact match filter
#[filter(like)]                // ILIKE pattern filter
#[filter(range)]               // Range filter (from/to)
#[belongs_to(Entity)]          // Foreign key relation
#[has_many(Entity)]            // One-to-many relation
#[projection(Name: fields)]    // Partial view

Code Coverage