Spindle

Spindle is a library and code generation tool developed at Foursquare for representing data stored in MongoDB. It’s based heavily on Apache Thrift, so understanding some Thrift fundamentals is important. However, most of Spindle is custom Scala code generation developed to work with Thrift models.

Contents:

• Thrift
  • Data model
  • Interface definition language (IDL)
  • Serialization formats
• Records
  • Creating a record
  • Reading/writing records
  • Record interface methods
  • Other methods
  • Mutable trait
  • Raw class
  • Priming
  • Proxies
  • Reflection
  • Field descriptors
• Custom types
  • Enhanced types
  • Bitfields
  • Type-safe IDs
• Enums
  • Enum value methods
  • Companion object methods
  • Matching and unknown values
  • Examples
• Working with MongoDB
  • Annotations
  • Rogue queries

Indices and tables

• Index
• Module Index
• Search Page