sbt plugin for generating Scala case classes from Apache Avro schemas, datafiles, and protocols.

Add the following lines to the file myproject/project/plugins.sbt in your project directory:

addSbtPlugin("com.julianpeeters" % "sbt-avrohugger" % "0.8.0")

To activate the plugin, import its settings by adding one of the following lines to your myproject/build.sbt file:

To get the 'generate' task for generating standard Scala Case Classes use:

sbtavrohugger.SbtAvrohugger.avroSettings

To get the generate-specific task for generating Scala Case Classes that are compatible with the Avro Specific API, use:

sbtavrohugger.SbtAvrohugger.specificAvroSettings

To get the generate-scavro task for generating Scala Case Class wrapper classes (Java generated classes supplied separately, or just use the Scavro plugin to do both) for use with Scavro, use:

sbtavrohugger.SbtAvrohugger.scavroSettings

All settings and tasks are in the avro scope. E.g., to execute the generate task directly, just run avro:generate.

Settings can be overridden by adding lines to myproject/build.sbt:

(scalaSource in avroConfig) := new java.io.File("myscalaSource")

scala-custom-types and scala-custom-namespace require additional imports (I'm not sure why these aren't picked up with the other settings, anybody know why we have to import them separately?):

import sbtavrohugger.AvrohuggerSettings.{ avroScalaCustomTypes, avroScalaCustomNamespace }

(avroScalaCustomTypes in avroConfig) := Map("array"->classOf[Array[_]])

(avroScalaCustomNamespace in avroConfig) := Map("example"->"overridden")

Each task is automatically executed every time the project is compiled.*

• as of Intellij IDEA 14.1.4, and possibly for other IDEs, the task must be run manually from the integrated Terminal: avro:generate.

Supports generating case classes with arbitrary fields of the following datatypes:

• INT -> Int
• LONG -> Long
• FLOAT -> Float
• DOUBLE -> Double
• STRING -> String
• BOOLEAN -> Boolean
• NULL -> Null
• MAP -> Map
• ENUM -> generate: scala.Enumeration, generate-specific: Java Enum
• BYTES -> Array[Byte]
• FIXED -> //TODO
• ARRAY -> List (generate-scavro: Array). To reassign, please see Settings above.
• UNION -> Option
• RECORD -> case class

• support for more avro datatypes
• more codegen situations, e.g. exploding Spark Rows?

sbt-avrohugger is based on sbt-avro by Juan Manuel Caicedo, and depends on avrohugger.

• Marius Soutier
• Brennan Saeta
• Daniel Lundin
• Vince Tse
• Jerome Wacongne
• Ryan Koval