sbt-avro is a plugin for sbt-0.13.0 (and 0.12.1) for generating the Java sources for Avro schemas and protocols.
Add the plugin according to the sbt documentation.
For instance, add the following lines to the file hello/project/build.sbt in your
project directory:
resolvers += "sbt-plugin-releases" at "http://repo.scala-sbt.org/scalasbt/sbt-plugin-releases"
addSbtPlugin("com.cavorite" % "sbt-avro" % "0.3.2")
To activate the plugin, import its settings by adding the following lines to
your hello/build.sbt file:
seq( sbtavro.SbtAvro.avroSettings : _*)
All settings and tasks are in the avro scope. If you want to execute the
generate task directly, just run avro:generate.
| Name | Name in shell | Default | Description |
|---|---|---|---|
| sourceDirectory | source-directory |
src/main/avro |
Path containing *.avsc, *.avdl and *.avpr files. |
| javaSource | java-source |
$sourceManaged/compiled_avro |
Path for the generated *.java files. |
| version | version |
1.7.3 |
Version of the Avro library should be used. A dependency to "org.apache.avro" % "avro-compiler" % "$version" is automatically added to libraryDependencies. |
| stringType | string-type |
CharSequence |
Java type for string elements. Possible values: CharSequence (by default), Utf8 and String. |
For example, if you want to change the Java type of the string elements in
the schema, you can add the following lines to your build.sbt file:
seq( sbtavro.SbtAvro.avroSettings : _*)
(stringType in avroConfig) := "String"
| Name | Name in shell | Description |
|---|---|---|
| generate | generate | Compiles the Avro files. This task is automatically executed everytime the project is compiled. |
This program is distributed under the BSD license. See the file LICENSE for
more details.
sbt-avro is maintained by Juan Manuel Caicedo. I wrote it based on sbt-protobuf (even this README file!). This is my first attempt to write an sbt plugin, so feel free to send your comments and bug reports.