engine

Documentation

Overview

Package engine defines interface of an Engine. The engine would know how to truncate a table

Index

• type Engine
  • func NewPostgresEngine(dsn string) Engine
• type MockEngine
  • func (_m *MockEngine) Close() error
  • func (_m *MockEngine) Truncate(table string) error
• type MySQL
  • func NewMySQLEngine(dsn string) *MySQL
  • func (mysql *MySQL) Close() error
  • func (mysql *MySQL) Truncate(table string) error
• type NoOp
  • func (n *NoOp) Close() error
  • func (n *NoOp) Truncate(table string) error
• type Postgres
  • func (p *Postgres) Close() error
  • func (p *Postgres) Truncate(table string) error
• type SQLite
  • func NewSqliteEngine(dbFilePath string) *SQLite
  • func (sqlite *SQLite) Close() error
  • func (sqlite *SQLite) Truncate(table string) error

Types

type Engine

type Engine interface {
	// Truncate a table
	Truncate(table string) error

	// Close db connection
	Close() error
}

Engine is an interface for db interaction layer

func NewPostgresEngine

func NewPostgresEngine(dsn string) Engine

NewPostgresEngine returns engine for Postgres db

type MockEngine

type MockEngine struct {
	mock.Mock
}

MockEngine is an autogenerated mock type for the Engine type

func (*MockEngine) Close

func (_m *MockEngine) Close() error

Close provides a mock function with given fields:

func (*MockEngine) Truncate

func (_m *MockEngine) Truncate(table string) error

Truncate provides a mock function with given fields: table

type MySQL

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

MySQL dbEngine

func NewMySQLEngine

func NewMySQLEngine(dsn string) *MySQL

NewMySQLEngine returns Mysql engine that knows how to truncate a table

func (*MySQL) Close

func (mysql *MySQL) Close() error

func (*MySQL) Truncate

func (mysql *MySQL) Truncate(table string) error

type NoOp

type NoOp struct{}

func (*NoOp) Close

func (n *NoOp) Close() error

func (*NoOp) Truncate

func (n *NoOp) Truncate(table string) error

type Postgres

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

Postgres dbEngine

func (*Postgres) Close

func (p *Postgres) Close() error

func (*Postgres) Truncate

func (p *Postgres) Truncate(table string) error

type SQLite

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

MySQL dbEngine

func NewSqliteEngine

func NewSqliteEngine(dbFilePath string) *SQLite

NewSQLiteEngine returns SQLite engine

func (*SQLite) Close

func (sqlite *SQLite) Close() error

func (*SQLite) Truncate

func (sqlite *SQLite) Truncate(table string) error

SQLite does not have an explicit TRUNCATE TABLE command like other databases. Instead, it has added a TRUNCATE optimizer to the DELETE statement.