doc.go

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

Example

This example uses the mysql driver (https://github.com/go-sql-driver/mysql) to connect to a mysql instance.

    package main

    import (
        "database/sql"
        "fmt"

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

    func main() {
        // Open connection to database
        config := mysql.NewConfig()
        config.User = "your-user"
        config.Passwd = "your-pw"
        config.DBName = "your-db"
        config.Net = "tcp"
        config.Addr = "your-hostname:your-port"

        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", config.FormatDNS())
        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, connected database and file stream.
        dumper.Close()
    }
*/
package mysqldump