README
¶
UID (Unique ID) 
THis package generates unique identifying strings. Largest attention is paid on human friendly unique identifiers (dated digits).
Installation
go get -u https://github.com/gouniverse/uid
Usage
// HumanUid generates a UUID (32 digits) Format: YYYYMMDD-HHMM-SSMM-MMMMNNNRRRRRRRRR
humanUID := uid.HumanUid()
// NanoUid generates a UID (23 digits) Format: YYYYMMDD-HHMMSS-MMMMMM-NNN
humanUID := uid.NanoUid()
// MicroUid generates a UID (20 digits) Format: YYYYMMDD-HHMMSS-MMMMMM
microUID := uid.MicroUid()
// SecUid generates UID (14 digits) Format: YYYYMMDD-HHMMSS
secondsUID := uid.SecUid()
Supported UID Types
It supports several types of unique identifiers.
The type you want to use will usually depends on two considerations:
- How random you want it to be? The longer the identifier, the more the chances of collision reduce
- How long you want the identifier to be? The longer the identifier, reduces the readability, as well as the storage space to store it.
For most of the user cases a Micro UUID (20 chars) should be fine. A human UUID (32 chars) should be avoided where a human is involved as too "mind bogging" to work with.
-
Human UUID (32 digits)
Format: YYYYMMDD-HHMM-SSMM-MMMMNNNRRRRRRRRR
2017111908492665991498485465 (with dashes: 20171119-0849-2665-991498485465)
-
Nano UID (23 digits)
Format: YYYYMMDD-HHMMSS-MMMMMM-NNN
Examples:
20171119084926659914984 (with dashes: 20171119-084926-659914-984)
-
Micro UID (20 digits)
Format: YYYYMMDD-HHMMSS-MMMMMM
Examples:
20171119084926659914 (with dashes: 20171119-084926-659914)
-
Seconds UID (14 digits)
Format: YYYYMMDD-HHMMSS
Examples:
20171119084926 (with dashes: 20171119-084926)
-
Timestamp (10 digits) Unit timestamp, seconds precision
Format: 1234567890
Examples:
1704524414
-
TimestampMicro (16 digits) Unit timestamp, microseconds precision
Format: 1234567890123456
Examples:
1704524414548721
-
TimestampNano (19 digits) Unit timestamp, nanoseconds precision
Format: 1234567890123456789
Examples:
1704524414548721308
-
Uuid (32 characters) Random V4 UUID. UUID (Universally Unique IDentifier), also known as GUID (Globally Unique IDentifier)
Format: abcdef1234567890abcdef1234567890
Examples:
459e2999bd071151a23d643da42c2cc2
Change Log
2024.01.06 - Added Timestamp and Uuid functions 2021.12.19 - Master branch changed to main 2021.12.19 - Added tests
Similar Packages
- https://github.com/jaevor/go-nanoid (random 21 characters)
- https://github.com/zheng-ji/goSnowFlake (timestamp-workerid-sequence)
- https://github.com/damdo/randid (random IDs)
- https://github.com/matthewmueller/uid.go (shorcodes)
- https://github.com/aohorodnyk/uid (random IDs)
- https://github.com/google/uuid (UUIDs)
- https://github.com/oklog/ulid (???)
- https://github.com/chilts/sid (serial IDs)
- https://datatracker.ietf.org/doc/html/draft-ietf-uuidrev-rfc4122bis (GUID 6?)
Documentation
¶
Index ¶
- func HumanUid() string
- func MicroUid() string
- func NanoUid() string
- func SecUid() string
- func Timestamp() string
- func TimestampMicro() string
- func TimestampNano() string
- func Uuid() string
- func UuidFormatted() string
- func UuidV1() string
- func UuidV1Formatted() string
- func UuidV3(namespace string, data []byte) (string, error)
- func UuidV3Formatted(namespace string, data []byte) (string, error)
- func UuidV4() string
- func UuidV4Formatted() string
- func UuidV5(namespace string, data []byte) (string, error)
- func UuidV5Formatted(namespace string, data []byte) (string, error)
- func UuidV6() string
- func UuidV6Formatted() string
- func UuidV7() string
- func UuidV7Formatted() string
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func HumanUid ¶
func HumanUid() string
HumanUid generates a UUID (32 digits) Format: YYYYMMDD-HHMM-SSMM-MMMMNNNRRRRRRRRR
func MicroUid ¶
func MicroUid() string
MicroUid generates a UID (20 digits) Format: YYYYMMDD-HHMMSS-MMMMMM
func NanoUid ¶
func NanoUid() string
NanoUid generates a UID (23 digits) Format: YYYYMMDD-HHMMSS-MMMMMM-NNN
func TimestampMicro ¶ added in v1.5.0
func TimestampMicro() string
func TimestampNano ¶ added in v1.5.0
func TimestampNano() string
func UuidFormatted ¶ added in v1.5.0
func UuidFormatted() string
func UuidV1Formatted ¶ added in v1.5.0
func UuidV1Formatted() string
func UuidV3Formatted ¶ added in v1.5.0
func UuidV4Formatted ¶ added in v1.5.0
func UuidV4Formatted() string
func UuidV5Formatted ¶ added in v1.5.0
func UuidV6Formatted ¶ added in v1.5.0
func UuidV6Formatted() string
func UuidV7Formatted ¶ added in v1.5.0
func UuidV7Formatted() string
Types ¶
This section is empty.
Source Files