doc update

Litote · May 9, 2021 · f426a90 · f426a90
1 parent 1f9db67
commit f426a90
Show file tree

Hide file tree

Showing 4 changed files with 26 additions and 22 deletions.
diff --git 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.
 <dependency>
   <groupId>org.litote.kmongo</groupId>
   <artifactId>kmongo-id</artifactId>
-  <version>4.2.6</version>
+  <version>4.2.7</version>
 </dependency>
 ```
 
 - 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
@@ -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
@@ -12,19 +12,19 @@ If you don't know, start with the sync driver and add this dependency to your pr
 <dependency>
   <groupId>org.litote.kmongo</groupId>
   <artifactId>kmongo</artifactId>
-  <version>4.2.6</version>
+  <version>4.2.7</version>
 </dependency>
 ```
 
 - or Gradle 
 
 *(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,19 +45,19 @@ For the asynchronous driver, reactive streams style, [Kotlin Coroutines](https:/
 <dependency>
   <groupId>org.litote.kmongo</groupId>
   <artifactId>kmongo-async</artifactId>
-  <version>4.2.6</version>
+  <version>4.2.7</version>
 </dependency>
 ```
 
 - or Gradle
 
 *(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,19 +68,19 @@ implementation 'org.litote.kmongo:kmongo-async:4.2.6'
 <dependency>
   <groupId>org.litote.kmongo</groupId>
   <artifactId>kmongo-coroutine</artifactId>
-  <version>4.2.6</version>
+  <version>4.2.7</version>
 </dependency>
 ```
 
 - or Gradle (Kotlin)
 
 *(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,19 +89,19 @@ implementation 'org.litote.kmongo:kmongo-coroutine:4.2.6'
 <dependency>
   <groupId>org.litote.kmongo</groupId>
   <artifactId>kmongo-reactor</artifactId>
-  <version>4.2.6</version>
+  <version>4.2.7</version>
 </dependency>
 ```
 
 - or Gradle
 
 *(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,19 +112,19 @@ implementation 'org.litote.kmongo:kmongo-reactor:4.2.6'
 <dependency>
   <groupId>org.litote.kmongo</groupId>
   <artifactId>kmongo-rxjava2</artifactId>
-  <version>4.2.6</version>
+  <version>4.2.7</version>
 </dependency>
 ```
 
 - or Gradle
 
 *(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
@@ -112,7 +112,15 @@ col.updateMany(
             setValue(EvaluationAnswer::answers.allPosOp / MyAnswer::alreadyUsed, true)
         )
 
-```    
+```  
+
+Cheat Sheet:
+
+```
+$               = posOp
+$[]             = allPosOp
+$[<identifier>] = filteredPosOp 
+```
 
 #### Map operators