mongo

Documentation

Overview

Package mongo provides an implementation of sorted.KeyValue using MongoDB.

Index

• Constants
• func NewKeyValue(cfg Config) (sorted.KeyValue, error)
• func Ping(host string, timeout time.Duration) bool
• type Config
  • func ConfigFromJSON(cfg jsonconfig.Obj) (Config, error)

Constants

const (
	CollectionName = "keys" // MongoDB collection, equiv. to SQL table

)

We explicitely separate the key and the value in a document, instead of simply storing as key:value, to avoid problems such as "." being an illegal char in a key name. Also because there is no way to do partial matching for key names (one can only check for their existence with bson.M{$exists: true}).

Functions

func NewKeyValue

func NewKeyValue(cfg Config) (sorted.KeyValue, error)

NewKeyValue returns a KeyValue implementation on top of MongoDB.

func Ping

func Ping(host string, timeout time.Duration) bool

Ping tests if MongoDB on host can be dialed.

Types

type Config

type Config struct {
	Server   string // Required. Defaults to "localhost" in ConfigFromJSON.
	Database string // Required.
	User     string // Optional, unless the server was configured with auth on.
	Password string // Optional, unless the server was configured with auth on.
}

Config holds the parameters used to connect to MongoDB.

func ConfigFromJSON

func ConfigFromJSON(cfg jsonconfig.Obj) (Config, error)

ConfigFromJSON populates Config from cfg, and validates cfg. It returns an error if cfg fails to validate.