avro-schema:avro-package

Full name:

org.spf4j:maven-avro-schema-plugin:8.9.3-SNAPSHOT:avro-package

Description:

mojo that packages a schema package and avro sources and attaches them as separate artifacts.

Attributes:

  • Requires a Maven project to be executed.
  • Binds by default to the lifecycle phase: package.

Optional Parameters

Name Type Since Description
<generatedAvscTarget> File - the destination for the generated avro schema json files (will be published along with the java code).
Default value is: ${project.build.directory}/generated-sources/avsc.
<generatedJavaTarget> File - the destination for the java generated files.
Default value is: ${project.build.directory}/generated-sources/avro.
<packageAvsc> boolean - package avsc artifact (a zip/jar containing avro schemas.)
Default value is: true.
<packageAvscSources> boolean - package avsc sources artifact (a zip/jar containing avro sources (avdl, avprr, avsc).)
Default value is: true.
<schemaArtifactClassifier> String - the schema artifact classifier.
Default value is: avsc.
<schemaArtifactExtension> String - the schema artifact extension.
Default value is: jar.
<sourceDirectory> File - The source directory of avro files. This directory is added to the classpath at schema compiling time. All files can therefore be referenced as classpath resources following the directory structure under the source directory.
Default value is: ${basedir}/src/main/avro.
<target> File - the target folder.
Default value is: ${project.build.directory}.
<useSchemaReferencesForAvsc> boolean - This option will use schema references when writing schemas that depend of schemas from other projects, instead of baking them in. by default (false) all schema references will be inlined.
Default value is: false.

Parameter Details

<generatedAvscTarget>

the destination for the generated avro schema json files (will be published along with the java code).
  • Type: java.io.File
  • Required: No
  • Default: ${project.build.directory}/generated-sources/avsc

<generatedJavaTarget>

the destination for the java generated files.
  • Type: java.io.File
  • Required: No
  • Default: ${project.build.directory}/generated-sources/avro

<packageAvsc>

package avsc artifact (a zip/jar containing avro schemas.)
  • Type: boolean
  • Required: No
  • Default: true

<packageAvscSources>

package avsc sources artifact (a zip/jar containing avro sources (avdl, avprr, avsc).)
  • Type: boolean
  • Required: No
  • Default: true

<schemaArtifactClassifier>

the schema artifact classifier.
  • Type: java.lang.String
  • Required: No
  • Default: avsc

<schemaArtifactExtension>

the schema artifact extension.
  • Type: java.lang.String
  • Required: No
  • Default: jar

<sourceDirectory>

The source directory of avro files. This directory is added to the classpath at schema compiling time. All files can therefore be referenced as classpath resources following the directory structure under the source directory.
  • Type: java.io.File
  • Required: No
  • Default: ${basedir}/src/main/avro

<target>

the target folder.
  • Type: java.io.File
  • Required: No
  • Default: ${project.build.directory}

<useSchemaReferencesForAvsc>

This option will use schema references when writing schemas that depend of schemas from other projects, instead of baking them in. by default (false) all schema references will be inlined.
  • Type: boolean
  • Required: No
  • Default: false