Home

This page is meant to provide a brief overview of avsc's API:

• What is a Type?
• How do I get a Type?
• What about Avro files?
• Next steps

What is a Type?

Each Avro type maps to a corresponding JavaScript Type:

• int maps to IntType.
• arrays map to ArrayTypes.
• records map to RecordTypes.
• etc.

An instance of a Type knows how to encode and decode its corresponding objects. For example the StringType knows how to handle JavaScript strings:

var stringType = new avsc.types.StringType();
var buf = stringType.toBuffer('Hi'); // Buffer containing 'Hi''s Avro encoding.
var str = stringType.fromBuffer(buf); // === 'Hi'

The toBuffer and fromBuffer methods above are convenience functions which encode and decode a single object into/from a standalone buffer.

Each type also provides other methods which can be useful. Here are a few (refer to the API documentation for the full list):

• JSON-encoding:

  var jsonString = type.toString('Hi'); // === '"Hi"'
  var str = type.fromString(jsonString); // === 'Hi'

• Validity checks:

  var b1 = stringType.isValid('hello'); // === true ('hello' is a valid string.)
  var b2 = stringType.isValid(-2); // === false (-2 is not.)

• Random object generation:

  var s = stringType.random(); // A random string.

How do I get a Type?

It is possible to instantiate types directly by calling their constructors (available in the avsc.types namespace; this is what we used earlier), but in the vast majority of use-cases they will be automatically generated by parsing an existing schema.

avsc exposes a parse method to do the heavy lifting:

// Equivalent to what we did earlier.
var stringType = avsc.parse({type: 'string'});

// A slightly more complex type.
var mapType = avsc.parse({type: 'map', values: 'long'});

// The sky is the limit!
var personType = avsc.parse({
  name: 'Person',
  type: 'record',
  fields: [
    {name: 'name', type: 'string'},
    {name: 'phone', type: ['null', 'string'], default: null},
    {name: 'address', type: {
      name: 'Address',
      type: 'record',
      fields: [
        {name: 'city', type: 'string'},
        {name: 'zip', type: 'int'}
      ]
    }}
  ]
});

Of course, all the type methods are available. For example:

personType.isValid({
  name: 'Ann',
  phone: null,
  address: {city: 'Cambridge', zip: 02139}
}); // === true

personType.isValid({
  name: 'Bob',
  phone: {string: '617-000-1234'},
  address: {city: 'Boston'}
}); // === false (Missing the zip code.)

Since schemas are often stored in separate files, passing a path to parse will attempt to load a JSON-serialized schema from there:

var couponType = avsc.parse('./Coupon.avsc');

For advanced use-cases, parse also has a few options which are detailed the API documentation.

What about Avro files?

Avro files (meaning Avro object container files) hold serialized Avro records along with their schema. Reading them is as simple as calling createFileDecoder:

var personStream = avsc.createFileDecoder('./persons.avro');

personStream is a readable stream of decoded records, which we can for example use as follows:

personStream.on('data', function (person) {
  if (person.address.city === 'San Francisco') {
    doSomethingWith(person);
  }
});

In case we need the records' type or the file's codec, they are available by listening to the 'metadata' event:

personStream.on('metadata', function (type, codec) { /* Something useful. */ });

To access a file's header synchronously, there also exists an extractFileHeader method:

var header = avsc.extractFileHeader('persons.avro');

Writing to an Avro container file is possible using createFileEncoder:

var encoder = avsc.createFileEncoder('./processed.avro', type);

Next steps

The API documentation provides a comprehensive list of available functions and their options. The Advanced usage section goes through a few examples to show how the API can be used.