Use "utf8mb4" for MySQL by default (#25432)

TBH, I don't see much difference from `Remove "CHARSET" config option
for MySQL, always use "utf8mb4"` #25413

Close #25413
This commit is contained in:
wxiaoguang 2023-06-22 13:38:23 +08:00 committed by GitHub
parent ffe089432f
commit cb3173a1e9
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
5 changed files with 11 additions and 36 deletions

View file

@ -60,11 +60,6 @@ func LoadDBSetting() {
func loadDBSetting(rootCfg ConfigProvider) { func loadDBSetting(rootCfg ConfigProvider) {
sec := rootCfg.Section("database") sec := rootCfg.Section("database")
Database.Type = DatabaseType(sec.Key("DB_TYPE").String()) Database.Type = DatabaseType(sec.Key("DB_TYPE").String())
defaultCharset := "utf8"
if Database.Type.IsMySQL() {
defaultCharset = "utf8mb4"
}
Database.Host = sec.Key("HOST").String() Database.Host = sec.Key("HOST").String()
Database.Name = sec.Key("NAME").String() Database.Name = sec.Key("NAME").String()
@ -74,9 +69,10 @@ func loadDBSetting(rootCfg ConfigProvider) {
} }
Database.Schema = sec.Key("SCHEMA").String() Database.Schema = sec.Key("SCHEMA").String()
Database.SSLMode = sec.Key("SSL_MODE").MustString("disable") Database.SSLMode = sec.Key("SSL_MODE").MustString("disable")
Database.Charset = sec.Key("CHARSET").In(defaultCharset, []string{"utf8", "utf8mb4"})
if Database.Type.IsMySQL() && defaultCharset != "utf8mb4" { Database.Charset = sec.Key("CHARSET").MustString("utf8mb4")
log.Error("Deprecated database mysql charset utf8 support, please use utf8mb4 or convert utf8 to utf8mb4.") if Database.Type.IsMySQL() && Database.Charset != "utf8mb4" {
log.Error(`Deprecated database mysql charset utf8 support, please use utf8mb4 and convert utf8 database to utf8mb4 by "gitea convert".`)
} }
Database.Path = sec.Key("PATH").MustString(filepath.Join(AppDataPath, "gitea.db")) Database.Path = sec.Key("PATH").MustString(filepath.Join(AppDataPath, "gitea.db"))
@ -101,9 +97,9 @@ func loadDBSetting(rootCfg ConfigProvider) {
// DBConnStr returns database connection string // DBConnStr returns database connection string
func DBConnStr() (string, error) { func DBConnStr() (string, error) {
var connStr string var connStr string
Param := "?" paramSep := "?"
if strings.Contains(Database.Name, Param) { if strings.Contains(Database.Name, paramSep) {
Param = "&" paramSep = "&"
} }
switch Database.Type { switch Database.Type {
case "mysql": case "mysql":
@ -116,15 +112,15 @@ func DBConnStr() (string, error) {
tls = "false" tls = "false"
} }
connStr = fmt.Sprintf("%s:%s@%s(%s)/%s%scharset=%s&parseTime=true&tls=%s", connStr = fmt.Sprintf("%s:%s@%s(%s)/%s%scharset=%s&parseTime=true&tls=%s",
Database.User, Database.Passwd, connType, Database.Host, Database.Name, Param, Database.Charset, tls) Database.User, Database.Passwd, connType, Database.Host, Database.Name, paramSep, Database.Charset, tls)
case "postgres": case "postgres":
connStr = getPostgreSQLConnectionString(Database.Host, Database.User, Database.Passwd, Database.Name, Param, Database.SSLMode) connStr = getPostgreSQLConnectionString(Database.Host, Database.User, Database.Passwd, Database.Name, paramSep, Database.SSLMode)
case "mssql": case "mssql":
host, port := ParseMSSQLHostPort(Database.Host) host, port := ParseMSSQLHostPort(Database.Host)
connStr = fmt.Sprintf("server=%s; port=%s; database=%s; user id=%s; password=%s;", host, port, Database.Name, Database.User, Database.Passwd) connStr = fmt.Sprintf("server=%s; port=%s; database=%s; user id=%s; password=%s;", host, port, Database.Name, Database.User, Database.Passwd)
case "sqlite3": case "sqlite3":
if !EnableSQLite3 { if !EnableSQLite3 {
return "", errors.New("this binary version does not build support for SQLite3") return "", errors.New("this Gitea binary was not built with SQLite3 support")
} }
if err := os.MkdirAll(path.Dir(Database.Path), os.ModePerm); err != nil { if err := os.MkdirAll(path.Dir(Database.Path), os.ModePerm); err != nil {
return "", fmt.Errorf("Failed to create directories: %w", err) return "", fmt.Errorf("Failed to create directories: %w", err)
@ -136,7 +132,7 @@ func DBConnStr() (string, error) {
connStr = fmt.Sprintf("file:%s?cache=shared&mode=rwc&_busy_timeout=%d&_txlock=immediate%s", connStr = fmt.Sprintf("file:%s?cache=shared&mode=rwc&_busy_timeout=%d&_txlock=immediate%s",
Database.Path, Database.Timeout, journalMode) Database.Path, Database.Timeout, journalMode)
default: default:
return "", fmt.Errorf("Unknown database type: %s", Database.Type) return "", fmt.Errorf("unknown database type: %s", Database.Type)
} }
return connStr, nil return connStr, nil

View file

@ -192,11 +192,9 @@ host = Host
user = Username user = Username
password = Password password = Password
db_name = Database Name db_name = Database Name
db_helper = Note to MySQL users: please use the InnoDB storage engine and if you use "utf8mb4", your InnoDB version must be greater than 5.6 .
db_schema = Schema db_schema = Schema
db_schema_helper = Leave blank for database default ("public"). db_schema_helper = Leave blank for database default ("public").
ssl_mode = SSL ssl_mode = SSL
charset = Charset
path = Path path = Path
sqlite_helper = File path for the SQLite3 database.<br>Enter an absolute path if you run Gitea as a service. sqlite_helper = File path for the SQLite3 database.<br>Enter an absolute path if you run Gitea as a service.
reinstall_error = You are trying to install into an existing Gitea database reinstall_error = You are trying to install into an existing Gitea database

View file

@ -98,7 +98,6 @@ func Install(ctx *context.Context) {
form.DbName = setting.Database.Name form.DbName = setting.Database.Name
form.DbPath = setting.Database.Path form.DbPath = setting.Database.Path
form.DbSchema = setting.Database.Schema form.DbSchema = setting.Database.Schema
form.Charset = setting.Database.Charset
curDBType := setting.Database.Type.String() curDBType := setting.Database.Type.String()
var isCurDBTypeSupported bool var isCurDBTypeSupported bool
@ -268,7 +267,6 @@ func SubmitInstall(ctx *context.Context) {
setting.Database.Name = form.DbName setting.Database.Name = form.DbName
setting.Database.Schema = form.DbSchema setting.Database.Schema = form.DbSchema
setting.Database.SSLMode = form.SSLMode setting.Database.SSLMode = form.SSLMode
setting.Database.Charset = form.Charset
setting.Database.Path = form.DbPath setting.Database.Path = form.DbPath
setting.Database.LogSQL = !setting.IsProd setting.Database.LogSQL = !setting.IsProd
@ -382,7 +380,6 @@ func SubmitInstall(ctx *context.Context) {
cfg.Section("database").Key("PASSWD").SetValue(setting.Database.Passwd) cfg.Section("database").Key("PASSWD").SetValue(setting.Database.Passwd)
cfg.Section("database").Key("SCHEMA").SetValue(setting.Database.Schema) cfg.Section("database").Key("SCHEMA").SetValue(setting.Database.Schema)
cfg.Section("database").Key("SSL_MODE").SetValue(setting.Database.SSLMode) cfg.Section("database").Key("SSL_MODE").SetValue(setting.Database.SSLMode)
cfg.Section("database").Key("CHARSET").SetValue(setting.Database.Charset)
cfg.Section("database").Key("PATH").SetValue(setting.Database.Path) cfg.Section("database").Key("PATH").SetValue(setting.Database.Path)
cfg.Section("database").Key("LOG_SQL").SetValue("false") // LOG_SQL is rarely helpful cfg.Section("database").Key("LOG_SQL").SetValue("false") // LOG_SQL is rarely helpful

View file

@ -27,7 +27,6 @@ type InstallForm struct {
DbPasswd string DbPasswd string
DbName string DbName string
SSLMode string SSLMode string
Charset string `binding:"Required;In(utf8,utf8mb4)"`
DbPath string DbPath string
DbSchema string DbSchema string

View file

@ -44,7 +44,6 @@
<div class="inline required field {{if .Err_DbSetting}}error{{end}}"> <div class="inline required field {{if .Err_DbSetting}}error{{end}}">
<label for="db_name">{{.locale.Tr "install.db_name"}}</label> <label for="db_name">{{.locale.Tr "install.db_name"}}</label>
<input id="db_name" name="db_name" value="{{.db_name}}"> <input id="db_name" name="db_name" value="{{.db_name}}">
<span class="help">{{.locale.Tr "install.db_helper"}}</span>
</div> </div>
</div> </div>
@ -69,20 +68,6 @@
</div> </div>
</div> </div>
<div class="gt-hidden" data-db-setting-for="mysql">
<div class="inline required field">
<label>{{.locale.Tr "install.charset"}}</label>
<div class="ui selection database type dropdown">
<input type="hidden" name="charset" value="{{if .charset}}{{.charset}}{{else}}utf8mb4{{end}}">
<div class="default text">utf8mb4</div>
{{svg "octicon-triangle-down" 14 "dropdown icon"}}
<div class="menu">
<div class="item" data-value="utf8mb4">utf8mb4</div>
</div>
</div>
</div>
</div>
<div class="gt-hidden" data-db-setting-for="sqlite3"> <div class="gt-hidden" data-db-setting-for="sqlite3">
<div class="inline required field {{if or .Err_DbPath .Err_DbSetting}}error{{end}}"> <div class="inline required field {{if or .Err_DbPath .Err_DbSetting}}error{{end}}">
<label for="db_path">{{.locale.Tr "install.path"}}</label> <label for="db_path">{{.locale.Tr "install.path"}}</label>