sbt plugin for generating the Java sources for Apache Avro schemas and protocols.
Scala
Latest commit 2317df1 Feb 5, 2017 @benmccann benmccann committed on GitHub Merge pull request #34 from timchan-lumoslabs/master
fix typo in artifact name

README.rst

sbt-avro

Overview

sbt-avro is a plugin for sbt-0.13 for generating the Java sources for Avro schemas and protocols. It tries to be clever in compiling schemas with referenced types before dependent ones.

Usage

Install the plugin

Add the plugin according to the sbt documentation.

For instance, add the following lines to the file project/plugins.sbt in your project directory:

addSbtPlugin("com.cavorite" % "sbt-avro-1-7" % "1.1.2")

Scope

All settings and tasks are in the avro scope. If you want to execute the generate task directly, just run avro:generate.

Settings

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.

Example

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:

(stringType in avroConfig) := "String"

Tasks

Name Name in shell Description
generate generate Compiles the Avro files. This task is automatically executed everytime the project is compiled.

License

This program is distributed under the BSD license. See the file LICENSE for more details.

Credits

sbt-avro is maintained by the sbt Community. The inial code was based on a similar plugin: sbt-protobuf. Feel free to send your comments and bug reports.

Contributors