key

Documentation

Index

• Constants
• Variables
• type Key
  • func FromCombinedKey(k string) (Key, error)
  • func (k Key) CombinedKey() string

Constants

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

Variables

var ErrInvalidCombinedKey = errors.New("invalid combined key")

ErrInvalidCombinedKey is returned when the given combined key is invalid.

Types

type Key

type Key struct {
	Collection string
	Document   string
}

Key represents the key of the Document.

func FromCombinedKey

func FromCombinedKey(k string) (Key, error)

FromCombinedKey creates an instance of Key from the given combined key.

func (Key) CombinedKey

func (k Key) CombinedKey() string

CombinedKey returns the string of this key.