github.com/pingcap/tiflow@v0.0.0-20240520035814-5bf52d54e205/engine/pkg/dbutil/config.go (about)

     1  // Copyright 2022 PingCAP, Inc.
     2  //
     3  // Licensed under the Apache License, Version 2.0 (the "License");
     4  // you may not use this file except in compliance with the License.
     5  // You may obtain a copy of the License at
     6  //
     7  //     http://www.apache.org/licenses/LICENSE-2.0
     8  //
     9  // Unless required by applicable law or agreed to in writing, software
    10  // distributed under the License is distributed on an "AS IS" BASIS,
    11  // See the License for the specific language governing permissions and
    12  // limitations under the License.
    13  
    14  package dbutil
    15  
    16  import "time"
    17  
    18  const (
    19  	defaultConnMaxIdleTime = 1 * time.Minute
    20  	defaultConnMaxLifeTime = 12 * time.Hour
    21  	defaultMaxIdleConns    = 3
    22  	defaultMaxOpenConns    = 7
    23  	// TODO: more params for mysql connection
    24  )
    25  
    26  // DBConfig defines some configuration used in database connection
    27  // refer to: https://pkg.go.dev/database/sql#SetConnMaxIdleTime
    28  type DBConfig struct {
    29  	ConnMaxIdleTime time.Duration `toml:"conn-max-idle-time" json:"conn-max-idle-time"`
    30  	ConnMaxLifeTime time.Duration `toml:"conn-max-life-time" json:"conn-max-life-time"`
    31  	MaxIdleConns    int           `toml:"max-idle-conns" json:"max-idle-conns"`
    32  	MaxOpenConns    int           `toml:"max-open-conns" json:"max-open-conns"`
    33  }
    34  
    35  // DefaultDBConfig creates a default DBConfig
    36  func DefaultDBConfig() *DBConfig {
    37  	return &DBConfig{
    38  		ConnMaxIdleTime: defaultConnMaxIdleTime,
    39  		ConnMaxLifeTime: defaultConnMaxLifeTime,
    40  		MaxIdleConns:    defaultMaxIdleConns,
    41  		MaxOpenConns:    defaultMaxOpenConns,
    42  	}
    43  }