TypedEAV documentation
Add runtime-defined custom fields to Active Record models using native PostgreSQL columns for scalar values and JSONB for collections. Define fields globally or per tenant, validate input, and query values through Active Record relations.
Start here
- Install and try TypedEAV.
- Define fields, assign values, and build forms.
- Configure tenant scoping if your application has tenants.
- Filter, sort, and summarize values.
Guides
| Task | Guide |
|---|---|
| Choose field types and create custom types | Fields and validation |
| Build forms, manage fields, and inspect pending changes | Reading, writing, and forms |
| Configure tenants and inspect effective definitions | Scoping and partitions |
| Search and summarize custom values | Queries |
| Read and update many records | Bulk operations |
| Map CSV rows to custom fields | CSV mapping |
| Move field definitions between environments | Schema portability |
| React to changes and keep audit history | Events and versioning |
| Evaluate indexes and performance tradeoffs | Storage and performance |
| Upgrade an existing installation | Upgrading |
Reference and development
- Public API and configuration
- Architecture and design decisions
- Development and test isolation
- Maintaining and publishing these docs
- Changelog
- Source and issues
These pages describe the code on the default branch. Check the changelog and release tag when using an older gem version.