models

Documentation

Index

• Constants
• Variables
• func ArchInBackup(arch Archive, backup *Backup) bool
• func BsonTimestampFromOplogTS(ots Timestamp) primitive.Timestamp
• func LessTS(ots1, ots2 Timestamp) bool
• func NewError(code ErrorCode, msg string) error
• func PutOplogEntry(oplog *Oplog)
• func TimestampInInterval(ts, begin, end Timestamp) bool
• type Archive
  • func ArchFromFilename(path string) (Archive, error)
  • func NewArchive(start, end Timestamp, ext, atype string) (Archive, error)
  • func (a Archive) Extension() string
  • func (a Archive) Filename() string
  • func (a Archive) In(ts Timestamp) bool
• type Backup
  • func FirstOverlappingBackupForArch(arch Archive, backups []*Backup) *Backup
  • func (b *Backup) IsPermanent() bool
  • func (b *Backup) Name() string
  • func (b *Backup) StartTime() time.Time
• type BackupMeta
• type Error
  • func (e *Error) Error() string
• type ErrorCode
• type IsMaster
• type IsMasterLastWrite
• type MongoMeta
• type NodeMeta
• type OpTime
• type Oplog
  • func GetOplogEntry() *Oplog
  • func OplogFromRaw(raw bson.Raw) (*Oplog, error)
• type Timestamp
  • func MaxTS(ots1, ots2 Timestamp) Timestamp
  • func TimestampFromBson(bts primitive.Timestamp) Timestamp
  • func TimestampFromStr(s string) (Timestamp, error)
  • func (ots Timestamp) String() string
  • func (ots Timestamp) ToBsonTS() primitive.Timestamp

Constants

const (
	OplogArchBasePath   = "oplog_" + utility.VersionStr + "/"
	ArchNameTSDelimiter = "_"
	ArchiveTypeOplog    = "oplog"
	ArchiveTypeGap      = "gap"
)

Archive path constants.

const (
	MaxDocumentSize = 16 * 1024 * 1024
)

Variables

var (
	ArchRegexp = regexp.MustCompile(`^(oplog|gap)_(?P<startTS>[0-9]+\.[0-9]+)_(?P<endTS>[0-9]+\.[0-9]+)\.(?P<Ext>[^$]+)$`)
)

var ErrorDescriptions = map[ErrorCode]string{
	SplitFound:        "last known document was not found",
	VersionChanged:    "schema version of the user credential documents changed",
	CollectionRenamed: "collection renamed",
}

ErrorDescriptions maps error codes to messages

Functions

func ArchInBackup

func ArchInBackup(arch Archive, backup *Backup) bool

ArchInBackup checks if archive and given backup overlaps each over.

func BsonTimestampFromOplogTS

func BsonTimestampFromOplogTS(ots Timestamp) primitive.Timestamp

BsonTimestampFromOplogTS builds BSON primitive from Timestamp

func LessTS

func LessTS(ots1, ots2 Timestamp) bool

LessTS returns if first timestamp less than second

func NewError

func NewError(code ErrorCode, msg string) error

NewError builds Error with error code and message

func PutOplogEntry

func PutOplogEntry(oplog *Oplog)

PutOplogEntry zeroes fields of Oplog struct and it to pool

func TimestampInInterval

func TimestampInInterval(ts, begin, end Timestamp) bool

TimestampInInterval checks if timestamp is in given interval.

Types

type Archive

type Archive struct {
	Start Timestamp
	End   Timestamp
	Ext   string
	Type  string
}

Archive defines oplog archive representation.

func ArchFromFilename

func ArchFromFilename(path string) (Archive, error)

ArchFromFilename builds Arch from given path. TODO: support empty extension

func NewArchive

func NewArchive(start, end Timestamp, ext, atype string) (Archive, error)

NewArchive builds Archive struct with given arguments.

func (Archive) Extension

func (a Archive) Extension() string

Extension returns extension of archive file name.

func (Archive) Filename

func (a Archive) Filename() string

Filename builds archive filename from timestamps, extension and type. example: oplog_1569009857.10_1569009101.99.lzma

func (Archive) In

func (a Archive) In(ts Timestamp) bool

In returns if oplog with given timestamp is exists in archive.

type Backup

type Backup struct {
	BackupName       string      `json:"BackupName,omitempty"`
	BackupType       string      `json:"BackupType,omitempty"`
	Hostname         string      `json:"Hostname,omitempty"`
	StartLocalTime   time.Time   `json:"StartLocalTime,omitempty"`
	FinishLocalTime  time.Time   `json:"FinishLocalTime,omitempty"`
	UserData         interface{} `json:"UserData,omitempty"`
	MongoMeta        MongoMeta   `json:"MongoMeta,omitempty"`
	Permanent        bool        `json:"Permanent"`
	UncompressedSize int64       `json:"UncompressedSize,omitempty"`
	CompressedSize   int64       `json:"DataSize,omitempty"`
}

Backup represents backup sentinel data todo: use `internal.GenericMetadata` as base

func FirstOverlappingBackupForArch

func FirstOverlappingBackupForArch(arch Archive, backups []*Backup) *Backup

FirstOverlappingBackupForArch checks if archive overlaps any backup from given list. TODO: build btree to fix ugly complexity here

func (*Backup) IsPermanent

func (b *Backup) IsPermanent() bool

func (*Backup) Name

func (b *Backup) Name() string

func (*Backup) StartTime

func (b *Backup) StartTime() time.Time

type BackupMeta

type BackupMeta struct {
	BackupName     string
	Hostname       string
	Mongo          MongoMeta
	CompressedSize int64
	Permanent      bool
	User           interface{}
	StartTime      time.Time
	FinishTime     time.Time
}

BackupMeta includes mongodb and storage metadata

type Error

type Error struct {
	// contains filtered or unexported fields
}

Error ...

func (*Error) Error

func (e *Error) Error() string

Error ...

type ErrorCode

type ErrorCode int

ErrorCode ...

const (
	ValidationMessagePrefix           = "oplog validate error"
	SplitFound              ErrorCode = iota
	VersionChanged          ErrorCode = iota
	CollectionRenamed       ErrorCode = iota
)

Error codes generation

type IsMaster

type IsMaster struct {
	IsMaster  bool
	LastWrite IsMasterLastWrite
}

IsMaster ...

type IsMasterLastWrite

type IsMasterLastWrite struct {
	OpTime         OpTime
	MajorityOpTime OpTime
}

IsMasterLastWrite ...

type MongoMeta

type MongoMeta struct {
	Before NodeMeta `json:"Before,omitempty"`
	After  NodeMeta `json:"After,omitempty"`

	Version string `json:"Version,omitempty"`

	BackupLastTS primitive.Timestamp `json:"BackupLastTS,omitempty"`
}

MongoMeta includes NodeMeta Before and after backup

type NodeMeta

type NodeMeta struct {
	LastTS    Timestamp `json:"LastTS,omitempty"`
	LastMajTS Timestamp `json:"LastMajTS,omitempty"`
}

NodeMeta represents MongoDB node metadata

type OpTime

type OpTime struct {
	TS   Timestamp
	Term int64
}

Optime ...

type Oplog

type Oplog struct {
	TS   Timestamp `bson:"ts"`
	Data []byte
}

Oplog represents oplog raw and parsed metadata.

func GetOplogEntry

func GetOplogEntry() *Oplog

GetOplogEntry fetches empty Oplog struct from pool

func OplogFromRaw

func OplogFromRaw(raw bson.Raw) (*Oplog, error)

OplogFromRaw tries to decode bytes to Oplog model

type Timestamp

type Timestamp struct {
	TS  uint32 `json:"TS"`
	Inc uint32 `json:"Inc"`
}

Timestamp represents oplog record uniq id.

func MaxTS

func MaxTS(ots1, ots2 Timestamp) Timestamp

MaxTS returns maximum of two timestamps.

func TimestampFromBson

func TimestampFromBson(bts primitive.Timestamp) Timestamp

TimestampFromBson builds Timestamp from BSON primitive

func TimestampFromStr

func TimestampFromStr(s string) (Timestamp, error)

TimestampFromStr builds Timestamp from string

func (Timestamp) String

func (ots Timestamp) String() string

String returns text representation of Timestamp struct

func (Timestamp) ToBsonTS

func (ots Timestamp) ToBsonTS() primitive.Timestamp