mrsql

Documentation

Index

• Constants
• func MergeArgs(args ...[]any) []any
• func SQLPartFuncRemoveNil(parts []mrstorage.SQLPartFunc) []mrstorage.SQLPartFunc
• func SequenceName(table DBTableInfo) string
• type DBTableInfo
• type EntityMeta
  • func ParseEntity(logger mrlog.Logger, entity any) (EntityMeta, error)
  • func (e *EntityMeta) MetaOrderBy() *EntityMetaOrderBy
  • func (e *EntityMeta) MetaUpdate() *EntityMetaUpdate
• type EntityMetaOrderBy
  • func NewEntityMetaOrderBy(logger mrlog.Logger, entity any) (*EntityMetaOrderBy, error)
  • func (m *EntityMetaOrderBy) CheckField(name string) bool
  • func (m *EntityMetaOrderBy) DefaultSort() mrtype.SortParams
• type EntityMetaUpdate
  • func NewEntityMetaUpdate(logger mrlog.Logger, entity any) (*EntityMetaUpdate, error)
  • func (m *EntityMetaUpdate) FieldsForUpdate(entity any) ([]string, []any, error)
• type Part
  • func NewPart(argumentNumber int, part mrstorage.SQLPartFunc) *Part
  • func (p *Part) Empty() bool
  • func (p *Part) String() string
  • func (p *Part) ToSQL() (string, []any)
  • func (p *Part) WithPrefix(sql string) mrstorage.SQLPart
  • func (p *Part) WithStartArg(number int) mrstorage.SQLPart

Constants

const (
	ModelNameEntityMetaOrderBy = "EntityMetaOrderBy" // ModelNameEntityMetaOrderBy - название сущности

)

const (
	ModelNameEntityMetaUpdate = "EntityMetaUpdate" // ModelNameEntityMetaUpdate - название сущности

)

Functions

func MergeArgs

func MergeArgs(args ...[]any) []any

MergeArgs - принимает список массивов, формирует из них один линейный массив и возвращает его.

func SQLPartFuncRemoveNil

func SQLPartFuncRemoveNil(parts []mrstorage.SQLPartFunc) []mrstorage.SQLPartFunc

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

func SequenceName

func SequenceName(table DBTableInfo) string

SequenceName - возвращает название последовательности используемой для получения ID.

Types

type DBTableInfo

type DBTableInfo struct {
	Name       string
	PrimaryKey string
}

DBTableInfo - информации о таблице БД.

type EntityMeta

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

EntityMeta - объект для управления динамическим обновлением записей в БД. Информация об обновлении считывается из тегов структуры.

func ParseEntity

func ParseEntity(logger mrlog.Logger, entity any) (EntityMeta, error)

ParseEntity - парсит указанную структуру entity и на основе её тегов создаёт объекты EntityMetaUpdate и EntityMetaOrderBy.

func (*EntityMeta) MetaOrderBy

func (e *EntityMeta) MetaOrderBy() *EntityMetaOrderBy

MetaOrderBy - возвращает метаинформацию о сортировке полей из распарсенной структуры.

func (*EntityMeta) MetaUpdate

func (e *EntityMeta) MetaUpdate() *EntityMetaUpdate

MetaUpdate - возвращает метаинформацию об обновлении полей из распарсенной структуры.

type EntityMetaOrderBy

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

EntityMetaOrderBy - объект для управления порядком следования записей БД. Информация о порядке следования считывается из тегов структуры.

func NewEntityMetaOrderBy

func NewEntityMetaOrderBy(logger mrlog.Logger, entity any) (*EntityMetaOrderBy, error)

NewEntityMetaOrderBy - создаёт объект EntityMetaOrderBy.

func (*EntityMetaOrderBy) CheckField

func (m *EntityMetaOrderBy) CheckField(name string) bool

CheckField - проверяет зарегистрировано ли указанное поле в распарсенной структуре.

func (*EntityMetaOrderBy) DefaultSort

func (m *EntityMetaOrderBy) DefaultSort() mrtype.SortParams

DefaultSort - возвращает данные о сортировке по умолчанию.

type EntityMetaUpdate

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

EntityMetaUpdate - объект для управления динамическим обновлением записей в БД. Информация об обновлении считывается из тегов структуры.

func NewEntityMetaUpdate

func NewEntityMetaUpdate(logger mrlog.Logger, entity any) (*EntityMetaUpdate, error)

NewEntityMetaUpdate - создаёт объект EntityMetaUpdate.

func (*EntityMetaUpdate) FieldsForUpdate

func (m *EntityMetaUpdate) FieldsForUpdate(entity any) ([]string, []any, error)

FieldsForUpdate - возвращает список полей и их значения для использования их при формировании SQL запроса.

type Part

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

Part - часть SQL запроса с используемыми в ней аргументами.

func NewPart

func NewPart(argumentNumber int, part mrstorage.SQLPartFunc) *Part

NewPart - создаёт объект Part.

func (*Part) Empty

func (p *Part) Empty() bool

Empty - проверяет, что в объекте не установлена функция для формирования части SQL.

func (*Part) String

func (p *Part) String() string

String - возвращает часть SQL в виде строки без аргументов (только если есть уверенность, что аргументы не использовались).

func (*Part) ToSQL

func (p *Part) ToSQL() (string, []any)

ToSQL - возвращает часть SQL в виде строки и отдельно используемые аргументы.

func (*Part) WithPrefix

func (p *Part) WithPrefix(sql string) mrstorage.SQLPart

WithPrefix - возвращает часть SQL, перед которым будет добавлен указанный префикс.

func (*Part) WithStartArg

func (p *Part) WithStartArg(number int) mrstorage.SQLPart

WithStartArg - возвращает часть SQL, в котором первый номер его аргументов будет начинаться с указанного номера.