mysqldump

README

Go MYSQL Dump

Create MYSQL dumps in Go without the mysqldump CLI as a dependancy.

Simple Example

package main

import (
	"database/sql"
	"fmt"

	"github.com/JamesStewy/go-mysqldump"
	_ "github.com/go-sql-driver/mysql"
)

func main() {
	// Open connection to database
  username := "your-user"
  password := "your-pw"
  hostname := "your-hostname"
  port := "your-port"
	dbname := "your-db"

  dumpDir := "dumps"  // you should create this directory
  dumpFilenameFormat := fmt.Sprintf("%s-20060102T150405", dbname)   // accepts time layout string and add .sql at the end of file

	db, err := sql.Open("mysql", fmt.Sprintf("%s:%s@tcp(%s:%s)/%s", username, password, hostname, port, dbname))
	if err != nil {
		fmt.Println("Error opening database: ", err)
		return
	}

	// Register database with mysqldump
	dumper, err := mysqldump.Register(db, dumpDir, dumpFilenameFormat)
	if err != nil {
		fmt.Println("Error registering databse:", err)
		return
	}

	// Dump database to file
	resultFilename, err := dumper.Dump()
	if err != nil {
		fmt.Println("Error dumping:", err)
		return
	}
	fmt.Printf("File is saved to %s", resultFilename)

	// Close dumper and connected database
	dumper.Close()
}

Documentation

Index

• func ConvertToSQL(in io.Reader, w io.Writer, opts ...ConvertOptions) error
• type ConvertOptions
• type Dumper
  • func NewDumper(db *sql.DB, w io.Writer) *Dumper
  • func (d *Dumper) Dump(dbName string, tables ...string) error
  • func (d *Dumper) DumpAllTables(dbName string) error

Functions

func ConvertToSQL

func ConvertToSQL(in io.Reader, w io.Writer, opts ...ConvertOptions) error

Types

type ConvertOptions

type ConvertOptions struct {
	// If nil, all tables will be converted. If a table is specified here but is not present on the dump, no error will be returned
	Tables []string
}

type Dumper

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

Dumper represents a database.

func NewDumper

func NewDumper(db *sql.DB, w io.Writer) *Dumper

NewDumper creates a new dumper instance.

func (*Dumper) Dump

func (d *Dumper) Dump(dbName string, tables ...string) error

Dump dumps one or more tables from a database into a writer. If dbName is not empty, a "USE xxx" command will be sent prior to commencing the dump.

func (*Dumper) DumpAllTables

func (d *Dumper) DumpAllTables(dbName string) error

DumpAllTables dumps all tables in a database into a writer If dbName is not empty, a "USE xxx" command will be sent prior to commencing the dump.