mrstorage

Documentation

Index

• type DBConn
• type DBConnManager
• type DBQueryRow
• type DBQueryRows
• type DBStatProvider
• type DBTxManager
• type FileProvider
• type FileProviderAPI
• type FileProviderConn
• type FileProviderPool
  • func NewFileProviderPool() *FileProviderPool
  • func (p *FileProviderPool) Close() (err error)
  • func (p *FileProviderPool) Ping(ctx context.Context) error
  • func (p *FileProviderPool) ProviderAPI(name string) (FileProviderAPI, error)
  • func (p *FileProviderPool) Register(name string, provider FileProvider) error
• type MetaGetter
• type SQLBuilderCondition
• type SQLBuilderLimit
• type SQLBuilderOrderBy
• type SQLBuilderPart
• type SQLBuilderPartFunc
  • func SQLBuilderPartFuncRemoveNil(parts []SQLBuilderPartFunc) []SQLBuilderPartFunc
• type SQLBuilderSelect
• type SQLBuilderSet
• type SQLBuilderUpdate
• type SQLBuilderWhere
• type SQLSelectParams

Types

type DBConn

type DBConn interface {
	Query(ctx context.Context, sql string, args ...any) (DBQueryRows, error)
	QueryRow(ctx context.Context, sql string, args ...any) DBQueryRow
	Exec(ctx context.Context, sql string, args ...any) error
}

DBConn - соединение с БД с возможностью выполнения запросов.

type DBConnManager

type DBConnManager interface {
	Conn(ctx context.Context) DBConn
	DBTxManager
}

DBConnManager - менеджер соединений с БД.

type DBQueryRow

type DBQueryRow interface {
	Scan(dest ...any) error
}

DBQueryRow - результат запроса состоящий из одной записи.

type DBQueryRows

type DBQueryRows interface {
	Next() bool
	Scan(dest ...any) error
	Err() error
	Close()
}

DBQueryRows - результат запроса в виде списка записей.

type DBStatProvider

type DBStatProvider interface {
	AcquireCount() int64
	AcquireDuration() time.Duration
	AcquiredConns() int32
	CanceledAcquireCount() int64
	ConstructingConns() int32
	EmptyAcquireCount() int64
	IdleConns() int32
	MaxConns() int32
	TotalConns() int32
	NewConnsCount() int64
	MaxLifetimeDestroyCount() int64
	MaxIdleDestroyCount() int64
}

DBStatProvider - провайдер статистики работы DB.

type DBTxManager

type DBTxManager interface {
	Do(ctx context.Context, job func(ctx context.Context) error) error
}

DBTxManager - менеджер транзакций, позволяет исполнять несколько независимых запросов в рамках одной транзакции.

type FileProvider

type FileProvider interface {
	FileProviderConn
	FileProviderAPI
}

FileProvider - файловый провайдер.

type FileProviderAPI

type FileProviderAPI interface {
	Info(ctx context.Context, filePath string) (mrtype.FileInfo, error)
	Download(ctx context.Context, filePath string) (mrtype.File, error)
	DownloadFile(ctx context.Context, filePath string) (io.ReadCloser, error)
	Upload(ctx context.Context, file mrtype.File) error
	Remove(ctx context.Context, filePath string) error
}

FileProviderAPI - файловый провайдер с возможностью загрузки, скачивания, удаления файла.

type FileProviderConn

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

FileProviderConn - управление открытым соединением файлового провайдера.

type FileProviderPool

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

FileProviderPool - пул файловых провайдеров, позволяет хранить файловые провайдеры предназначенные для различных целей.

func NewFileProviderPool

func NewFileProviderPool() *FileProviderPool

NewFileProviderPool - создаёт объект FileProviderPool.

func (*FileProviderPool) Close

func (p *FileProviderPool) Close() (err error)

Close - закрывает текущие соединения всех зарегистрированных провайдеров.

func (*FileProviderPool) Ping

func (p *FileProviderPool) Ping(ctx context.Context) error

Ping - проверяет работоспособность всех зарегистрированных провайдеров.

func (*FileProviderPool) ProviderAPI

func (p *FileProviderPool) ProviderAPI(name string) (FileProviderAPI, error)

ProviderAPI - возвращает API провайдера по его имени или ошибку, если он не был найден.

func (*FileProviderPool) Register

func (p *FileProviderPool) Register(name string, provider FileProvider) error

Register - регистрирует провайдера по его имени.

type MetaGetter

type MetaGetter interface {
	TableName() string
	PrimaryName() string
	Condition() SQLBuilderPart
}

MetaGetter - интерфейс для предоставления информации о таблице БД.

type SQLBuilderCondition

type SQLBuilderCondition interface {
	Where(f func(w SQLBuilderWhere) SQLBuilderPartFunc) SQLBuilderPart
}

SQLBuilderCondition - помощник для построения условий объединяющий SQLBuilderWhere выражения.

type SQLBuilderLimit

type SQLBuilderLimit interface {
	OffsetLimit(index, size uint64) SQLBuilderPartFunc
}

SQLBuilderLimit - построитель выражений используемых в LIMIT.

type SQLBuilderOrderBy

type SQLBuilderOrderBy interface {
	Join(fields ...SQLBuilderPartFunc) SQLBuilderPartFunc
	Field(name string, direction mrenum.SortDirection) SQLBuilderPartFunc
}

SQLBuilderOrderBy - построитель выражений используемых в ORDER BY.

type SQLBuilderPart

type SQLBuilderPart interface {
	WithPart(sep string, next SQLBuilderPart) SQLBuilderPart
	WithPrefix(value string) SQLBuilderPart
	WithParam(number int) SQLBuilderPart
	Empty() bool
	ToSQL() (string, []any)
	String() string
}

SQLBuilderPart - построитель запросов.

type SQLBuilderPartFunc

type SQLBuilderPartFunc func(paramNumber int) (string, []any)

SQLBuilderPartFunc - часть запроса зависящая от параметров.

func SQLBuilderPartFuncRemoveNil

func SQLBuilderPartFuncRemoveNil(parts []SQLBuilderPartFunc) []SQLBuilderPartFunc

SQLBuilderPartFuncRemoveNil - удаляет все nil элементы из указанного массива.

type SQLBuilderSelect

type SQLBuilderSelect interface {
	SQLBuilderCondition
	OrderBy(f func(o SQLBuilderOrderBy) SQLBuilderPartFunc) SQLBuilderPart
	Limit(f func(p SQLBuilderLimit) SQLBuilderPartFunc) SQLBuilderPart
}

SQLBuilderSelect - помощник для построения SELECT запросов.

type SQLBuilderSet

type SQLBuilderSet interface {
	Join(fields ...SQLBuilderPartFunc) SQLBuilderPartFunc
	Field(name string, value any) SQLBuilderPartFunc
	Fields(names []string, args []any) SQLBuilderPartFunc
}

SQLBuilderSet - построитель выражений используемых в SET (список поле=значение через запятую).

type SQLBuilderUpdate

type SQLBuilderUpdate interface {
	Set(f func(s SQLBuilderSet) SQLBuilderPartFunc) SQLBuilderPart
	SetFromEntity(entity any) (SQLBuilderPart, error)
	SetFromEntityWith(entity any, extFields func(s SQLBuilderSet) SQLBuilderPartFunc) (SQLBuilderPart, error)
	SQLBuilderCondition
}

SQLBuilderUpdate - помощник для построения UPDATE запросов.

type SQLBuilderWhere

type SQLBuilderWhere interface {
	JoinAnd(conds ...SQLBuilderPartFunc) SQLBuilderPartFunc
	JoinOr(conds ...SQLBuilderPartFunc) SQLBuilderPartFunc

	Expr(expr string) SQLBuilderPartFunc
	ExprWithValue(expr string, value any) SQLBuilderPartFunc

	Equal(name string, value any) SQLBuilderPartFunc
	NotEqual(name string, value any) SQLBuilderPartFunc
	Less(name string, value any) SQLBuilderPartFunc
	LessOrEqual(name string, value any) SQLBuilderPartFunc
	Greater(name string, value any) SQLBuilderPartFunc
	GreaterOrEqual(name string, value any) SQLBuilderPartFunc

	FilterEqualString(name, value string) SQLBuilderPartFunc
	FilterEqualInt64(name string, value, empty int64) SQLBuilderPartFunc
	FilterEqualUUID(name string, value uuid.UUID) SQLBuilderPartFunc
	FilterEqualBool(name string, value *bool) SQLBuilderPartFunc
	FilterLike(name, value string) SQLBuilderPartFunc
	FilterLikeFields(names []string, value string) SQLBuilderPartFunc
	FilterRangeInt64(name string, value mrtype.RangeInt64, empty int64) SQLBuilderPartFunc
	FilterRangeFloat64(name string, value mrtype.RangeFloat64, empty, qualityThreshold float64) SQLBuilderPartFunc
	// FilterAnyOf - 'values' support only slices else the func returns nil
	FilterAnyOf(name string, values any) SQLBuilderPartFunc
}

SQLBuilderWhere - построитель выражений используемых в WHERE.

type SQLSelectParams

type SQLSelectParams struct {
	Where   SQLBuilderPart
	OrderBy SQLBuilderPart
	Limit   SQLBuilderPart
}

SQLSelectParams - параметры используемы при построении SELECT запросов.