db

package

v0.0.0-...-b5a4b96 Latest Latest Go to latest Published: Oct 22, 2016 License: LGPL-3.0 Imports: 13 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/z0rr0/luss

Links

Open Source Insights

Documentation ¶

Overview ¶

Package db implements MongoDB database access methods.

Index ¶

Variables
func C(ctx context.Context, name string) (*mgo.Collection, error)
func CheckID(s string) (bson.ObjectId, error)
func Coll(s *mgo.Session, name string) (*mgo.Collection, error)
func CtxSession(ctx context.Context) (*mgo.Session, error)
func LockURL(s *mgo.Session) error
func MongoCredential(cfg *conf.MongoCfg) error
func NewContext(ctx context.Context, s *mgo.Session) context.Context
func NewCtxSession(ctx context.Context, c *conf.Config, primary bool) (context.Context, *mgo.Session, error)
func NewSession(c *conf.Conn, primary bool) (*mgo.Session, error)
func UnlockURL(s *mgo.Session) error
type Item
type ItemURL

Constants ¶

This section is empty.

Variables ¶

View Source

var (
	// Logger is a logger for error messages
	Logger = log.New(os.Stderr, "LOGGER [db]: ", log.Ldate|log.Ltime|log.Lshortfile)
	// Colls is a map of db collections names.
	// Keys can be used as aliases, values are real collection names.
	Colls = map[string]string{
		"urls":   "urls",
		"tracks": "tracks",
		"locks":  "locks",
		"users":  "users",
		"tests":  "tests",
	}
)

Functions ¶

func C ¶

func C(ctx context.Context, name string) (*mgo.Collection, error)

C return a collection pointer by its name from default database.

func CheckID ¶

func CheckID(s string) (bson.ObjectId, error)

CheckID converts string s to ObjectId if it is possible, otherwise it returns error.

func Coll ¶

func Coll(s *mgo.Session, name string) (*mgo.Collection, error)

Coll return database collection pointer.

func CtxSession ¶

func CtxSession(ctx context.Context) (*mgo.Session, error)

CtxSession finds and returns MongoDB session from the Context.

func LockURL ¶

func LockURL(s *mgo.Session) error

LockURL locks short URL creation actions. It is useful for distributed usage, database is used for consistency short URLs values.

func MongoCredential ¶

func MongoCredential(cfg *conf.MongoCfg) error

MongoCredential initializes MongoDB credentials.

func NewContext ¶

func NewContext(ctx context.Context, s *mgo.Session) context.Context

NewContext returns a new Context carrying MongoDB session.

func NewCtxSession ¶

func NewCtxSession(ctx context.Context, c *conf.Config, primary bool) (context.Context, *mgo.Session, error)

NewCtxSession creates new database session and saves it to the context.

func NewSession ¶

func NewSession(c *conf.Conn, primary bool) (*mgo.Session, error)

NewSession returns new MongoDB session based on Conn data.

func UnlockURL ¶

func UnlockURL(s *mgo.Session) error

UnlockURL unlocks short URLs creation actions.

Types ¶

type Item ¶

type Item struct {
	ID bson.ObjectId `bson:"_id"`
}

Item is any DB item, it contains only identifier.

type ItemURL ¶

type ItemURL struct {
	ID int64 `bson:"_id"`
}

ItemURL is any DB item, it contains only short URL identifier.

Source Files ¶

View all Source files

db.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL