avrora v0.1.0-beta Avrora View Source
Avrora
Getting Started
Avrora is an Elixir library for convenient work with AVRO messages and schemas. It was influenced by AvroTurf Ruby gem.
Add Avrora to your project
To use Avrora with your projects, edit your mix.exs
file and add it as a dependency
def deps do
[
{:avrora, "~> 0.1.0"}
]
end
Configure
The main configuration options is confluent schema registry url and path to
locally stored schemas. Add it in your config/confix.exs
config :avrora,
registry_url: "http://localhost:8081", # default to `nil`
schemas_path: Path.expand("./priv/schemas") # default to `./priv/schemas`
If you will set registry_url
to a non-nil
value, then each time we need to find
out what schema did you mean (except known and cached) it will be first fetched from the
schema registry and in case if it's not found we will do lookup in the local schemas.
In addition schemas which was not found in the registry will be registered on encoding/decoding time.
Start new process manually
Avrora is using in-memory cache to speed up known schemas lookup
{:ok, pid} = Avrora.start_link()
Use in supervision tree
Avrora supports child specs, so you can use it as part of a supervision tree
children = [
Avrora
]
Supervisor.start_link(children, strategy: :one_for_one)
Basic Usage
Let's say you have this Payment
schema stored in a file priv/schemas/io/confluent/Payment.avsc
{
"type": "record",
"name": "Payment",
"namespace": "io.confluent",
"fields": [
{
"name": "id",
"type": "string"
},
{
"name": "amount",
"type": "double"
}
]
}
encode/2
To encode payment message with Payment.avsc
schema
message = %{"id" => "tx-1", "amount" => 15.99}
{:ok, pid} = Avrora.start_link()
{:ok, encoded} = Avrora.encode(message, schema_name: "io.confluent.Payment")
<<8, 116, 120, 45, 49, 123, 20, 174, 71, 225, 250, 47, 64>>
decode/2
To decode payment message with Payment.avsc
schema
message = <<8, 116, 120, 45, 49, 123, 20, 174, 71, 225, 250, 47, 64>>
{:ok, pid} = Avrora.start_link()
{:ok, decoded} = Avrora.decode(message, schema_name: "io.confluent.Payment")
%{"id" => "tx-1", "amount" => 15.99}
Link to this section Summary
Functions
Returns a specification to start this module under a supervisor.
Callback invoked to start the supervisor and during hot code upgrades.
Link to this section Functions
child_spec(init_arg) View Source
Returns a specification to start this module under a supervisor.
See Supervisor
.
decode(payload, opts) View Source
encode(payload, opts) View Source
init(state \\ []) View Source
Callback invoked to start the supervisor and during hot code upgrades.
Developers typically invoke Supervisor.init/2
at the end of their
init callback to return the proper supervision flags.
Callback implementation for Supervisor.init/1
.