1

var Bool boolType

1

var DefaultParameterConverter defaultConverter

1

var ErrBadConn = errors.New("driver: bad connection")

1

var ErrRemoveArgument = errors.New("driver: remove argument from query")

1

var ErrSkip = errors.New("driver: skip fast-path; continue as if unimplemented")

1

var Int32 int32Type

1

var ResultNoRows noRows

1

var String stringType

1

func IsScanValue(v any) bool

1

func IsValue(v any) bool

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17

type Conn interface {
	// Prepare 返回一个准备好的语句，与此连接绑定。
	Prepare(query string) (Stmt, error)

	// Close 使任何当前的准备语句和事务无效，标记此连接不再使用。
	//
	// 因为sql包维护一个空闲连接池，并且仅在空闲连接过多时调用Close，
    // 所以驱动程序不需要执行自己的连接缓存。
	//
	// 驱动程序必须确保Close调用所做的所有网络调用不会无限期地阻塞(例如，应用超时)。
	Close() error

    // Begin 启动并返回一个新的事务。
    //
    // 已弃用：驱动程序应该实现 ConnBeginTx 代替(或同时实现)。
	Begin() (Tx, error)
}

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11

type ConnBeginTx interface {
    // BeginTx 启动并返回一个新的事务。
    // 如果用户取消了上下文，sql包将在丢弃和关闭连接之前调用Tx.Rollback。
    //
    // 这必须检查opts.Isolation以确定是否有设置隔离级别。如果驱动程序不支持非默认级别，并且已设置一个级别，
    // 或者存在一个不支持的非默认隔离级别，则必须返回一个错误。
    //
    // 这还必须检查opts.ReadOnly以确定只读值是否为true，以设置只读事务属性(如果受支持)，
    // 或者如果不支持，则返回错误。
	BeginTx(ctx context.Context, opts TxOptions) (Tx, error)
}

1
2
3
4
5

type ConnPrepareContext interface {
    // PrepareContext 返回一个准备好的语句，与此连接绑定。
    // context 是用于准备语句的，它不能在语句本身中存储上下文。
	PrepareContext(ctx context.Context, query string) (Stmt, error)
}

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16

type Connector interface {
    // Connect 返回到数据库的连接。
    // Connect 可以返回缓存的连接(先前关闭的连接)，但这样做是不必要的；
    // sql 包维护一个空闲连接池，以便有效地重复使用。
    //
    // 提供的 context.Context 仅用于拨号目的
    //(请参阅 net.DialContext)，不应存储或用于其他目的。
    // 在拨号时仍应使用默认超时，因为连接池可以异步地调用 Connect 到任何查询。
    //
    // 返回的连接只由一个 goroutine 使用。
	Connect(context.Context) (Conn, error)

    // Driver 返回 Connector 的基础 Driver，
    // 主要是为了与 sql.DB 上的 Driver 方法保持兼容性。
	Driver() Driver
}

 1
 2
 3
 4
 5
 6
 7
 8
 9
10

type Driver interface {
    // Open 返回到数据库的新连接。
    // 名称是驱动程序特定格式的字符串。
    //
    // Open 可以返回缓存的连接(先前关闭的连接)，但这样做是不必要的；
    // sql 包维护一个空闲连接池，以便有效地重复使用。
    //
    // 返回的连接只由一个 goroutine 使用。
	Open(name string) (Conn, error)
}

1
2
3
4
5
6

type DriverContext interface {
	// OpenConnector must parse the name in the same format that Driver.Open
	// parses the name parameter.
    // OpenConnector必须以Driver.Open解析名称参数的相同格式解析名称。
	OpenConnector(name string) (Connector, error)
}

1
2
3

type ExecerContext interface {
	ExecContext(ctx context.Context, query string, args []NamedValue) (Result, error)
}

1

type IsolationLevel int

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12

type NamedValue struct {
    // 如果 Name 不为空，应该用于参数标识符，而不是位置。
    //
    // Name 不会有符号前缀。
	Name string

	// 参数的序号位置，从一开始计数，并始终设置。
	Ordinal int	

    // Value是参数的值。
	Value Value
}

1
2
3
4
5
6

type NamedValueChecker interface {
    // CheckNamedValue 在将参数传递给驱动程序之前调用，
    // 并在任何 ColumnConverter 的位置调用。
    // CheckNamedValue 必须做类型验证和转换，以适合驱动程序。
	CheckNamedValue(*NamedValue) error
}

1
2
3

type NotNull struct {
	Converter ValueConverter
}

1

func (n NotNull) ConvertValue(v any) (Value, error)

1
2
3

type Null struct {
	Converter ValueConverter
}

1

func (n Null) ConvertValue(v any) (Value, error)

1
2
3

type Pinger interface {
	Ping(ctx context.Context) error
}

1
2
3

type QueryerContext interface {
	QueryContext(ctx context.Context, query string, args []NamedValue) (Rows, error)
}

1
2
3
4
5
6
7
8

type Result interface {
	// LastInsertId 返回数据库生成的自增 ID，
	// 比如在插入一个带有主键的表时。
	LastInsertId() (int64, error)

	// RowsAffected 返回由查询所影响的行数。
	RowsAffected() (int64, error)
}

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17

type Rows interface {
	// Columns 返回列的名称。
    // 结果集中列的数量从切片的长度中推断出来。如果特定列的名称未知，则该项应返回空字符串。
	Columns() []string

	// Close 关闭行迭代器。
	Close() error

    // Next 用来将下一行数据填充到提供的切片中。
    // 提供的切片将与 Columns() 的宽度相同。
    //
    // Next 应在没有更多行时返回 io.EOF。
    //
    // 在 Next 之外不应写入 dest。
    // 在关闭 Rows 时要小心，以免修改 dest 中保存的缓冲区。
	Next(dest []Value) error
}

1

type RowsAffected int64

1

func (RowsAffected) LastInsertId() (int64, error)

1

func (v RowsAffected) RowsAffected() (int64, error)

1
2
3
4

type RowsColumnTypeDatabaseTypeName interface {
	Rows
	ColumnTypeDatabaseTypeName(index int) string
}

1
2
3
4

type RowsColumnTypeLength interface {
	Rows
	ColumnTypeLength(index int) (length int64, ok bool)
}

1
2
3
4

type RowsColumnTypeNullable interface {
	Rows
	ColumnTypeNullable(index int) (nullable, ok bool)
}

1
2
3
4

type RowsColumnTypePrecisionScale interface {
	Rows
	ColumnTypePrecisionScale(index int) (precision, scale int64, ok bool)
}

1
2
3
4

type RowsColumnTypeScanType interface {
	Rows
	ColumnTypeScanType(index int) reflect.Type
}

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13

type RowsNextResultSet interface {
	Rows

	// HasNextResultSet在当前结果集结束时调用，
    // 报告当前结果集之后是否还有另一个结果集。
	HasNextResultSet() bool

	// NextResultSet将驱动程序推进到下一个结果集，
    // 即使当前结果集还有剩余行。
    //
    // 当没有更多的结果集时，NextResultSet应该返回io.EOF。
	NextResultSet() error
}

1
2
3
4
5
6

type SessionResetter interface {
	// ResetSession在连接之前执行查询时调用，
    // 如果连接之前已被使用。
    // 如果驱动程序返回ErrBadConn，则连接将被丢弃。
	ResetSession(ctx context.Context) error
}

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30

type Stmt interface {
	// Close关闭预处理语句。
    //
    // 从 Go 1.1 开始，如果预处理语句正在被任何查询使用，
    // 则不会关闭预处理语句。
    //
    // 驱动程序必须确保 Close 所做的所有网络调用不会无限期地阻塞(例如，应用超时)。
	Close() error

	// NumInput 返回占位符参数的数量。
    //
    // 如果 NumInput 返回 >= 0，
    // 则 sql 包将检查调用者的参数计数，
    // 并在调用预处理语句的 Exec 或 Query 方法之前向调用者返回错误。
    //
    // 如果驱动程序不知道其占位符的数量，
    // 则 NumInput 也可以返回-1。在这种情况下，
    // sql 包将不会检查 Exec 或 Query 参数计数。
	NumInput() int

	// Exec 执行不返回行的查询，例如 INSERT 或 UPDATE。
	//
	// 已弃用：驱动程序应该实现 StmtExecContext(或另外实现)。
	Exec(args []Value) (Result, error)

	// Query 执行可能返回行的查询，例如 SELECT。
	//
	// 已弃用：驱动程序应该实现 StmtQueryContext(或另外实现)。
	Query(args []Value) (Rows, error)
}

1
2
3
4
5

type StmtExecContext interface {
	// ExecContext方法执行不返回行的查询，例如INSERT或UPDATE。
	// ExecContext方法必须遵守上下文超时并在取消时返回。
	ExecContext(ctx context.Context, args []NamedValue) (Result, error)
}

1
2
3
4
5

type StmtQueryContext interface {
	// QueryContext方法执行可能返回行的查询，例如SELECT。
	// QueryContext方法必须遵守上下文超时并在取消时返回。
	QueryContext(ctx context.Context, args []NamedValue) (Rows, error)
}

1
2
3
4

type Tx interface {
	Commit() error
	Rollback() error
}

1
2
3
4

type TxOptions struct {
	Isolation IsolationLevel
	ReadOnly  bool
}

1
2
3
4
5

type Validator interface {
	// IsValid方法在将连接放入连接池之前调用。
    // 如果返回false，则连接将被丢弃。
	IsValid() bool
}

1

type Value any

1
2
3
4

type ValueConverter interface {
	// ConvertValue方法将一个值转换为driver.Value。
	ConvertValue(v any) (Value, error)
}

1
2
3
4
5

type Valuer interface {
    // Value方法返回一个driver.Value。
    // Value方法不得panic。
	Value() (Value, error)
}