manager

README

Manager

Manager is used for initializing a database connection pool(sql.DB in go's standard library)

The original way to initialize a sql.DB is something like：

pool,err := sql.Open("mysql", dataSourceName)

And the format of dataSourceName is：

[username[:password]@][protocol[(address)]]/dbname[?param1=value1&...&paramN=valueN]

What the manager does is providing a series of simple methods which help you setting these parameters.

Example

import (
	"github.com/didi/gendry/manager"
	_ "github.com/go-sql-driver/mysql"
)

var db *sql.DB
var err error
db,err = manager.New(dbName, user, password, host)
		.Set(
			SetCharset("utf8"),
			SetParseTime(true),
			SetLocal("UTC")
		)
		.Port(3307)
		.Open(true)

godoc is a great tool for scanning the API documentation

Basic API

func New(dbName, user, password, host string) *Option

New returns an Option

func (o *Option) Driver(driver string) *Option

Driver sets the driver, default mysql

func (o *Option) Open(ping bool) (*sql.DB, error)

Open is used for creating a *sql.DB.If ping=true,it will exec the db.Ping() after creating the db object

func (o *Option) Port(port int) *Option

Port sets the server port,default 3306

func (o *Option) Set(sets ...Setting) *Option

Set recieves a series of Set*-like functions

---

Setting APIs

For more details see DSN-Data-Source-Name

• SetAllowAllFiles: allowAllFiles=true disables the file Whitelist for LOAD DATA LOCAL INFILE and allows all files. Might be insecure!
• SetAllowCleartextPasswords: allowCleartextPasswords=true allows using thecleartext client side plugin if required by an account, such as one defined with the PAM authentication plugin. Sending passwords in clear text may be a security problem in some configurations.
• SetAllowNativePasswords: Allows the usage of the mysql native password method
• SetAutoCommit: Set it to true if you know what you are doing
• SetCharset: Sets the charset used for client-server interaction
• SetClientFoundRows: clientFoundRows=true causes an UPDATE to return the number of matching rows instead of the number of rows changed.
• SetCollation: Sets the collation used for client-server interaction on connection. In contrast to charset, collation does not issue additional queries. If the specified collation is unavailable on the target server,the connection will fail.
• SetColumnsWithAlias: When columnsWithAlias is true, calls to sql.Rows.Columns() will return the table alias and the column name separated by a dot.
• SetInterpolateParams: If interpolateParams is true, placeholders (?) in calls to db.Query() and db.Exec() are interpolated into a single query string with given parameters. This reduces the number of roundtrips, since the driver has to prepare a statement, execute it with given parameters and close the statement again with interpolateParams=false.
• SetLoc: SetLoc Sets the location for time.Time values (when using parseTime=true). "Local" sets the system's location. See time.LoadLocation in standard library for detail.
• SetParseTime: SetParseTime if set true changes the DATE and DATETIME type in mysql will be stored in a time.Time object rather than the []byte / string
• SetReadTimeout: SetReadTimeout I/O read timeout. timeout ∈ [1ms, 24h)
• SetStrict: SetStrict strict=true enables the strict mode in which MySQL warnings are treated as errors.
• SetTimeout: SetTimeout Driver side connection timeout. timeout ∈ [1ms, 24h)
• SetWriteTimeout: SetWriteTimeout I/O write timeout. timeout ∈ [1ms, 24h)

Documentation

Index

• type Option
  • func New(dbName, user, password, host string) *Option
  • func (o *Option) Driver(driver string) *Option
  • func (o *Option) Open(ping bool) (*sql.DB, error)
  • func (o *Option) Port(port int) *Option
  • func (o *Option) Set(sets ...Setting) *Option
• type Setting
  • func SetAllowAllFiles(ok bool) Setting
  • func SetAllowCleartextPasswords(ok bool) Setting
  • func SetAllowNativePasswords(ok bool) Setting
  • func SetAutoCommit(ok bool) Setting
  • func SetCharset(v string) Setting
  • func SetClientFoundRows(ok bool) Setting
  • func SetCollation(v string) Setting
  • func SetColumnsWithAlias(ok bool) Setting
  • func SetInterpolateParams(ok bool) Setting
  • func SetLoc(v string) Setting
  • func SetParseTime(ok bool) Setting
  • func SetReadTimeout(timeout time.Duration) Setting
  • func SetStrict(ok bool) Setting
  • func SetTimeout(timeout time.Duration) Setting
  • func SetWriteTimeout(timeout time.Duration) Setting

Types

type Option

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

Option stands for a series of options for creating a DB

func New

func New(dbName, user, password, host string) *Option

New returns an Option

func (*Option) Driver

func (o *Option) Driver(driver string) *Option

Driver sets the driver, default mysql

func (*Option) Open

func (o *Option) Open(ping bool) (*sql.DB, error)

Open is used for creating a *sql.DB Use it at the last

func (*Option) Port

func (o *Option) Port(port int) *Option

Port sets the server port,default 3306

func (*Option) Set

func (o *Option) Set(sets ...Setting) *Option

Set receives a series of Set*-like functions

type Setting

type Setting func(string) string

Setting is the signature of setting function

func SetAllowAllFiles

func SetAllowAllFiles(ok bool) Setting

SetAllowAllFiles allowAllFiles=true disables the file Whitelist for LOAD DATA LOCAL INFILE and allows all files. Might be insecure!

func SetAllowCleartextPasswords

func SetAllowCleartextPasswords(ok bool) Setting

SetAllowCleartextPasswords allowCleartextPasswords=true allows using the cleartext client side plugin if required by an account, such as one defined with the PAM authentication plugin. Sending passwords in clear text may be a security problem in some configurations.

func SetAllowNativePasswords

func SetAllowNativePasswords(ok bool) Setting

SetAllowNativePasswords allows the usage of the mysql native password method

func SetAutoCommit

func SetAutoCommit(ok bool) Setting

SetAutoCommit set it to true if you know what you are doing

func SetCharset

func SetCharset(v string) Setting

SetCharset Sets the charset used for client-server interaction

func SetClientFoundRows

func SetClientFoundRows(ok bool) Setting

SetClientFoundRows clientFoundRows=true causes an UPDATE to return the number of matching rows instead of the number of rows changed.

func SetCollation

func SetCollation(v string) Setting

SetCollation Sets the collation used for client-server interaction on connection. In contrast to charset, collation does not issue additional queries. If the specified collation is unavailable on the target server, the connection will fail.

func SetColumnsWithAlias

func SetColumnsWithAlias(ok bool) Setting

SetColumnsWithAlias When columnsWithAlias is true, calls to sql.Rows.Columns() will return the table alias and the column name separated by a dot.

func SetInterpolateParams

func SetInterpolateParams(ok bool) Setting

SetInterpolateParams If interpolateParams is true, placeholders (?) in calls to db.Query() and db.Exec() are interpolated into a single query string with given parameters. This reduces the number of roundtrips, since the driver has to prepare a statement, execute it with given parameters and close the statement again with interpolateParams=false.

func SetLoc

func SetLoc(v string) Setting

SetLoc Sets the location for time.Time values (when using parseTime=true). "Local" sets the system's location. See time.LoadLocation for details.

func SetParseTime

func SetParseTime(ok bool) Setting

SetParseTime parseTime=true changes the output type of DATE and DATETIME values to time.Time instead of []byte / string

func SetReadTimeout

func SetReadTimeout(timeout time.Duration) Setting

SetReadTimeout I/O read timeout. The value must be a decimal number with an unit suffix ( "ms", "s", "m", "h" ), such as "30s", "0.5m" or "1m30s".

func SetStrict

func SetStrict(ok bool) Setting

SetStrict strict=true enables the strict mode in which MySQL warnings are treated as errors.

func SetTimeout

func SetTimeout(timeout time.Duration) Setting

SetTimeout Driver side connection timeout. The value must be a decimal number with an unit suffix ( "ms", "s", "m", "h" ), such as "30s", "0.5m" or "1m30s". To set a server side timeout, use the parameter wait_timeout.

func SetWriteTimeout

func SetWriteTimeout(timeout time.Duration) Setting

SetWriteTimeout I/O write timeout. The value must be a decimal number with an unit suffix ( "ms", "s", "m", "h" ), such as "30s", "0.5m" or "1m30s".