database

README

database

Helper package for Packetframe's control plane database

Example

package main

import (
	log "github.com/sirupsen/logrus"

	database "github.com/packetframe/database/pkg/db"
	"github.com/packetframe/database/pkg/queue"
)

func main() {
	db, err := database.New("mongodb://localhost:27017", "packetframe")
	if err != nil {
		log.Fatal(err)
	}

	if err := db.QueueAppend(queue.Message{
		Payload: map[string]string{"foo": "bar"},
	}); err != nil {
		log.Fatal(err)
	}

	if msg, err := db.QueueNext(); err != nil {
		log.Fatal(err)
	} else {
		log.Printf("%+v\n", msg)
	}
}

Documentation

Index

• type Database
  • func New(bootstrapUri string, databaseName string) (*Database, error)
  • func (d *Database) NewIndex(collection string, key string, unique bool) error
  • func (d *Database) QueueAppend(m Message) error
  • func (d *Database) QueueDelete(m Message) error
  • func (d *Database) QueueNext() (*Message, error)
• type Message

Types

type Database

type Database struct {
	Db *mongo.Database
}

Database wraps a mongo.Database

func New

func New(bootstrapUri string, databaseName string) (*Database, error)

New constructs a new database object

func (*Database) NewIndex

func (d *Database) NewIndex(collection string, key string, unique bool) error

NewIndex creates a new database index with given collection, key, and uniqueness boolean

func (*Database) QueueAppend

func (d *Database) QueueAppend(m Message) error

QueueAppend appends a message to the queue

func (*Database) QueueDelete

func (d *Database) QueueDelete(m Message) error

QueueDelete deletes a message from the queue

func (*Database) QueueNext

func (d *Database) QueueNext() (*Message, error)

QueueNext retrieves the newest message in queue, may return mongo.ErrNoDocuments if there are no queue messages

type Message

type Message struct {
	ID       primitive.ObjectID `bson:"_id,omitempty"`
	Payload  map[string]string
	Created  int64
	Locked   bool
	LockedAt int64
}

Message stores a single queue entry