Packages

  • package root
    Definition Classes
    root
  • package reactivemongo
    Definition Classes
    root
  • package bson
    Definition Classes
    reactivemongo
  • object Macros

    Macros for generating BSONReader and BSONWriter implementations for case at compile time.

    Macros for generating BSONReader and BSONWriter implementations for case at compile time. Invoking these macros is equivalent to writing anonymous class implementations by hand.

    import reactivemongo.bson.Macros

case class Person(name: String, surname: String)
implicit val personHandler = Macros.handler[Person]
    Definition Classes
    bson
    See also

    Macros.Options for specific options

  • object Annotations

    Annotations to use on case classes that are being processed by macros.

    Annotations to use on case classes that are being processed by macros.

    Definition Classes
    Macros
  • Flatten
  • Ignore
  • Key
  • NoneAsNull

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

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()
Linear Supertypes
Serializable, Product, Equals, StaticAnnotation, Annotation, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Key
  2. Serializable
  3. Product
  4. Equals
  5. StaticAnnotation
  6. Annotation
  7. AnyRef
  8. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new Key(key: String)

    key

    the desired key to use in BSON

Value Members

  1. val key: String
  2. def productElementNames: Iterator[String]
    Definition Classes
    Product