Module avro
ballerina/avro Ballerina library
Overview
Avro is an open-source data serialization system that enables efficient binary serialization and deserialization. It allows users to define schemas for structured data, providing better representation and fast serialization/deserialization. Avro's schema evolution capabilities ensure compatibility and flexibility in evolving data systems.
The Ballerina Avro module provides the capability to efficiently serialize and deserialize data using Avro schemas.
Schema
The Schema
instance accepts an Avro schema in string
format. If the provided schema is not valid according to Avro, an error is returned. The client can be used to serialize data into bytes using the defined schema and deserialize the bytes back to the correct data type based on the schema.
A Schema
can be defined using the string
value of an Avro schema as shown below.
avro:Schema schema = check new(string `{"type": "int", "namespace": "example.data" }`);
APIs associated with Avro
- toAvro: Serializes the given data according to the Avro format.
- fromAvro: Deserializes the given Avro encoded message to the given data type.
toAvro
Serializes the given data according to the Avro format.
import ballerina/avro; public function main() returns error? { int value = 5; byte[] serializeData = check schema.toAvro(value); }
fromAvro
Deserializes the given Avro encoded message to the given data type.
import ballerina/avro; public function main() returns error? { byte[] data = // Avro encoded message ; int deserializeData = check schema.fromAvro(data); }