@venizia/ignis-docs 0.2.1-0 → 0.2.1-1

package/content/references/base/repositories/index.md

@@ -6,7 +6,7 @@ difficulty: intermediate
 
 # Repositories
 
-A repository is the typed data-access object for one model - it turns a `@model` schema into `find`, `create`, `updateById`, `deleteById`, and friends, with the query shape validated at compile time.
+A repository is the typed data-access object for one model. It turns a `@model` schema into `find`, `create`, `updateById`, `deleteById`, and friends, with the query shape validated at compile time.
 
 ## In one example
 
@@ -26,8 +26,8 @@ That's it - `UserRepository` already has `find`, `findOne`, `findById`, `create`
 ## How it works
 
 - **Engine-neutral contract, PostgreSQL implementation.** `AbstractRepository` (engine-neutral, `src/base`) declares the CRUD contract - no SQL, no Drizzle. The PostgreSQL connector implements it as a chain of classes, each layer adding one capability (see table below).
-- **Datasource is auto-injected.** `@repository({ model, dataSource })` auto-injects the datasource at constructor param[0] and lazily resolves the entity class from its own metadata - a plain `extends DefaultCRUDRepository<...> {}` needs no constructor at all.
-- **One options object per verb.** Reads and updates carry a `filter` (`where`, `fields`, `include`, `order`, `limit`, `offset`); writes carry `data`; all of them accept an `options` bag for `transaction`, `shouldReturn`, and `shouldSkipDefaultFilter`.
+- **Datasource is auto-injected.** `@repository({ model, dataSource })` auto-injects the datasource at constructor param[0] and lazily resolves the entity class from its own metadata. A plain `extends DefaultCRUDRepository<...> {}` needs no constructor at all.
+- **One options object per verb.** Reads and updates carry a `filter` (`where`, `fields`, `include`, `order`, `limit`, `offset`). Writes carry `data`. Every verb also accepts an `options` bag for `transaction`, `shouldReturn`, and `shouldSkipDefaultFilter`.
 
 **PostgreSQL class chain**
 
@@ -124,10 +124,23 @@ try {
 
 See [DataSources](/references/base/datasources) for the rollback-safe pattern (`rollback()` itself can throw). See [Advanced Features](./advanced) for isolation levels and other transaction options.
 
+### Retry a read behind a replicated pool
+
+A read right after a write can hit a replica that has not caught up. Pass `retry` to re-read until the result is fresh:
+
+```typescript
+const user = await userRepository.findById({
+  id,
+  options: { retry: { maxAttempts: 4 } },
+});
+```
+
+Full options and rules: [Advanced Features - Read Retry](./advanced#read-retry-replica-lag).
+
 ## See also
 
 - [Relations & Includes](./relations) - eager loading, nested `scope` filters, many-to-many
-- [Advanced Features](./advanced) - transactions, hidden properties, `shouldQueryRange`, performance
+- [Advanced Features](./advanced) - transactions, hidden properties, `shouldQueryRange`, performance, read retry
 - [SoftDeletableRepository](./soft-deletable) - soft delete, restore, hard delete
 - [Repository Mixins (Removed)](./mixins) - where `FieldsVisibilityMixin`/`DefaultFilterMixin` behavior lives now
 - [Filter System](/references/base/filter-system/) - every `where` operator, ordering, pagination
@@ -135,5 +148,5 @@ See [DataSources](/references/base/datasources) for the rollback-safe pattern (`
 
 **Files:**
 
-- [`packages/core/src/base/repositories/core/abstract.ts`](https://github.com/VENIZIA-AI/ignis/blob/main/packages/core/src/base/repositories/core/abstract.ts) - neutral `AbstractRepository`
-- [`packages/core/src/connectors/postgres/repositories/core/index.ts`](https://github.com/VENIZIA-AI/ignis/blob/main/packages/core/src/connectors/postgres/repositories/core/index.ts) - PostgreSQL hierarchy + compatibility aliases
+- [`packages/core-server/src/base/repositories/core/abstract.ts`](https://github.com/VENIZIA-AI/ignis/blob/main/packages/core-server/src/base/repositories/core/abstract.ts) - neutral `AbstractRepository`
+- [`packages/core-server/src/connectors/postgres/repositories/core/index.ts`](https://github.com/VENIZIA-AI/ignis/blob/main/packages/core-server/src/connectors/postgres/repositories/core/index.ts) - PostgreSQL hierarchy + compatibility aliases

package/content/references/base/repositories/mixins.md

@@ -11,8 +11,8 @@ lastUpdated: 2026-07-06
 
 **Files:**
 
-- [`packages/core/src/base/repositories/core/abstract.ts`](https://github.com/VENIZIA-AI/ignis/blob/main/packages/core/src/base/repositories/core/abstract.ts) - `AbstractRepository` - `hiddenFields`/`defaultWhere`/`defaultLimit` getters
-- [`packages/core/src/connectors/postgres/repositories/core/base.ts`](https://github.com/VENIZIA-AI/ignis/blob/main/packages/core/src/connectors/postgres/repositories/core/base.ts) - `RelationalBaseRepository` (alias `PostgresBaseRepository`) - `getHiddenProperties`, `getVisibleProperties`, `getDefaultFilter`, `applyDefaultFilter`
+- [`packages/core-server/src/base/repositories/core/abstract.ts`](https://github.com/VENIZIA-AI/ignis/blob/main/packages/core-server/src/base/repositories/core/abstract.ts) - `AbstractRepository` - `hiddenFields`/`defaultWhere`/`defaultLimit` getters
+- [`packages/core-server/src/connectors/postgres/repositories/core/base.ts`](https://github.com/VENIZIA-AI/ignis/blob/main/packages/core-server/src/connectors/postgres/repositories/core/base.ts) - `RelationalBaseRepository` (alias `PostgresBaseRepository`) - `getHiddenProperties`, `getVisibleProperties`, `getDefaultFilter`, `applyDefaultFilter`
 
 > [!WARNING] Removed
 > `FieldsVisibilityMixin` and `DefaultFilterMixin` are no longer exported and must not be imported or composed in new code.
@@ -28,7 +28,7 @@ Before the connectors restructure, `AbstractRepository` composed two mixins onto
 
 ## Where the Behavior Lives Now
 
-The functionality was not dropped - it was folded directly into the repository hierarchy.
+IGNIS didn't drop the functionality - it folded it directly into the repository hierarchy.
 
 ### Engine-neutral: `AbstractRepository`
 
@@ -59,7 +59,7 @@ applyDefaultFilter(opts: {
 }): TFilter;                                              // merges via queryDialect.mergeFilter
 ```
 
-Hidden columns are excluded from `select()` and `returning()` calls at query time - the same SQL-level guarantee the mixins provided. The typesense connector implements its own equivalent natively since it is not Drizzle-aware.
+The query builder excludes hidden columns from `select()` and `returning()` calls at query time - the same SQL-level guarantee the mixins provided. The typesense connector implements its own equivalent natively, since it is not Drizzle-aware.
 
 ## Migration
 
@@ -72,7 +72,7 @@ Hidden columns are excluded from `select()` and `returning()` calls at query tim
 | `DefaultFilterMixin` -> `hasDefaultFilter()` | `RelationalBaseRepository.hasDefaultFilter()` |
 | `DefaultFilterMixin` -> `applyDefaultFilter()` | `RelationalBaseRepository.applyDefaultFilter()` |
 
-If you extended `DefaultCRUDRepository` (or any class in the PostgreSQL hierarchy), no change is needed - these methods have always been available on your repository instances; only the internal composition changed.
+If you extended `DefaultCRUDRepository` (or any class in the PostgreSQL hierarchy), you don't need to change anything - these methods have always been available on your repository instances. Only the internal composition changed.
 
 ## Custom Mixins Still Work