storage

README

storage

Documentation

Index

• Constants
• type Factory
• type Iterator
• type Query
• type Result
• type Storage
• type Table
• type Transaction

Constants

const (
	ErrEmptyResult = errors.Const("empty query result")
)

Types

type Factory

type Factory interface {
	// Storage - возвращает клиента базы данных
	Storage(dsn string) (Storage, error)
}

Factory - абстрактная фабрика клиентов

type Iterator

type Iterator interface {
	io.Closer
	// Next - перемещает курсор итератора на следующий элемент
	Next(ctx context.Context) bool
	// Err - возвращает ошибку итератора, если такая имела место
	Err() error
	// Decode приводит значение текущего элемента итерации к указанному типу
	Decode(result any) error
}

Iterator интерфейс итератора по многоэлементному результату запроса

type Query

type Query interface {
	fmt.Stringer
	// Query - возвращает запрос
	Query() interface{}
	// Params Возвращает параметры запроса
	Params() interface{}
}

type Result

type Result []map[string]any

type Storage

type Storage interface {
	io.Closer
	// Begin Стартует и возвращает новую транзакцию
	Begin(ctx context.Context, opts ...any) (transaction Transaction, err error)
	// Exec Выполняет запрос который ничего не возвращает
	Exec(ctx context.Context, query Query) (sql.Result, error)
	// Query - выполняет запрос производящий действия в базе, с возможностью вернуть произвольный результат
	Query(ctx context.Context, query Query, result any) error
	// Iterate возвращает итератор по результату запроса
	Iterate(ctx context.Context, query Query) (Iterator, error)
}

type Table

type Table struct {
	Headers []string
	Rows    [][]any
}

type Transaction

type Transaction interface {
	// Context - возвращает контекст транзакции
	Context() context.Context
	// Commit Фиксирует текущую транзакцию
	Commit(ctx context.Context) error
	// Rollback Откатывает текущую транзакцию
	Rollback(ctx context.Context) error
}

Transaction интерфейс транзакции базы данных