jwarkentin/flaky

Module for generating short, fixed-length, sequential UUIDs ideal for indexing in various tree based structures

Maintainers

Details

github.com/jwarkentin/flaky

Source

Issues

Installs: 21 869

Dependents: 1

Suggesters: 0

Security: 0

Stars: 5

Watchers: 2

Forks: 1

Open Issues: 2

Language:JavaScript

v0.0.9 2016-12-20 00:07 UTC

Requires

  • ext-gmp: *

MIT b88dc1c394dba47bbaf3a7d7f7967cf28af6b7c4

  • Justin Warkentin

uuidflakeflakeid

This package is not auto-updated.

Last update: 2024-12-21 19:53:00 UTC

README

Node.js module for generating short, fixed-length, sequential UUIDs ideal for indexing in various tree based structures. It creates IDs without coordination between servers/instances (even multiple instances on the same machine) that can be used confidently without collisions, while still being mostly sequential and always ascending. It is also resistant to potentially large backward time jumps of the system clock (the amount of tolerance depends on how long it takes you to generate 100,000 ids basically).

All Flaky IDs are created with a full 64 bits of data. Flaky also provides a lot of flexibility in terms of what base encoding you want to use and what character set to encode with. By default it will do base 64 encoding and use the standard character set.

Motivation

I wanted a UUID generator that was designed for use with common database indexing techniques to provide the best performance for indexing and lookups, while also being efficient with space (i.e. short IDs). This is designed based on my understanding of how elasticsearch BlockTree indexing works as explained by Mike McCandless. It is loosely based on the concept of flake IDs. In my own benchmarks these IDs have proven to be faster and more efficient than the standard IDs assigned by Elasticsearch. It should work well with MySQL's InnoDB index format as well (though I haven't tested it).

To learn more about flake IDs see:

More specific to Elasticsearch, see:

API