sql

package
v4.6.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jan 7, 2025 License: MIT Imports: 25 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source
var (

	// Errors Справочник ошибок.
	Errors = func() *Error { return errSingleton }
)

Functions

func Free

func Free()

Free Освобождает соединение работы с базой данных. Объект работы с базой данных полностью удаляется из памяти.

func NewLoggerGorm

func NewLoggerGorm(parent *impl) gormLogger.Interface

NewLoggerGorm Создание объекта с интерфейсом gorm.logger.Interface.

Types

type Error

type Error struct {
	dic.Errors

	// ConfigurationIsEmpty Конфигурация подключения к базе данных пустая.
	ConfigurationIsEmpty dic.IError

	// UnknownDatabaseDriver Указан неизвестный или не поддерживаемый драйвер базы данных: ...
	UnknownDatabaseDriver dic.IError

	// UsernameIsEmpty Не указано имя пользователя, для подключения к базе данных.
	UsernameIsEmpty dic.IError

	// WrongConnectionType Указан неизвестный или не поддерживаемый способ подключения к базе данных: ...
	WrongConnectionType dic.IError

	// ConnectError Подключение к базе данных завершилось ошибкой: ...
	ConnectError dic.IError

	// DriverUnImplemented Подключение к базе данных с помощью драйвера ... не создано.
	DriverUnImplemented dic.IError

	// ApplyMigration Применение новых миграций базы данных прервано ошибкой: ...
	ApplyMigration dic.IError

	// UnknownDialect Применение миграций базы данных, настройка диалекта ... прервано ошибкой: ...
	UnknownDialect dic.IError
}

type Implementation

type Implementation struct {
	// contains filtered or unexported fields
}

Implementation Встраиваемая структура в модель базы данных, для лёгкого подключения "по требованию" к базе данных.

func (*Implementation) Gist

func (db *Implementation) Gist() Interface

Gist Возвращается настроенный и готовый к работе интерфейс подключения к базе данных.

func (*Implementation) Gorm

func (db *Implementation) Gorm(opts ...*Option) (ret *gorm.DB)

Gorm Возвращается настроенный и готовый к работе объект ORM gorm.io/gorm.

func (*Implementation) OptionSilent

func (db *Implementation) OptionSilent() *Option

OptionSilent Полное отключение логирования запросов к базе данных.

func (*Implementation) Sqlx

func (db *Implementation) Sqlx() *sqlx.DB

Sqlx Настроенный и готовый к работе объект обёртки над соединением с БД github.com/jmoiron/sqlx.

type Interface

type Interface interface {
	// Close Закрытие соединения с базой данных.
	Close() (err error)

	// E Ошибка соединения с базой данных.
	// Если err==nil - база данных доступна, соединение активно, ошибок нет.
	// Если err!=nil - есть проблема с соединением с базой данных.
	E() (err error)

	// Status Возвращает состояние подключения к базе данных.
	Status() (ret *sql.DBStats)

	// SqlDB Настроенный и готовый к работе бассейн соединений database/sql.
	// Если возвращается nil - есть ошибки, ошибка доступна в функции E()
	SqlDB() (ret *sql.DB)

	// GormDB Настроенный и готовый к работе объект ORM gorm.io/gorm.
	// Если возвращается nil - есть ошибки, ошибка доступна в функции E()
	GormDB() (ret *gorm.DB)

	// SqlxDB Настроенный и готовый к работе объект обёртки над соединением с БД github.com/jmoiron/sqlx.
	// Если возвращается nil - есть ошибки, ошибка доступна в функции E()
	SqlxDB() (ret *sqlx.DB)

	// MigrationUp Применение миграций базы данных.
	MigrationUp() (err error)

	// Errors Справочник ошибок.
	Errors() *Error
}

Interface Интерфейс пакета.

func Get

func Get() Interface

Get Возвращается интерфейс для работы с базой данных. Если база данных доступна, тогда возвращается полностью настроенное и готовое к работе соединение с базой данных. Если база данных не доступна, тогда возвращается объект, методы которого заблокированы до момента установки соединения с базой данных. Параллельно запущен процесс подключения к базе данных, по окончании которого, блокировка методов объекта снимается.

type Option

type Option struct {
	// contains filtered or unexported fields
}

Option Опциональные настройки работы библиотеки.

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL