diff --git a/README.md b/README.md index 8cd6ac38c..83d469d85 100644 --- a/README.md +++ b/README.md @@ -60,7 +60,7 @@ Use `mysql` as `driverName` and a valid [DSN](#dsn-data-source-name) as `dataSo import "database/sql" import _ "github.com/go-sql-driver/mysql" -db, e := sql.Open("mysql", "user:password@/dbname?charset=utf8") +db, err := sql.Open("mysql", "user:password@/dbname") ``` [Examples are available in our Wiki](https://github.com/go-sql-driver/mysql/wiki/Examples "Go-MySQL-Driver Examples"). diff --git a/driver.go b/driver.go index 9ce6f6aaf..8f093c69c 100644 --- a/driver.go +++ b/driver.go @@ -6,6 +6,15 @@ // You can obtain one at http://mozilla.org/MPL/2.0/. // Go MySQL Driver - A MySQL-Driver for Go's database/sql package +// +// The driver should be used via the database/sql package: +// +// import "database/sql" +// import _ "github.com/go-sql-driver/mysql" +// +// db, err := sql.Open("mysql", "user:password@/dbname") +// +// See https://github.com/go-sql-driver/mysql#usage for details package mysql import ( @@ -14,12 +23,14 @@ import ( "net" ) -type mysqlDriver struct{} +// This struct is exported to make the driver directly accessible. +// In general the driver is used via the database/sql package. +type MySQLDriver struct{} // Open new Connection. // See https://github.com/go-sql-driver/mysql#dsn-data-source-name for how // the DSN string is formated -func (d *mysqlDriver) Open(dsn string) (driver.Conn, error) { +func (d *MySQLDriver) Open(dsn string) (driver.Conn, error) { var err error // New mysqlConn @@ -78,5 +89,5 @@ func (d *mysqlDriver) Open(dsn string) (driver.Conn, error) { } func init() { - sql.Register("mysql", &mysqlDriver{}) + sql.Register("mysql", &MySQLDriver{}) }