go-mysql

The project includes several example applications in the cmd directory. You can build them by running make build in the project root. The resulting binaries will be placed in the bin/ directory.

Available binaries:

• go-binlogparser: parses a binlog file at a given offset
• go-canal: streams binlog events from a server to canal
• go-mysqlbinlog: streams binlog events
• go-mysqldump: like mysqldump, but in Go
• go-mysqlserver: fake MySQL server

To migrate your project to the new repository, add a replace directive to your go.mod file to point the old import path to the new one.

go mod edit -replace=github.com/siddontang/go-mysql=github.com/go-mysql-org/go-mysql@v1.13.0

Or manually edit go.mod:

replace github.com/siddontang/go-mysql => github.com/go-mysql-org/go-mysql v1.13.0

You can use go-mysql as a standard Go database driver by importing the github.com/go-mysql-org/go-mysql/driver package with a blank identifier. The connection is established using a DSN (Data Source Name) in the format user:password@addr/dbname?param=value via sql.Open("mysql", dsn).

package main

import (
	"database/sql"

	_ "github.com/go-mysql-org/go-mysql/driver"
)

func main() {
	// dsn format: "user:password@addr?dbname"
	dsn := "root@127.0.0.1:3306?test"
	db, _ := sql.Open("mysql", dsn)
	db.Close()
}

The client package provides a simple driver for communicating with MySQL servers. It supports MySQL versions 5.5.x through 8.0.x. You can use a connection pool for managing multiple connections efficiently.

import (
    "github.com/go-mysql-org/go-mysql/client"
)

// Create a connection pool
pool := client.NewPool(log.Debugf, 100, 400, 5, "127.0.0.1:3306", `root`, ``, `test`)

// Get a connection from the pool
conn, _ := pool.GetConn(ctx)
defer pool.PutConn(conn)

// Execute commands
conn.Execute() 
// or conn.Begin() etc...

To use go-mysql with GORM, you can change the driver name from mysql to gomysql using build-time -ldflags.

# Build with custom driver name
go build -ldflags '-X "github.com/go-mysql-org/go-mysql/driver.driverName=gomysql"'

Then use it in GORM:

import (
  _ "github.com/go-mysql-org/go-mysql/driver"
  "gorm.io/driver/mysql"
  "gorm.io/gorm"
)

db, err := gorm.Open(mysql.New(mysql.Config{
  DriverName: "gomysql",
  DSN: "gorm:gorm@127.0.0.1:3306/test",
}))

MariaDB 11.4+ uses an optimization where some events have LogPos=0. To track these positions accurately, set FillZeroLogPos: true in your BinlogSyncerConfig. This enables the BINLOG_SEND_ANNOTATE_ROWS_EVENT flag and dynamic LogPos calculation. This setting only affects the mariadb flavor.

cfg := replication.BinlogSyncerConfig {
	ServerID: 100,
	Flavor:   "mariadb",
	Host:     "127.0.0.1",
	Port:     3306,
	User:     "root",
	Password: "",
	// Enable dynamic LogPos calculation for MariaDB 11.4+
	FillZeroLogPos: true,
}

You can implement a custom NamedValueChecker to handle query arguments before they reach the driver. This requires a full import of the driver package. Returning sqlDriver.ErrSkip allows the driver to fall back to the default value converter.

import (
 "database/sql"

 "github.com/go-mysql-org/go-mysql/driver"
)

func main() {
 driver.AddNamedValueChecker(func(nv *sqlDriver.NamedValue) error {
  rv := reflect.ValueOf(nv.Value)
  if rv.Kind() != reflect.Uint64 {
   // fallback to the default value converter when the value is not a uint64
   return sqlDriver.ErrSkip
  }

  return nil
 })

 conn, err := sql.Open("mysql", "root@127.0.0.1:3306/test")
 defer conn.Close()

 stmt, err := conn.Prepare("select * from table where id = ?")
 defer stmt.Close()
 var val uint64 = math.MaxUint64
 // without the NamedValueChecker this query would fail
 result, err := stmt.Query(val)
}

The driver.SetDSNOptions function allows you to define custom driver options that can be triggered via the DSN. This requires a full import of the driver package (not just a side-effect import).

import (
 "database/sql"

 "github.com/go-mysql-org/go-mysql/driver"
)

func main() {
 driver.SetDSNOptions(map[string]DriverOption{
  "no_metadata": func(c *client.Conn, value string) error {
   c.SetCapability(mysql.CLIENT_OPTIONAL_RESULTSET_METADATA)
   return nil
  },
 })

 // dsn format: "user:password@addr/dbname?"
 dsn := "root@127.0.0.1:3306/test?no_metadata=true"
 db, _ := sql.Open(dsn)
 db.Close()
}