Skip to content

Commit 3f41b40

Browse files
authored
Merge pull request #137 from driessamyn/1.5-docs-cleanup
docs: update docs for 1.5 release.
2 parents 40147a3 + 67fa9ac commit 3f41b40

1 file changed

Lines changed: 7 additions & 4 deletions

File tree

README.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -165,6 +165,8 @@ You can query and map results just as you would with a Kotlin data class:
165165
val heroes: List<SuperHeroRecord> = connection.query<SuperHeroRecord>("SELECT * FROM super_heroes")
166166
```
167167

168+
Additional Java examples can be found in the [Kapper-Example](https://github.com/driessamyn/kapper-examples#java-examples)
169+
168170
#### Handling Default Values, Nullables, and Extra Fields
169171

170172
Kapper's auto-mapping is flexible:
@@ -451,7 +453,8 @@ Kapper is designed to be fast and lightweight, with performance comparable to ra
451453
This repository contains a [benchmark suite](./benchmark) that compares Kapper's performance against other popular ORMs like Hibernate and Ktorm.
452454
The benchmark suite is designed to be extensible and can be used to add new benchmarks or modify existing ones.
453455
Two Kapper benchmarks are included: with auto-mapping and with a custom mapper.
454-
In Kapper 1.3, the _"cost"_ of auto-mapping is in the small single digit microsecond range.
456+
In the current version of Kapper the _"cost"_ of auto-mapping in the small single digit _microsecond_ range.
457+
Manual mapping is always the fastest and recommended for performance-critical applications or queries.
455458

456459
More details can be found [here](./benchmark/README.md), and the benchmark results are published in [kapper-benchmark-results](https://github.com/driessamyn/kapper-benchmark-results/).
457460

@@ -473,15 +476,15 @@ Items will be ticked off as they are implemented.
473476
- [x] Add co-routine support.
474477
- [x] Add flow support.
475478
- [x] Add MS SQL Server, Oracle and SQLite integration tests.
476-
- [ ] Support auto-mapping for Java records.
479+
- [x] Support auto-mapping for Java records.
480+
- [x] Tests & examples in other JVM languages.
477481
- [ ] Cache query parsing.
478482
- [ ] Custom SQL type conversion.
479483
- [ ] Improve support for date/time conversion.
480484
- [ ] Support DTO argument for `execute`.
481485
- [ ] Add support for non-blocking JDBC drivers.
482486
- [ ] Bulk operations support
483-
- [ ] Improve user documentation.
484-
- [ ] Tests & examples in other JVM languages.
487+
- [ ] Improve user documentation / docs website.
485488

486489
Anything else you think is missing, or you want to be prioritised, please [open an issue](kapper/issues) or submit a pull request.
487490

0 commit comments

Comments
 (0)