db.v3: upper.io/db.v3/mongo Index | Files

package mongo

import "upper.io/db.v3/mongo"

Package mongo wraps the gopkg.in/mgo.v2 MongoDB driver. See https://upper.io/db.v3/mongo for documentation, particularities and usage examples.

Index

Package Files

collection.go connection.go database.go result.go

Constants

const Adapter = `mongo`

Adapter holds the name of the mongodb adapter.

func Open Uses

func Open(settings db.ConnectionURL) (db.Database, error)

Open stablishes a new connection to a SQL server.

type Collection Uses

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

Collection represents a mongodb collection.

func (*Collection) Exists Uses

func (col *Collection) Exists() bool

Exists returns true if the collection exists.

func (*Collection) Find Uses

func (col *Collection) Find(terms ...interface{}) db.Result

Find creates a result set with the given conditions.

func (*Collection) Insert Uses

func (col *Collection) Insert(item interface{}) (interface{}, error)

Insert inserts an item (map or struct) into the collection.

func (*Collection) InsertReturning Uses

func (col *Collection) InsertReturning(item interface{}) error

func (*Collection) Name Uses

func (col *Collection) Name() string

Name returns the name of the table or tables that form the collection.

func (*Collection) Truncate Uses

func (col *Collection) Truncate() error

Truncate deletes all rows from the table.

func (*Collection) UpdateReturning Uses

func (col *Collection) UpdateReturning(item interface{}) error

type ConnectionURL Uses

type ConnectionURL struct {
    User     string
    Password string
    Host     string
    Database string
    Options  map[string]string
}

ConnectionURL implements a MongoDB connection struct.

func ParseURL Uses

func ParseURL(s string) (conn ConnectionURL, err error)

ParseURL parses s into a ConnectionURL struct.

func (ConnectionURL) String Uses

func (c ConnectionURL) String() (s string)

type Source Uses

type Source struct {
    db.Settings
    // contains filtered or unexported fields
}

Source represents a MongoDB database.

func (*Source) ClearCache Uses

func (s *Source) ClearCache()

func (*Source) Clone Uses

func (s *Source) Clone() (db.Database, error)

Clone returns a cloned db.Database session.

func (*Source) Close Uses

func (s *Source) Close() error

Close terminates the current database session.

func (*Source) Collection Uses

func (s *Source) Collection(name string) db.Collection

Collection returns a collection by name.

func (*Source) Collections Uses

func (s *Source) Collections() (cols []string, err error)

Collections returns a list of non-system tables from the database.

func (*Source) ConnectionURL Uses

func (s *Source) ConnectionURL() db.ConnectionURL

func (*Source) Driver Uses

func (s *Source) Driver() interface{}

Driver returns the underlying *mgo.Session instance.

func (*Source) Name Uses

func (s *Source) Name() string

Name returns the name of the database.

func (*Source) NewTransaction Uses

func (s *Source) NewTransaction() (db.Tx, error)

NewTransaction should support transactions, but it doesn't as MongoDB currently does not support them.

func (*Source) Open Uses

func (s *Source) Open(connURL db.ConnectionURL) error

Open attempts to connect to the database.

func (*Source) Ping Uses

func (s *Source) Ping() error

Ping checks whether a connection to the database is still alive by pinging it, establishing a connection if necessary.

func (*Source) SetConnMaxLifetime Uses

func (s *Source) SetConnMaxLifetime(time.Duration)

SetConnMaxLifetime is not supported.

func (*Source) SetMaxIdleConns Uses

func (s *Source) SetMaxIdleConns(int)

SetMaxIdleConns is not supported.

func (*Source) SetMaxOpenConns Uses

func (s *Source) SetMaxOpenConns(int)

SetMaxOpenConns is not supported.

Package mongo imports 12 packages (graph) and is imported by 1 packages. Updated 2018-09-27. Refresh now. Tools for package owners.