mongodb

README

MongoDB

• Driver work with mongo through db.runCommands
• Migrations support json format. It contains array of commands for db.runCommand. Every command is executed in separate request to database
• All keys have to be in quotes "
• Examples

Usage

mongodb://user:password@host:port/dbname?query

URL Query	WithInstance Config	Description
x-migrations-collection	MigrationsCollection	Name of the migrations collection
x-transaction-mode	TransactionMode	If set to true wrap commands in transaction. Available only for replica set. Driver is using strconv.ParseBool for parsing
dbname	DatabaseName	The name of the database to connect to
user		The user to sign in as. Can be omitted
password		The user's password. Can be omitted
host		The host to connect to
port		The port to bind to

Documentation

Index

• Variables
• func WithInstance(instance *mongo.Client, config *Config) (database.Driver, error)
• type Config
• type Mongo
  • func (m *Mongo) Close() error
  • func (m *Mongo) Drop() error
  • func (m *Mongo) Lock() error
  • func (m *Mongo) Open(dsn string) (database.Driver, error)
  • func (m *Mongo) Run(migration io.Reader) error
  • func (m *Mongo) SetVersion(version int, dirty bool) error
  • func (m *Mongo) Unlock() error
  • func (m *Mongo) Version() (version int, dirty bool, err error)

Variables

var (
	ErrNoDatabaseName = fmt.Errorf("no database name")
	ErrNilConfig      = fmt.Errorf("no config")
)

var DefaultMigrationsCollection = "schema_migrations"

Functions

func WithInstance

func WithInstance(instance *mongo.Client, config *Config) (database.Driver, error)

Types

type Config

type Config struct {
	DatabaseName         string
	MigrationsCollection string
	TransactionMode      bool
}

type Mongo

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

func (*Mongo) Close

func (m *Mongo) Close() error

func (*Mongo) Drop

func (m *Mongo) Drop() error

func (*Mongo) Lock

func (m *Mongo) Lock() error

func (*Mongo) Open

func (m *Mongo) Open(dsn string) (database.Driver, error)

func (*Mongo) Run

func (m *Mongo) Run(migration io.Reader) error

func (*Mongo) SetVersion

func (m *Mongo) SetVersion(version int, dirty bool) error

func (*Mongo) Unlock

func (m *Mongo) Unlock() error

func (*Mongo) Version

func (m *Mongo) Version() (version int, dirty bool, err error)