storage/mysql

MySQL

A MySQL storage driver using database/sql and go-sql-driver/mysql.

Table of Contents

• Signatures
• Examples
• Config
• Default Config

Signatures

func New(config ...Config) Storage

Examples

Import the storage package.

import "github.com/gofiber/storage/mysql"

You can use the following possibilities to create a storage:

// Initialize default config
store := mysql.New()

// Initialize custom config
store := mysql.New(mysql.Config{
	Server:          "127.0.0.1:3306",
	Database:        "fiber",
	Table:           "fiber",
	Drop:            false,
	GCInterval:      10 * time.Second,
})

Config

type Config struct {
	// Server address in <host>:<port> format
	//
	// Optional. Default is "127.0.0.1:3306"
	Server string

	// Server username
	//
	// Optional. Default is ""
	Username string

	// Server password
	//
	// Optional. Default is ""
	Password string

	// Database name
	//
	// Optional. Default is "fiber"
	Database string

	// Table name
	//
	// Optional. Default is "fiber"
	Table string

	// Drop any existing table with the same Table name
	//
	// Optional. Default is false
	Drop bool

	// Time before deleting expired keys
	//
	// Optional. Default is 10 * time.Second
	GCInterval time.Duration
}

Default Config

var ConfigDefault = Config{
	Server:          "127.0.0.1:3306",
	Database:        "fiber",
	Table:           "fiber",
	Drop:            false,
	GCInterval:      10 * time.Second,
}