github.com/ecodeclub/eorm@v0.0.2-0.20231001112437-dae71da914d0/internal/errs/error.go

// Copyright 2021 ecodeclub
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

package errs

import (
	"errors"
	"fmt"
)

var (
	ErrPointerOnly = errors.New("eorm: 只支持指向结构体的一级指针")
	errValueNotSet = errors.New("eorm: 值未设置")
	ErrNoRows      = errors.New("eorm: 未找到数据")
	// ErrTooManyColumns 过多列
	// 一般是查询的列多于结构体的列
	ErrTooManyColumns = errors.New("eorm: 过多列")

	// ErrCombinationIsNotStruct 不支持的组合类型，eorm 只支持结构体组合
	ErrCombinationIsNotStruct            = errors.New("eorm: 不支持的组合类型，eorm 只支持结构体组合")
	ErrMissingShardingKey                = errors.New("eorm: sharding key 未设置")
	ErrOnlyResultOneQuery                = errors.New("eorm: 只能生成一个 SQL")
	ErrUnsupportedTooComplexQuery        = errors.New("eorm: 暂未支持太复杂的查询")
	ErrSlaveNotFound                     = errors.New("eorm: slave不存在")
	ErrNotGenShardingQuery               = errors.New("eorm: 未生成 sharding query")
	ErrNotCompleteTxBeginner             = errors.New("eorm: 未实现 TxBeginner 接口")
	ErrInsertShardingKeyNotFound         = errors.New("eorm: insert语句中未包含sharding key")
	ErrInsertFindingDst                  = errors.New("eorm: 一行数据只能插入一个表")
	ErrUnsupportedAssignment             = errors.New("eorm: 不支持的 assignment")
	ErrUnsupportedDistributedTransaction = errors.New("eorm: 不支持的分布式事务类型")
)

func NewErrDBNotEqual(oldDB, tgtDB string) error {
	return fmt.Errorf("eorm:禁止跨库操作： %s 不等于 %s ", oldDB, tgtDB)
}

func NewErrNotCompleteFinder(name string) error {
	return fmt.Errorf("eorm: %s 未实现 Finder 接口", name)
}

func NewErrNotFoundTargetDataSource(name string) error {
	return fmt.Errorf("eorm: 未发现目标 data dource %s", name)
}

func NewErrNotFoundTargetDB(name string) error {
	return fmt.Errorf("eorm: 未发现目标 DB %s", name)
}

func NewErrUpdateShardingKeyUnsupported(field string) error {
	return fmt.Errorf("eorm: ShardingKey `%s` 不支持更新", field)
}

func NewFieldConflictError(field string) error {
	return fmt.Errorf("eorm: `%s`列冲突", field)
}

// NewInvalidFieldError 返回代表未知字段的错误。
// 通常来说，是字段名没写对
// 注意区分 NewInvalidColumnError
func NewInvalidFieldError(field string) error {
	return fmt.Errorf("eorm: 未知字段 %s", field)
}

// NewInvalidColumnError 返回代表未知列名的错误
// 通常来说，是列名不对
// 注意区分 NewInvalidFieldError
func NewInvalidColumnError(column string) error {
	return fmt.Errorf("eorm: 未知列 %s", column)
}

func NewValueNotSetError() error {
	return errValueNotSet
}

// NewUnsupportedDriverError 不支持驱动类型
func NewUnsupportedDriverError(driver string) error {
	return fmt.Errorf("eorm: 不支持driver类型 %s", driver)
}

// NewUnsupportedTableReferenceError 不支持的TableReference类型
func NewUnsupportedTableReferenceError(table any) error {
	return fmt.Errorf("eorm: 不支持的TableReference类型 %v", table)
}

func NewErrUnsupportedExpressionType() error {
	return fmt.Errorf("eorm: 不支持 Expression")
}

func NewMustSpecifyColumnsError() error {
	return fmt.Errorf("eorm: 复合查询如 JOIN 查询、子查询必须指定要查找的列，即指定 SELECT xxx 部分")
}

func NewUnsupportedOperatorError(op string) error {
	return fmt.Errorf("eorm: 不支持的 operator %v", op)
}

func NewInvalidDSNError(dsn string) error {
	return fmt.Errorf("eorm: 不正确的 DSN %s", dsn)
}

func NewFailedToGetSlavesFromDNS(err error) error {
	return fmt.Errorf("eorm: 从DNS中解析从库失败 %w", err)
}

func NewErrScanWrongDestinationArguments(expect int, actual int) error {
	return fmt.Errorf("eorm: Scan 方法收到过多或者过少的参数，预期 %d，实际 %d", expect, actual)
}