File tree Expand file tree Collapse file tree 1 file changed +4
-2
lines changed
Expand file tree Collapse file tree 1 file changed +4
-2
lines changed Original file line number Diff line number Diff line change @@ -113,13 +113,15 @@ listTask.foreach(foundEntities => println(s"Found entities: $foundEntities"))
113113A MongoDB entity may be:
114114
115115* a case class
116- * a sealed trait/class with ` @flatten ` annotation (see ` GenCodec ` 's [ flat format] ( GenCodec.md#flat-format ) for more
116+ * a sealed trait/class with ` @flatten ` annotation (see ` GenCodec ` 's [ flat format] ( GenCodec.md#flat-sealed-hierarchy- format ) for more
117117 details)
118118
119119Also, every MongoDB entity must have a companion object that extends ` MongoEntityCompanion ` . This causes an instance
120120of ` MongoEntityMeta ` to be materialized for the entity class. This typeclass internally materializes a ` GenObjectCodec `
121121(for serialization) and captures the structure of the entity into metadata available in runtime.
122122
123+ See [ ` GenCodec ` ] ( GenCodec.md ) for more details on serialization used by typed MongoDB API.
124+
123125### ID management
124126
125127There are two flavors of MongoDB entity representations. They differ in how they manage document IDs (the ` _id ` field).
@@ -165,7 +167,7 @@ object User extends MongoEntityCompanion[User]
165167
166168### Field types
167169
168- Any type that has a ` GenCodec ` instance will be accepted as a field type in MongoDB entity. However, the MongoDB API is
170+ Any type that has a [ ` GenCodec ` ] ( GenCodec.md ) instance will be accepted as a field type in MongoDB entity. However, the MongoDB API is
169171additionally aware of internal structure of some types, including:
170172
171173* [ embedded documents] ( #embedded-document-types ) - serialized into BSON documents
You can’t perform that action at this time.
0 commit comments