key

Documentation

Index

• Constants
• Variables
• type Key
  • func FromBSONKey(bsonKey string) (*Key, error)
  • func (k *Key) BSONKey() string

Constants

const (
	// BSONSplitter is used to separate collection and document in a string.
	BSONSplitter = "$"
)

Variables

var ErrInvalidBSONKey = errors.New("invalid bson key")

ErrInvalidBSONKey is returned when the given bsonKey is invalid.

Types

type Key

type Key struct {
	Collection string
	Document   string
}

Key represents the key of the Document.

func FromBSONKey

func FromBSONKey(bsonKey string) (*Key, error)

FromBSONKey creates an instance of Key from the received bsonKey.

func (*Key) BSONKey

func (k *Key) BSONKey() string

BSONKey returns the string of this key.