objectid

README

ObjectID

Library to generate MongoDB objectID's

Command usage

$ objectid -h
Usage of objectid:
  -format string
        format of objectid: hex, base64 (default "hex")
  -from-time string
        create a new objectid from a date time (RFC3339, $(date -I), $(date -Ihours), $(date -d -Iminutes), $(date -Iseconds)
  -n int
        number of objectid to generate (default 1)
  -separator string
        separator between objectids (default "\n")
  -to-time string
        convert objectid to time

Generate object id

$ objectid
6435f4800000000000000000

Generate object id in base64

$ objectid -format base64
ZiesvNpsbBz8QUGk

Generate multiple object id

$ objectid -n 3
6435f4800000000000000000
6435f4800000000000000001
6435f4800000000000000002

Object id from time

$ objectid -from-time 2023-04-12
6435f4800000000000000000%

Object id to time

$ objectid -to-time 6435f4800000000000000000
2023-04-12 00:00:00 +0000 UTC

Library Usage

go get -u github.com/Ajnasz/objectid

import "github.com/Ajnasz/objectid"


func main() {
    oid := objectid.New()
    fmt.Printf("%s", oid)
}

CLI

Install the cli tool

go install github.com/Ajnasz/objectid/cmd/objectid

or

make build
bin/objectid

Documentation

Overview

Package objectid package implements MongoDB's ObjectID type.

Index

• Variables
• func GenerateTo(objectID *ObjectID)
• type ObjectID
  • func FromBase64(str string) (ObjectID, error)
  • func FromHex(str string) (ObjectID, error)
  • func FromTime(str string) (ObjectID, error)
  • func New() ObjectID
  • func (id ObjectID) Base64() string
  • func (id ObjectID) Hex() string
  • func (id ObjectID) String() string
  • func (id ObjectID) Time() time.Time

Examples

• FromHex
• GenerateTo
• New

Variables

var ErrInvalidBase64 = errors.New("invalid base64")

ErrInvalidBase64 is returned when an invalid base64 string is provided.

var ErrInvalidHex = errors.New("invalid hex")

ErrInvalidHex is returned when an invalid hex string is provided.

var ErrInvalidTimeFormat = errors.New("invalid time format")

ErrInvalidTimeFormat is returned when an invalid time format is provided.

Functions

func GenerateTo

func GenerateTo(objectID *ObjectID)

GenerateTo generates a new ObjectID and writes it to the provided ObjectID pointer.

Example

counter.Store(0x6b5f9e) // as a user of this package, you don't need to do this, but it's done here to ensure the same output

var oid ObjectID
GenerateTo(&oid)
fmt.Println(oid.Hex())

Output:

5c2aad805f9e6b5f9e6b5f9f

Types

type ObjectID

type ObjectID [12]byte

ObjectID is a 12-byte unique identifier for a MongoDB document.

func FromBase64

func FromBase64(str string) (ObjectID, error)

FromBase64 decodes a base64 string into an ObjectID.

func FromHex

func FromHex(str string) (ObjectID, error)

FromHex creates a new ObjectID from a hex string.

Example

g, err := FromHex("5c2aad805f9e6b5f9e6b5fa3")

if err != nil {
	fmt.Println(err)
} else {
	fmt.Println(g.Hex())
}

Output:

5c2aad805f9e6b5f9e6b5fa3

func FromTime

func FromTime(str string) (ObjectID, error)

FromTime creates a new ObjectID from a time string. The time string must be in one of the formats: RFC3339, "2006-01-02T15:04-07:00", "2006-01-02T15:04", "2006-01-02T15-07:00", "2006-01-02",

func New

func New() ObjectID

New generates a new ObjectID.

Example

counter.Store(0x6b5f9e) // as a user of this package, you don't need to do this, but it's done here to ensure the same output

g := New()
fmt.Println(g.Hex())

Output:

5c2aad805f9e6b5f9e6b5f9f

func (ObjectID) Base64

func (id ObjectID) Base64() string

Base64 returns the hex encoding of the ObjectID as a string.

func (ObjectID) Hex

func (id ObjectID) Hex() string

Hex returns the hex encoding of the ObjectID as a string.

func (ObjectID) String

func (id ObjectID) String() string

String returns the hex encoding of the ObjectID as a string.

func (ObjectID) Time

func (id ObjectID) Time() time.Time

Time returns the timestamp part of the ObjectID.