mongo

Documentation

Index

• type Mongo
  • func (m *Mongo) AcquireImageLock(ctx context.Context, imageID string) (lockID string, err error)
  • func (m *Mongo) Checker(ctx context.Context, state *healthcheck.CheckState) error
  • func (m *Mongo) Close(ctx context.Context) error
  • func (m *Mongo) GetImage(ctx context.Context, id string) (*models.Image, error)
  • func (m *Mongo) GetImages(ctx context.Context, collectionID string) ([]models.Image, error)
  • func (m *Mongo) Init(ctx context.Context, shouldEnableReadConcern, shouldEnableWriteConcern bool) (err error)
  • func (m *Mongo) UnlockImage(ctx context.Context, lockID string)
  • func (m *Mongo) UpdateImage(ctx context.Context, id string, image *models.Image) (bool, error)
  • func (m *Mongo) UpsertImage(ctx context.Context, id string, image *models.Image) (err error)

Types

type Mongo

type Mongo struct {
	Collection string
	Database   string
	Connection *dpMongoDriver.MongoConnection
	URI        string
	Username   string
	Password   string

	IsSSL bool
	// contains filtered or unexported fields
}

Mongo represents a simplistic MongoDB configuration, with session, health and lock clients

func (*Mongo) AcquireImageLock

func (m *Mongo) AcquireImageLock(ctx context.Context, imageID string) (lockID string, err error)

AcquireImageLock tries to lock the provided imageID. If the image is already locked, this function will block until it's released, at which point we acquire the lock and return.

func (*Mongo) Checker

func (m *Mongo) Checker(ctx context.Context, state *healthcheck.CheckState) error

Checker is called by the healthcheck library to check the health state of this mongoDB instance

func (*Mongo) Close

func (m *Mongo) Close(ctx context.Context) error

Close closes the mongo session and returns any error

func (*Mongo) GetImage

func (m *Mongo) GetImage(ctx context.Context, id string) (*models.Image, error)

GetImage retrieves an image document by its ID

func (*Mongo) GetImages

func (m *Mongo) GetImages(ctx context.Context, collectionID string) ([]models.Image, error)

GetImages retrieves all images documents corresponding to the provided collectionID

func (*Mongo) Init

func (m *Mongo) Init(ctx context.Context, shouldEnableReadConcern, shouldEnableWriteConcern bool) (err error)

Init creates a new mongodb.MongoConnection with a strong consistency and a write mode of "majority".

func (*Mongo) UnlockImage

func (m *Mongo) UnlockImage(ctx context.Context, lockID string)

UnlockImage releases an exclusive mongoDB lock for the provided lockId (if it exists)

func (*Mongo) UpdateImage

func (m *Mongo) UpdateImage(ctx context.Context, id string, image *models.Image) (bool, error)

UpdateImage updates an existing image document

func (*Mongo) UpsertImage

func (m *Mongo) UpsertImage(ctx context.Context, id string, image *models.Image) (err error)

UpsertImage adds or overides an existing image document