From f426a9063dc658ee249a8d9be566473d3f14ff91 Mon Sep 17 00:00:00 2001 From: Julien Buret Date: Sun, 9 May 2021 19:41:59 +0200 Subject: [PATCH] doc update --- kmongo-kdoc/docs/object-mapping.md | 4 ++-- kmongo-kdoc/docs/performance.md | 4 ---- kmongo-kdoc/docs/quick-start.md | 30 +++++++++++++++--------------- kmongo-kdoc/docs/typed-queries.md | 10 +++++++++- 4 files changed, 26 insertions(+), 22 deletions(-) diff --git a/kmongo-kdoc/docs/object-mapping.md b/kmongo-kdoc/docs/object-mapping.md index 4ee99673..77575df6 100644 --- a/kmongo-kdoc/docs/object-mapping.md +++ b/kmongo-kdoc/docs/object-mapping.md @@ -53,14 +53,14 @@ You just have to add the ```kmongo-id``` dependency in the frontend to compile. org.litote.kmongo kmongo-id - 4.2.6 + 4.2.7 ``` - or Gradle ``` -compile 'org.litote.kmongo:kmongo-id:4.2.6' +compile 'org.litote.kmongo:kmongo-id:4.2.7' ``` #### Id <> Json Jackson serialization diff --git a/kmongo-kdoc/docs/performance.md b/kmongo-kdoc/docs/performance.md index fbba6fa2..f73c81be 100644 --- a/kmongo-kdoc/docs/performance.md +++ b/kmongo-kdoc/docs/performance.md @@ -35,10 +35,6 @@ As you can see, the org.bson.Document mapping (basically a Map) outperforms Jackson & Native mapping but kotlinx.Serialization is the best - this is expected: no reflection is involved for kotlinx.Serialization. -Note: during this benchmark, we have found a [~15% perf improvement](https://github.com/michel-kraemer/bson4jackson/pull/81) -for jackson but the fix is not included in the last released version of bson4jackson. However, even with this improvement, -the ranking stays the same. - Is it possible to improve Jackson & native mapping performance? Of course! You can write a custom Jackson deserializer or a custom codec for the `FriendWithBuddies` class. Then you avoid reflection in both case, and you speed up your deserialization. diff --git a/kmongo-kdoc/docs/quick-start.md b/kmongo-kdoc/docs/quick-start.md index 7650e03e..ab1d8d6a 100644 --- a/kmongo-kdoc/docs/quick-start.md +++ b/kmongo-kdoc/docs/quick-start.md @@ -12,7 +12,7 @@ If you don't know, start with the sync driver and add this dependency to your pr org.litote.kmongo kmongo - 4.2.6 + 4.2.7 ``` @@ -20,11 +20,11 @@ If you don't know, start with the sync driver and add this dependency to your pr *(Kotlin)* ```kotlin -implementation("org.litote.kmongo:kmongo:4.2.6") +implementation("org.litote.kmongo:kmongo:4.2.7") ``` *(Groovy)* ```groovy -implementation 'org.litote.kmongo:kmongo:4.2.6' +implementation 'org.litote.kmongo:kmongo:4.2.7' ``` > Starting from 4.0, minimum supported jvm is now 1.8 (was 1.6). @@ -45,7 +45,7 @@ For the asynchronous driver, reactive streams style, [Kotlin Coroutines](https:/ org.litote.kmongo kmongo-async - 4.2.6 + 4.2.7 ``` @@ -53,11 +53,11 @@ For the asynchronous driver, reactive streams style, [Kotlin Coroutines](https:/ *(Kotlin)* ```kotlin -implementation("org.litote.kmongo:kmongo-async:4.2.6") +implementation("org.litote.kmongo:kmongo-async:4.2.7") ``` *(Groovy)* ```groovy -implementation 'org.litote.kmongo:kmongo-async:4.2.6' +implementation 'org.litote.kmongo:kmongo-async:4.2.7' ``` #### Kotlin Coroutines @@ -68,7 +68,7 @@ implementation 'org.litote.kmongo:kmongo-async:4.2.6' org.litote.kmongo kmongo-coroutine - 4.2.6 + 4.2.7 ``` @@ -76,11 +76,11 @@ implementation 'org.litote.kmongo:kmongo-async:4.2.6' *(Kotlin)* ```kotlin -implementation("org.litote.kmongo:kmongo-coroutine:4.2.6") +implementation("org.litote.kmongo:kmongo-coroutine:4.2.7") ``` *(Groovy)* ```groovy -implementation 'org.litote.kmongo:kmongo-coroutine:4.2.6' +implementation 'org.litote.kmongo:kmongo-coroutine:4.2.7' ``` #### Reactor @@ -89,7 +89,7 @@ implementation 'org.litote.kmongo:kmongo-coroutine:4.2.6' org.litote.kmongo kmongo-reactor - 4.2.6 + 4.2.7 ``` @@ -97,11 +97,11 @@ implementation 'org.litote.kmongo:kmongo-coroutine:4.2.6' *(Kotlin)* ```kotlin -implementation("org.litote.kmongo:kmongo-reactor:4.2.6") +implementation("org.litote.kmongo:kmongo-reactor:4.2.7") ``` *(Groovy)* ```groovy -implementation 'org.litote.kmongo:kmongo-reactor:4.2.6' +implementation 'org.litote.kmongo:kmongo-reactor:4.2.7' ``` #### RxJava2 @@ -112,7 +112,7 @@ implementation 'org.litote.kmongo:kmongo-reactor:4.2.6' org.litote.kmongo kmongo-rxjava2 - 4.2.6 + 4.2.7 ``` @@ -120,11 +120,11 @@ implementation 'org.litote.kmongo:kmongo-reactor:4.2.6' *(Kotlin)* ```kotlin -implementation("org.litote.kmongo:kmongo-rxjava2:4.2.6") +implementation("org.litote.kmongo:kmongo-rxjava2:4.2.7") ``` *(Groovy)* ```groovy -implementation 'org.litote.kmongo:kmongo-rxjava2:4.2.6' +implementation 'org.litote.kmongo:kmongo-rxjava2:4.2.7' ``` ## Object Mapping Engine diff --git a/kmongo-kdoc/docs/typed-queries.md b/kmongo-kdoc/docs/typed-queries.md index 920b9f13..b21a7325 100644 --- a/kmongo-kdoc/docs/typed-queries.md +++ b/kmongo-kdoc/docs/typed-queries.md @@ -112,7 +112,15 @@ col.updateMany( setValue(EvaluationAnswer::answers.allPosOp / MyAnswer::alreadyUsed, true) ) -``` +``` + +Cheat Sheet: + +``` +$ = posOp +$[] = allPosOp +$[] = filteredPosOp +``` #### Map operators