mrstorage

Documentation

Index

• type DBConn
• type DBQuery
• type DBQueryRow
• type DBQueryRows
• type DBTransaction
• type FileProviderAPI
• type FileProviderPool
  • func NewFileProviderPool() *FileProviderPool
  • func (p *FileProviderPool) Provider(name string) (FileProviderAPI, error)
  • func (p *FileProviderPool) Register(name string, provider FileProviderAPI) error
• type SqlBuilderOrderBy
• type SqlBuilderPager
• 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 {
	Begin(ctx context.Context) (DBTransaction, error)
	DBQuery
}

type DBQuery

type DBQuery 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
}

type DBQueryRow

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

type DBQueryRows

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

type DBTransaction

type DBTransaction interface {
	Commit(ctx context.Context) error
	Rollback(ctx context.Context) error
	DBQuery
}

type FileProviderAPI

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

type FileProviderPool

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

func NewFileProviderPool

func NewFileProviderPool() *FileProviderPool

func (*FileProviderPool) Provider

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

func (*FileProviderPool) Register

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

type SqlBuilderOrderBy

type SqlBuilderOrderBy interface {
	WrapWithDefault(field SqlBuilderPartFunc) SqlBuilderPartFunc
	Join(fields ...SqlBuilderPartFunc) SqlBuilderPartFunc
	Field(name string, direction mrenum.SortDirection) SqlBuilderPartFunc
}

type SqlBuilderPager

type SqlBuilderPager interface {
	OffsetLimit(index, size uint64) SqlBuilderPartFunc
}

type SqlBuilderPart

type SqlBuilderPart interface {
	WithPrefix(value string) SqlBuilderPart
	Param(number int) SqlBuilderPart
	Empty() bool
	ToSql() (string, []any)
	fmt.Stringer
}

type SqlBuilderPartFunc

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

func SqlBuilderPartFuncRemoveNil

func SqlBuilderPartFuncRemoveNil(parts []SqlBuilderPartFunc) []SqlBuilderPartFunc

type SqlBuilderSelect

type SqlBuilderSelect interface {
	Where(f func(w SqlBuilderWhere) SqlBuilderPartFunc) SqlBuilderPart
	OrderBy(f func(o SqlBuilderOrderBy) SqlBuilderPartFunc) SqlBuilderPart
	Pager(f func(p SqlBuilderPager) SqlBuilderPartFunc) SqlBuilderPart
}

type SqlBuilderSet

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

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)
}

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
	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
	// FilterAnyOf - 'values' support only slices else the func returns nil
	FilterAnyOf(name string, values any) SqlBuilderPartFunc
}

type SqlSelectParams

type SqlSelectParams struct {
	Where   SqlBuilderPart
	OrderBy SqlBuilderPart
	Pager   SqlBuilderPart
}