package mysql

Import Path
	github.com/go-sql-driver/mysql (on go.dev)

Dependency Relation
	imports 30 packages, and imported by one package

Involved Source Files

	    atomic_bool.go
	    auth.go
	    buffer.go
	    collations.go
	    conncheck.go
	    connection.go
	    connector.go
	    const.go
	  d driver.go
		Package mysql provides 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

	    dsn.go
	    errors.go
	    fields.go
	    infile.go
	    nulltime.go
	    packets.go
	    result.go
	    rows.go
	    statement.go
	    transaction.go
	    utils.go
Package-Level Type Names (total 7)

	/* sort by: alphabet | popularity */
	 type Config (struct)
		Config is a configuration parsed from a DSN string.
		If a new Config is created instead of being parsed from a DSN string,
		the NewConfig function should be used, which sets default values.

		Fields (total 27)
			Addr string
				// Network address (requires Net)

			AllowAllFiles bool
				// Allow all files to be used with LOAD DATA LOCAL INFILE

			AllowCleartextPasswords bool
				// Allows the cleartext client side plugin

			AllowFallbackToPlaintext bool
				// Allows fallback to unencrypted connection if server does not support TLS

			AllowNativePasswords bool
				// Allows the native password authentication method

			AllowOldPasswords bool
				// Allows the old insecure password method

			CheckConnLiveness bool
				// Check connections for liveness before using them

			ClientFoundRows bool
				// Return number of matching rows instead of rows changed

			Collation string
				// Connection collation

			ColumnsWithAlias bool
				// Prepend table alias to column names

			DBName string
				// Database name

			InterpolateParams bool
				// Interpolate placeholders into query string

			Loc *time.Location
				// Location for time.Time values

			MaxAllowedPacket int
				// Max packet size allowed

			MultiStatements bool
				// Allow multiple statements in one query

			Net string
				// Network type

			Params map[string]string
				// Connection parameters

			ParseTime bool
				// Parse time values to time.Time

			Passwd string
				// Password (requires User)

			ReadTimeout time.Duration
				// I/O read timeout

			RejectReadOnly bool
				// Reject read-only connections

			ServerPubKey string
				// Server public key name

			TLS *tls.Config
				// TLS configuration, its priority is higher than TLSConfig

			TLSConfig string
				// TLS configuration name

			Timeout time.Duration
				// Dial timeout

			User string
				// Username

			WriteTimeout time.Duration
				// I/O write timeout

		Methods (total 2)
			(*Config) Clone() *Config
			(*Config) FormatDSN() string
				FormatDSN formats the given Config into a DSN string which can be passed to
				the driver.

		As Outputs Of (at least 3)
			func NewConfig() *Config
			func ParseDSN(dsn string) (cfg *Config, err error)
			func (*Config).Clone() *Config
		As Inputs Of (at least one exported)
			func NewConnector(cfg *Config) (driver.Connector, error)

	 type DialContextFunc (func)
		DialContextFunc is a function which can be used to establish the network connection.
		Custom dial functions must be registered with RegisterDialContext

		As Inputs Of (at least one exported)
			func RegisterDialContext(net string, dial DialContextFunc)

	 type DialFunc (func)
		DialFunc is a function which can be used to establish the network connection.
		Custom dial functions must be registered with RegisterDial
		
		Deprecated: users should register a DialContextFunc instead

		As Inputs Of (at least one exported)
			func RegisterDial(network string, dial DialFunc)

	 type Logger (interface)
		Logger is used to log critical error messages.

		Methods (only one)
			( Logger) Print(v ...interface{})
		Implemented By (at least one exported)
			*log.Logger
		As Inputs Of (at least one exported)
			func SetLogger(logger Logger) error

	 type MySQLDriver (struct)
		MySQLDriver is exported to make the driver directly accessible.
		In general the driver is used via the database/sql package.

		Methods (total 2)
			( MySQLDriver) Open(dsn string) (driver.Conn, error)
				Open new Connection.
				See https://github.com/go-sql-driver/mysql#dsn-data-source-name for how
				the DSN string is formatted

			( MySQLDriver) OpenConnector(dsn string) (driver.Connector, error)
				OpenConnector implements driver.DriverContext.

		Implements (at least 2)
			 MySQLDriver : database/sql/driver.Driver
			 MySQLDriver : database/sql/driver.DriverContext

	 type MySQLError (struct)
		MySQLError is an error type which represents a single MySQL error

		Fields (total 3)
			Message string
			Number uint16
			SQLState [5]byte
		Methods (total 2)
			(*MySQLError) Error() string
			(*MySQLError) Is(err error) bool
		Implements (at least one exported)
			*MySQLError : error

	 type NullTime sql.NullTime (struct)
		NullTime represents a time.Time that may be NULL.
		NullTime implements the Scanner interface so
		it can be used as a scan destination:
		
			var nt NullTime
			err := db.QueryRow("SELECT time FROM foo WHERE id=?", id).Scan(&nt)
			...
			if nt.Valid {
			   // use nt.Time
			} else {
			   // NULL value
			}
		
		# This NullTime implementation is not driver-specific
		
		Deprecated: NullTime doesn't honor the loc DSN parameter.
		NullTime.Scan interprets a time as UTC, not the loc DSN parameter.
		Use sql.NullTime instead.

		Fields (total 2)
			Time time.Time
			Valid bool
				// Valid is true if Time is not NULL

		Methods (total 2)
			(*NullTime) Scan(value interface{}) (err error)
				Scan implements the Scanner interface.
				The value type must be time.Time or string / []byte (formatted time-string),
				otherwise Scan fails.

			( NullTime) Value() (driver.Value, error)
				Value implements the driver Valuer interface.

		Implements (at least 2)
			*NullTime : database/sql.Scanner
			 NullTime : database/sql/driver.Valuer


Package-Level Functions (total 14)

	 func DeregisterLocalFile(filePath string)
		DeregisterLocalFile removes the given filepath from the allowlist.

	 func DeregisterReaderHandler(name string)
		DeregisterReaderHandler removes the ReaderHandler function with
		the given name from the registry.

	 func DeregisterServerPubKey(name string)
		DeregisterServerPubKey removes the public key registered with the given name.

	 func DeregisterTLSConfig(key string)
		DeregisterTLSConfig removes the tls.Config associated with key.

	 func NewConfig() *Config
		NewConfig creates a new Config and sets default values.

	 func NewConnector(cfg *Config) (driver.Connector, error)
		NewConnector returns new driver.Connector.

	 func ParseDSN(dsn string) (cfg *Config, err error)
		ParseDSN parses the DSN string to a Config

	 func RegisterDial(network string, dial DialFunc)
		RegisterDial registers a custom dial function. It can then be used by the
		network address mynet(addr), where mynet is the registered new network.
		addr is passed as a parameter to the dial function.
		
		Deprecated: users should call RegisterDialContext instead

	 func RegisterDialContext(net string, dial DialContextFunc)
		RegisterDialContext registers a custom dial function. It can then be used by the
		network address mynet(addr), where mynet is the registered new network.
		The current context for the connection and its address is passed to the dial function.

	 func RegisterLocalFile(filePath string)
		RegisterLocalFile adds the given file to the file allowlist,
		so that it can be used by "LOAD DATA LOCAL INFILE <filepath>".
		Alternatively you can allow the use of all local files with
		the DSN parameter 'allowAllFiles=true'
		
			filePath := "/home/gopher/data.csv"
			mysql.RegisterLocalFile(filePath)
			err := db.Exec("LOAD DATA LOCAL INFILE '" + filePath + "' INTO TABLE foo")
			if err != nil {
			...

	 func RegisterReaderHandler(name string, handler func() io.Reader)
		RegisterReaderHandler registers a handler function which is used
		to receive a io.Reader.
		The Reader can be used by "LOAD DATA LOCAL INFILE Reader::<name>".
		If the handler returns a io.ReadCloser Close() is called when the
		request is finished.
		
			mysql.RegisterReaderHandler("data", func() io.Reader {
				var csvReader io.Reader // Some Reader that returns CSV data
				... // Open Reader here
				return csvReader
			})
			err := db.Exec("LOAD DATA LOCAL INFILE 'Reader::data' INTO TABLE foo")
			if err != nil {
			...

	 func RegisterServerPubKey(name string, pubKey *rsa.PublicKey)
		RegisterServerPubKey registers a server RSA public key which can be used to
		send data in a secure manner to the server without receiving the public key
		in a potentially insecure way from the server first.
		Registered keys can afterwards be used adding serverPubKey=<name> to the DSN.
		
		Note: The provided rsa.PublicKey instance is exclusively owned by the driver
		after registering it and may not be modified.
		
			data, err := ioutil.ReadFile("mykey.pem")
			if err != nil {
				log.Fatal(err)
			}
		
			block, _ := pem.Decode(data)
			if block == nil || block.Type != "PUBLIC KEY" {
				log.Fatal("failed to decode PEM block containing public key")
			}
		
			pub, err := x509.ParsePKIXPublicKey(block.Bytes)
			if err != nil {
				log.Fatal(err)
			}
		
			if rsaPubKey, ok := pub.(*rsa.PublicKey); ok {
				mysql.RegisterServerPubKey("mykey", rsaPubKey)
			} else {
				log.Fatal("not a RSA public key")
			}

	 func RegisterTLSConfig(key string, config *tls.Config) error
		RegisterTLSConfig registers a custom tls.Config to be used with sql.Open.
		Use the key as a value in the DSN where tls=value.
		
		Note: The provided tls.Config is exclusively owned by the driver after
		registering it.
		
			rootCertPool := x509.NewCertPool()
			pem, err := ioutil.ReadFile("/path/ca-cert.pem")
			if err != nil {
			    log.Fatal(err)
			}
			if ok := rootCertPool.AppendCertsFromPEM(pem); !ok {
			    log.Fatal("Failed to append PEM.")
			}
			clientCert := make([]tls.Certificate, 0, 1)
			certs, err := tls.LoadX509KeyPair("/path/client-cert.pem", "/path/client-key.pem")
			if err != nil {
			    log.Fatal(err)
			}
			clientCert = append(clientCert, certs)
			mysql.RegisterTLSConfig("custom", &tls.Config{
			    RootCAs: rootCertPool,
			    Certificates: clientCert,
			})
			db, err := sql.Open("mysql", "user@tcp(localhost:3306)/test?tls=custom")

	 func SetLogger(logger Logger) error
		SetLogger is used to set the logger for critical errors.
		The initial logger is os.Stderr.


Package-Level Variables (total 12)

	  var ErrBusyBuffer error
		Various errors the driver might return. Can change between driver versions.

	  var ErrCleartextPassword error
		Various errors the driver might return. Can change between driver versions.

	  var ErrInvalidConn error
		Various errors the driver might return. Can change between driver versions.

	  var ErrMalformPkt error
		Various errors the driver might return. Can change between driver versions.

	  var ErrNativePassword error
		Various errors the driver might return. Can change between driver versions.

	  var ErrNoTLS error
		Various errors the driver might return. Can change between driver versions.

	  var ErrOldPassword error
		Various errors the driver might return. Can change between driver versions.

	  var ErrOldProtocol error
		Various errors the driver might return. Can change between driver versions.

	  var ErrPktSync error
		Various errors the driver might return. Can change between driver versions.

	  var ErrPktSyncMul error
		Various errors the driver might return. Can change between driver versions.

	  var ErrPktTooLarge error
		Various errors the driver might return. Can change between driver versions.

	  var ErrUnknownPlugin error
		Various errors the driver might return. Can change between driver versions.

The pages are generated with Golds v0.6.7. (GOOS=linux GOARCH=amd64)
Golds is a Go 101 project developed by Tapir Liu.
PR and bug reports are welcome and can be submitted to the issue list.
Please follow @Go100and1 (reachable from the left QR code) to get the latest news of Golds.