npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@tree-key-cache/avro

v0.1.8

Published

avro tree serializer fot tree-key-cache

Downloads

90

Readme

Actions Status Actions Status Actions Status Test Coverage Maintainability Packages npm version

avro tree serializer fot tree-key-cache

How to Install

npm i @tree-key-cache/avro

How to use it

Instantiate TreeKeyCache passing your schema to getAvroSerializers with the full lookup type path:

const schema: Schema = {
	name: 'Test',
	type: 'record',
	fields: [
		{
			name: 'value',
			type: 'int',
		},
	],
};

target = new TreeKeyCache<{ value: number }, string>(
			map,
			{
				keyLevelNodes: 4,
				...(await getAvroSerializers(schema)),
			},
		);

And that's it! You now have a TreeKeyCache instance that serializes and deserializes using avro, which will save you a lot of space!

Schema evolution and retro-compatibility

Avro doesn't have an out of the box retro-compatibility as we can have, for example, with protobuf, although it does can support it with the use of resolvers.

As long as you're talking about compatible schemas, ie, between two version, there is no incompatible change in any existing field, you can support it by informing the new and old schemas to be considered during parsing.

You can use this feature here too, by informing a list of avro schemas, ordered by the most recent one, like this:

target = new TreeKeyCache<{ value: number }, string>(
			map,
			{
				keyLevelNodes: 4,
				...(await getAvroSerializers(schemaV4, [schemaV3, schemaV2, schemaV1])),
			},
		);

So, the first parameter is always the current schema to be considered, and the second parameter, when informed, must be an array with all the previous used schema you still want to consider, in the order you want to try on. It is recommended that, at some point, older schemas must be removed from the list so you don't have a too long list to be validated, but as long as your data base is all up-to-date, it doesn't really affect parsing performance to have as many as you want, because the serializer will only the most recent one. The only thing a long list may affect in this case is your bootstrap speed.

License

Licensed under MIT.