Type Members

1.  case class Flatten() extends Annotation with StaticAnnotation with Product with Serializable

   Indicates that if a property is represented as a document itself, the document fields are directly included in top document, rather than nesting it.

   Indicates that if a property is represented as a document itself, the document fields are directly included in top document, rather than nesting it.

   import reactivemongo.bson.Macros.Annotations.Flatten
   
   case class Range(start: Int, end: Int)
   
   case class LabelledRange(
     name: String,
     @Flatten range: Range)
   
   val flattened = reactivemongo.bson.BSONDocument(
     "name" -> "foo", "start" -> 0, "end" -> 1)
   
   // Rather than:
   // BSONDocument("name" -> "foo", "range" -> BSONDocument(
   //   "start" -> 0, "end" -> 1))

   Annotations

   @param()

2.  case class Ignore() extends Annotation with StaticAnnotation with Product with Serializable

   Ignores a field

   Ignores a field

   Annotations

   @param()

3.  case class Key(key: String) extends Annotation with StaticAnnotation with Product with Serializable

   Specify a key different from field name in your case class.

   Specify a key different from field name in your case class. Convenient to use when you'd like to leverage mongo's _id index but don't want to actually use _id in your code.

   import reactivemongo.bson.Macros.Annotations.Key
   
   case class Website(@Key("_id") url: String)

   Generated handler will map the url field in your code to _id field in BSON

   key

   the desired key to use in BSON

   Annotations

   @param()

4.  case class NoneAsNull() extends Annotation with StaticAnnotation with Product with Serializable

   Indicates that if an Option property is empty, it will be represented by BSONNull rather than being omitted.

   Indicates that if an Option property is empty, it will be represented by BSONNull rather than being omitted.

   import reactivemongo.bson.Macros.Annotations.NoneAsNull
   
   case class Foo(
     title: String,
     @NoneAsNull description: Option[String])

   Annotations

   @param()