avrora
avrora
v0.28.0

View Source mix avrora.reg.schema (avrora v0.28.0)

Register either one schema or all schemas in the Avrora.Config.schemas_path directory (or your private client schemas path).

mix avrora.reg.schema [--all] [--name NAME] [--as NEW_NAME] [--module MODULE]

The search of the schemas will be performed under path configured in schemas_path configuration option. One of either option must be given.

Command line options

  • --name - the full name of the schema to register (exclusive with --all)
  • --as - the name which will be used to register schema (i.e subject)
  • --all - register all found schemas
  • --module - the private Avrora client module (i.e MyClient)
  • --appconfig - the app config file name to load from config/ folder (i.e runtime)

The --module option allows to use your private Avrora client module instead of the default Avrora.

The --as option is possible to use only together with --name.

The --name option expects that given schema name will comply to Avrora.Storage.File module rules.

The --appconfig option expects just application config file name without an extension and will load it additionally to default. Note: runtime config doesn't support imports!

For example, if the schema name is io.confluent.Payment it should be stored as <schemas path>/io/confluent/Payment.avsc

Usage 

mix avrora.reg.schema --name io.confluent.Payment
mix avrora.reg.schema --name io.confluent.Payment --as MyCustomName
mix avrora.reg.schema --all --appconfig runtime
mix avrora.reg.schema --all --module MyClient
mix avrora.reg.schema --all