A ULID is a "Universally Unique Lexicographically-sortable Identifier." In its string form, a ULID is a compact, URL-friendly, Base32, unique ID string that encodes its time of creation and sorts according the time value it encodes. Crockford's Base32 alphabet is used in encoding because it's easy to sort, unambiguous in its choice of letters, and like most Base32 encoding schemes is case-insensitive.
This is a Ruby library for generating and parsing ULID values. This code is based on the original concept presented at https://github.com/alizain/ulid and in part based on code from the C# and Go projects at https://github.com/RobThree/NUlid and https://github.com/oklog/ulid respectively.
NOTE: while the ULID values generated are compatible with the original Ruby ULID library located at https://github.com/rafaelsales/ulid, this library is not code-compatible and it provides additional features. While working on Adafruit IO, we needed to generate time-based, lexicographically sortable IDs and we needed to be able to get the time value back out. At one point we used Cassandra and its native Time UUID type, but that didn't translate well to DynamoDB and its use of sort keys. ULIDs were found to be an acceptable choice and it was easier to just rebuild the existing functionality of rafaelsales/ulid while adding parsing. This tool may not be useful for anyone else but it's working for us in production at https://io.adafruit.com.
A ULID string looks like this:
require 'ulid'
ULID.generate #=> "0DHWZV7PGEAFYDYH04X7Y468GQ"The two parts of a ULID are Timestamp and Entropy.
0DHWZV7PGE AFYDYH04X7Y468GQ
|----------| |----------------|
Timestamp Entropy
48bits 80bits
- Encoded in first 48 bits of ULID. In Base32 it's the first 10 ASCII characters.
- UNIX-time with a precision of milliseconds.
- Won't run out of space till the year 10895 AD.
- Encoded in last 80 bits of ULID. In Base32 it's the last 16 ASCII characters.
- Should use cryptographically secure source of randomness (this library uses the Ruby Standard Library's
SecureRandomclass) - Unlikely to duplicate even with millions of IDs at the same millisecond
The left-most character must be sorted first, and the right-most character sorted last (lexical order). The default ASCII character set must be used. Within the same millisecond, sort order is not guaranteed.
Uniquely identifying records and ordering them by time, with precision of 1 millisecond in a distributed system. Unlike time-based UUIDs, ULIDs are lexically sortable. They're also shorter, which is nice.
We're using it in Adafruit IO to generate time-based IDs for an Amazon DynamoDB table. We're using ULIDs for the sort key (part of the table's composite primary key) on a table that's holding time-series data, which means that because DynamoDB sorts lexically and we only care about the data in time order, ULIDs give us unique, mostly unguessable ID, time-ordered data without any secondary indexes.
Add this line to your application's Gemfile:
gem 'ulid-ruby', require: 'ulid'And then execute:
$ bundle
Or install it yourself as:
$ gem install ulid-ruby
And require from your project with:
require 'rubygems'
require 'ulid'After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.
To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.
Bug reports and pull requests are welcome on GitHub at https://github.com/abachman/ulid-ruby. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.
The gem is available as open source under the terms of the MIT License.
- handle floating point precision issue described in #4 and #5
- update development dependencies: Ruby to 3.1.0, bundler to > 2
- fixes incorrect string packing / unpacking which caused incompatible ULID generation and parsing. This is a critical bug and any ULIDs generated with version < 1.0.0 will sort incorrectly.