anda_db_derive 0.8.2

A Rust procedural macro crate that provides derive macros for AndaDB schema types.
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

# anda_db_derive

`anda_db_derive` is the procedural-macro layer of the AndaDB workspace. It
turns ordinary Rust structs into AndaDB schema definitions, reducing boilerplate
and keeping application data models aligned with the database type system.

## What This Crate Provides

- `AndaDBSchema` for generating a complete `Schema`
- `FieldTyped` for generating nested `FieldType` descriptions
- support for `#[field_type = "..."]` overrides
- support for `#[unique]`
- serde-aware naming: `#[serde(rename = "...")]` and
  `#[serde(rename_all = "...")]` are honoured, and
  `#[serde(skip)]` / `#[serde(skip_serializing)]` fields are excluded, so the
  generated schema always matches the serialized representation
- compile-time validation: field names AndaDB cannot store, duplicate names,
  `_id` misuse, and unsupported `#[serde(flatten)]` / `#[serde(transparent)]`
  are reported with precise spans
- extraction of doc comments into schema field descriptions

## When to Use It

Use `anda_db_derive` when you want to:

- define collection schemas from Rust structs instead of building them manually
- keep application models and storage schemas synchronized
- generate nested map-like field types from user-defined structs
- reduce repetitive schema boilerplate in embedded database code

## Getting Started

Add the derive crate alongside `anda_db_schema`:

```toml
[dependencies]
anda_db_schema = "0.4"
anda_db_derive = "0.5"
serde = { version = "1", features = ["derive"] }
```

Typical usage:

```rust
use anda_db_derive::AndaDBSchema;
use serde::{Deserialize, Serialize};

#[derive(Debug, Clone, Serialize, Deserialize, AndaDBSchema)]
struct MyDoc {
    _id: u64,
    title: String,
    body: String,
}
```

## Technical Reference

Deep technical documentation for this crate lives in:

- [docs/anda_db_derive.md](../../docs/anda_db_derive.md)
- [docs/anda_db_schema.md](../../docs/anda_db_schema.md)

## Related Crates

- `anda_db_schema` for the underlying schema and document types
- `anda_db` for the embedded database that consumes generated schemas

## License

MIT. See [LICENSE](../../LICENSE).