github.com/pingcap/tiflow@v0.0.0-20240520035814-5bf52d54e205/dm/pkg/terror/adapter.go (about)

     1  // Copyright 2019 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 terror
    15  
    16  import (
    17  	"database/sql/driver"
    18  
    19  	"github.com/go-sql-driver/mysql"
    20  	"github.com/pingcap/errors"
    21  )
    22  
    23  // DBErrorAdaptArgs is an adapter to change raw database error to *Error object.
    24  // If err is already an *Error object, return it directly.
    25  func DBErrorAdaptArgs(err error, defaultErr *Error, args ...interface{}) error {
    26  	if err == nil {
    27  		return nil
    28  	}
    29  	if e, ok := err.(*Error); ok {
    30  		return e
    31  	}
    32  	causeErr := errors.Cause(err)
    33  	switch causeErr {
    34  	case driver.ErrBadConn:
    35  		return ErrDBBadConn.Delegate(err, args...)
    36  	case mysql.ErrInvalidConn:
    37  		return ErrDBInvalidConn.Delegate(err, args...)
    38  	default:
    39  		return defaultErr.Delegate(err, args...)
    40  	}
    41  }
    42  
    43  // DBErrorAdapt is an adapter to change raw database error to *Error object.
    44  // If err is already an *Error object, return it directly.
    45  func DBErrorAdapt(err error, scope ErrScope, defaultErr *Error, args ...interface{}) error {
    46  	return WithScope(DBErrorAdaptArgs(err, defaultErr, args...), scope)
    47  }