mongodb

Documentation

Index

• type Config
• type MongoDB
  • func NewMongoDB(client *mongo.Database) *MongoDB
  • func (m *MongoDB) Bootstrap() error
  • func (m *MongoDB) Create(ctx context.Context, plugin db.Plugin) (db.Plugin, error)
  • func (m *MongoDB) CreateHash(ctx context.Context, module, version, hash string) (db.PluginHash, error)
  • func (m *MongoDB) Delete(ctx context.Context, id string) error
  • func (m *MongoDB) Get(ctx context.Context, id string) (db.Plugin, error)
  • func (m *MongoDB) GetByName(ctx context.Context, name string, filterDisabled, filterHidden bool) (db.Plugin, error)
  • func (m *MongoDB) GetHashByName(ctx context.Context, module, version string) (db.PluginHash, error)
  • func (m *MongoDB) List(ctx context.Context, page db.Pagination) ([]db.Plugin, string, error)
  • func (m *MongoDB) Ping(ctx context.Context) error
  • func (m *MongoDB) SearchByName(ctx context.Context, name string, page db.Pagination) ([]db.Plugin, string, error)
  • func (m *MongoDB) Update(ctx context.Context, id string, plugin db.Plugin) (db.Plugin, error)
• type MongoIndex

Types

type Config

type Config struct {
	URI      string
	Database string
	MinPool  uint64
	MaxPool  uint64
}

Config holds the MongoDB configuration.

type MongoDB

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

MongoDB is a mongoDB client.

func NewMongoDB

func NewMongoDB(client *mongo.Database) *MongoDB

NewMongoDB creates a MongoDB.

func (*MongoDB) Bootstrap

func (m *MongoDB) Bootstrap() error

Bootstrap indexes if not present (collection is automatically created).

func (*MongoDB) Create

func (m *MongoDB) Create(ctx context.Context, plugin db.Plugin) (db.Plugin, error)

Create creates a new plugin.

func (*MongoDB) CreateHash

func (m *MongoDB) CreateHash(ctx context.Context, module, version, hash string) (db.PluginHash, error)

CreateHash creates a new plugin hash.

func (*MongoDB) Delete

func (m *MongoDB) Delete(ctx context.Context, id string) error

Delete deletes the plugin corresponding to the given ID.

func (*MongoDB) Get

func (m *MongoDB) Get(ctx context.Context, id string) (db.Plugin, error)

Get returns the plugin corresponding to the given ID.

func (*MongoDB) GetByName

func (m *MongoDB) GetByName(ctx context.Context, name string, filterDisabled, filterHidden bool) (db.Plugin, error)

GetByName gets the plugin with the given name.

func (*MongoDB) GetHashByName

func (m *MongoDB) GetHashByName(ctx context.Context, module, version string) (db.PluginHash, error)

GetHashByName returns the hash corresponding the given name.

func (*MongoDB) List

func (m *MongoDB) List(ctx context.Context, page db.Pagination) ([]db.Plugin, string, error)

List lists plugins.

func (*MongoDB) Ping

func (m *MongoDB) Ping(ctx context.Context) error

Ping pings MongoDB to check it health status.

func (*MongoDB) SearchByName

func (m *MongoDB) SearchByName(ctx context.Context, name string, page db.Pagination) ([]db.Plugin, string, error)

SearchByName searches for plugins matching with the given name.

func (*MongoDB) Update

func (m *MongoDB) Update(ctx context.Context, id string, plugin db.Plugin) (db.Plugin, error)

Update updates the given plugin.

type MongoIndex

type MongoIndex struct {
	Key  bson.D
	Name string
	V    int32
}

MongoIndex represents a MongoDB index.