metal-orm 1.0.117 → 1.1.0

package/README.md

@@ -86,9 +86,10 @@ Full docs live in the `docs/` folder:
 - [OpenAPI Schema Generation](https://github.com/celsowm/metal-orm/blob/main/docs/openapi.md)
 - [DML Operations](https://github.com/celsowm/metal-orm/blob/main/docs/dml-operations.md)
 - [Hydration & Entities](https://github.com/celsowm/metal-orm/blob/main/docs/hydration.md)
-- [Runtime & Unit of Work](https://github.com/celsowm/metal-orm/blob/main/docs/runtime.md)
-- [Save Graph](https://github.com/celsowm/metal-orm/blob/main/docs/save-graph.md)
-- [Advanced Features](https://github.com/celsowm/metal-orm/blob/main/docs/advanced-features.md)
+- [Runtime & Unit of Work](https://github.com/celsowm/metal-orm/blob/main/docs/runtime.md)
+- [Save Graph](https://github.com/celsowm/metal-orm/blob/main/docs/save-graph.md)
+- [Caching](https://github.com/celsowm/metal-orm/blob/main/docs/caching.md)
+- [Advanced Features](https://github.com/celsowm/metal-orm/blob/main/docs/advanced-features.md)
 - [Multi-Dialect Support](https://github.com/celsowm/metal-orm/blob/main/docs/multi-dialect-support.md)
 - [Schema Generation (DDL)](https://github.com/celsowm/metal-orm/blob/main/docs/schema-generation.md)
 - [API Reference](https://github.com/celsowm/metal-orm/blob/main/docs/api-reference.md)
@@ -128,9 +129,10 @@ On top of the query builder, MetalORM ships a focused runtime managed by `Orm` a
 - **Lazy, batched relations**: `user.posts.load()`, `user.roles.syncByIds([...])`, etc.
 - **Scoped transactions**: `session.transaction(async s => { ... })` wraps `begin/commit/rollback` on the existing executor; `Orm.transaction` remains available when you want a fresh transactional executor per call.
 - **Identity map**: the same row becomes the same entity instance within a session (see the [Identity map pattern](https://en.wikipedia.org/wiki/Identity_map_pattern)).
+- **Caching**: Flexible caching with `MemoryCacheAdapter` (dev) or `KeyvCacheAdapter` (Redis, etc.). Features human-readable TTL (`'30m'`, `'2h'`), tag-based invalidation, and multi-tenant cache isolation.
 - **Tree Behavior (Nested Set/MPTT)**: hierarchical data with `TreeManager`, `treeQuery()`, and `@Tree` decorators. Efficient O(log n) operations for moves, inserts, and deletes. Supports multi-tree scoping, recovery, and validation.
 - **DTO/OpenAPI helpers**: the `metal-orm/dto` module generates DTOs and OpenAPI schemas, including tree schemas (`TreeNode`, `TreeNodeResult`, threaded trees).
-- **Unit of Work (`OrmSession`)** tracking New/Dirty/Removed entities and relation changes, inspired by the classic [Unit of Work pattern](https://en.wikipedia.org/wiki/Unit_of_work).
+- **Unit of Work (`OrmSession`)** tracking New/Dirty/Removed entities and relation changes, inspired by the classic [Unit of Work pattern](https://en.wikipedia.org/wiki/wiki/Unit_of_work).
 - **Graph persistence**: mutate a whole object graph and flush once with `session.commit()`.
 - **Partial updates**: use `session.patchGraph()` to update only specific fields of an entity and its relations (returns `null` if entity doesn't exist).
 - **Relation change processor** that knows how to deal with has-many and many-to-many pivot tables.
@@ -180,16 +182,26 @@ pnpm add metal-orm
 
 MetalORM compiles SQL; you bring your own driver:
 
-| Dialect            | Driver    | Install                |
-| ------------------ | --------- | ---------------------- |
-| MySQL / MariaDB    | `mysql2`  | `npm install mysql2`   |
-| SQLite             | `sqlite3` | `npm install sqlite3`  |
-| PostgreSQL         | `pg`      | `npm install pg`       |
-| SQL Server         | `tedious` | `npm install tedious`  |
-
-Pick the matching dialect (`MySqlDialect`, `SQLiteDialect`, `PostgresDialect`, `MSSQLDialect`) when compiling queries.
-
-> Drivers are declared as optional peer dependencies. Install only the ones you actually use in your project.
+| Dialect            | Driver    | Install                |
+| ------------------ | --------- | ---------------------- |
+| MySQL / MariaDB    | `mysql2`  | `npm install mysql2`   |
+| SQLite             | `sqlite3` | `npm install sqlite3`  |
+| PostgreSQL         | `pg`      | `npm install pg`       |
+| SQL Server         | `tedious` | `npm install tedious`  |
+
+Pick the matching dialect (`MySqlDialect`, `SQLiteDialect`, `PostgresDialect`, `MSSQLDialect`) when compiling queries.
+
+> Drivers are declared as optional peer dependencies. Install only the ones you actually use in your project.
+
+**Optional: Caching Backend**
+
+For production caching with Redis or other stores:
+
+```bash
+npm install keyv @keyv/redis
+```
+
+> The `keyv` package is optional. MetalORM includes `MemoryCacheAdapter` for development without external dependencies.
 
 ### Playground (optional) 🧪