Home

Salat is a bi-directional Scala case class serialization library that leverages MongoDB's DBObject (which uses BSON underneath) as its target format. This project is focused on fostering a DWIM and intuitive usage pattern for the end-user's benefit, without sacrificing run time performance.

General overview topics

• The Quick Start guide will help you get up and running in a hurry.
• Design principles that formed the basis of my motivation to write this code.
• Read about components that make up the library and their respective roles.
• What types does Salat support?
  • All about collection support

Feature-specific pages

• Using Salat annotations to customize serialization
• How to use traits and abstract superclasses with Salat
• How to use Salat's built-in DAO support (includes support for child collections)
• All about type hinting
• Salat support for Scala enums
• Do you need a custom Salat context?
• JSON support

Framework support

• Using Salat with Play 2.0 framework

Usage examples are in the specs

We do try to keep the documentation up to date. But you can never go wrong by looking at our specs in salat/salat-core/src/test/scala/com/novus/salat/test/.