Lynxus User Documentation
Lynxus User Documentation
Section titled “Lynxus User Documentation”Lynxus documentation is organized by the task or module a user is working with. Start with the quick start, then open only the module-specific guide you need.
Start Here
Section titled “Start Here”- Quick start: add Lynxus, define a Mapper, and configure annotation processing.
- Architecture: understand the compile-time and runtime boundaries.
- AOT usage: compile and verify a generated Mapper as a Native Image.
- Core guides: compilation, mapping, extensions, and standalone runtime.
- Choosing a value or row mapping: choose between standard routing, parameter binders, generated result mapping, and row mappers.
- Choosing an extension: select the narrowest provider, binder, mapper, interceptor, decorator, or raw-JDBC boundary.
- Standalone JDBC: assemble generated Mappers without Spring.
Integrations
Section titled “Integrations”- Spring guides: Spring-owned assembly and transaction participation.
- Spring Boot: register Mapper packages and participate in Spring transactions.
Migration
Section titled “Migration”- Migration guides: compatibility-first migration entry point.
- Migrating from MyBatis: migrate supported Mapper declarations and replace unsupported runtime features explicitly.
Normative behavior is defined in the reference documentation. Active implementation work is tracked in GitHub Issues rather than user guides.