View Source Needle.ULID (Bonfire v0.9.10-classic-beta.169)

A ULID datatype and some postgres support for ULID operations (min and max functions and aggregates)

Originally forked from ecto-ulid but the internals have been replaced with a dependency on ex_ulid

Installation

{:needle_ulid, git: "https://github.com/bonfire-networks/needle_ulid", branch: "main"}

Copyright and License

Licensed under the terms of the MIT License.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Summary

Functions

bingenerate(timestamp \\ System.system_time(:millisecond))

Generates a binary ULID.

bintimestamp(arg)

cast(value)

Casts a 26-byte encoded string to ULID or a 16-byte binary unchanged

cast!(value)

Same as cast/1 but raises Ecto.CastError on invalid arguments.

decode(bytes)

dump(encoded)

Converts a Crockford Base32 encoded ULID into a binary.

dump!(encoded)

embed_as(_)

Callback implementation for Ecto.Type.embed_as/1.

encode(bytes, leading_zeroes? \\ true)

encoded_randomness(arg)

Returns the randomness portion of the encoded ulid

encoded_timestamp(arg)

Returns the timestamp portion of the encoded ulid

equal?(term1, term2)

Callback implementation for Ecto.Type.equal?/2.

generate(timestamp \\ System.system_time(:millisecond))

Generates a Crockford Base32 encoded ULID.

load(bytes)

Converts a binary ULID into a Crockford Base32 encoded string.

synthesise!(x)

translates alphanumerics into a sentinel ulid value

timestamp(encoded)

Returns the timestamp of an encoded or unencoded ULID

type()

The underlying schema type.

valid?(arg1)