godal

type AbstractGenericDao struct {
	IGenericDao
	// contains filtered or unexported fields
}

type FilterOperator int

type FilterOpt interface {
}

type FilterOptAnd struct {
	Filters []FilterOpt
}

type FilterOptFieldIsNotNull struct {
	FieldName string
}

type FilterOptFieldIsNull struct {
	FieldName string
}

type FilterOptFieldOpField struct {
	FieldNameLeft  string
	Operator       FilterOperator
	FieldNameRight string
}

type FilterOptFieldOpValue struct {
	FieldName string
	Operator  FilterOperator
	Value     interface{}
}

type FilterOptOr struct {
	Filters []FilterOpt
}

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

type IGenericBo interface {
	// GboIterate iterates over all bo's top level fields.
	//   - If the underlying data is a map, 'callback' is called for each map's entry with reflect.Map is passed as 'kind' parameter.
	//   - If the underlying data is a slice or array, 'callback' is called for each entry with reflect.Slice is passed as 'kind' parameter.
	//
	// Available: since v0.0.2
	GboIterate(callback func(kind reflect.Kind, field interface{}, value interface{}))

	// GboGetAttr retrieves a bo's attribute.
	//   - If 'typ' is not nil, the attribute value is converted to the specified type upon being returned.
	//   - Otherwise, the attribute value is returned as-is.
	GboGetAttr(path string, typ reflect.Type) (interface{}, error)

	// GboGetAttrUnsafe retrieves a bo's attribute as GboGetAttr does, but error is ignored.
	//
	// Available: since v0.0.2
	GboGetAttrUnsafe(path string, typ reflect.Type) interface{}

	// GboGetAttrUnmarshalJson retrieves a bo's attribute, treats attribute value as JSON-encoded and parses it back to Go type.
	//
	// Available: since v0.2.0
	GboGetAttrUnmarshalJson(path string) (interface{}, error)

	// GboGetTimeWithLayout retrieves a bo's attribute as 'time.Time'.
	//
	// If value at 'path' is a datetime represented as a string, this function calls 'time.Parse(...)' to convert the value to 'time.Time' using 'layout'.
	GboGetTimeWithLayout(path, layout string) (time.Time, error)

	// GboSetAttr sets a bo's attribute.
	GboSetAttr(path string, value interface{}) error

	// GboToJson serializes bo's data to JSON string.
	GboToJson() ([]byte, error)

	// GboToJsonUnsafe serializes bo's data to JSON string, ignoring error if any.
	//
	// Available: since v0.1.1
	GboToJsonUnsafe() []byte

	// GboFromJson imports bo's data from a JSON string.
	GboFromJson(js []byte) error

	// GboTransferViaJson copies bo's data to the destination using JSON transformation.
	// Firstly, bo's data is marshaled to JSON data. Then the JSON data is unmarshaled to 'dest'.
	//
	// Note: 'dest' must be a pointer because passing value does not work.
	GboTransferViaJson(dest interface{}) error

	// GboImportViaJson imports bo's data from an external source using JSON transformation.
	// Firstly, src is marshaled to JSON data. Then the JSON data is unmarshaled/imported to bo's attributes.
	GboImportViaJson(src interface{}) error

	// GboImportViaMap imports bo's data from an external map.
	//
	// Available: since v0.4.0
	GboImportViaMap(src map[string]interface{}) error
}

type IGenericDao interface {
	// GdaoCreateFilter creates a filter object to match exactly one specific BO.
	GdaoCreateFilter(storageId string, bo IGenericBo) FilterOpt

	// GdaoDelete removes the specified BO from database store and returns the number of effected items.
	//
	// Upon successful call, this function returns 1 if the BO is removed, and 0 if the BO does not exist.
	GdaoDelete(storageId string, bo IGenericBo) (int, error)

	// GdaoDeleteMany removes many BOs from database store at once and returns the number of effected items.
	//
	// Upon successful call, this function may return 0 if no BO matches the filter.
	GdaoDeleteMany(storageId string, filter FilterOpt) (int, error)

	// GdaoFetchOne fetches one BO from database store.
	//
	// Filter should match exactly one BO. If there are more than one BO matching the filter, only the first one is returned.
	GdaoFetchOne(storageId string, filter FilterOpt) (IGenericBo, error)

	// GdaoFetchMany fetches many BOs from database store and returns them as a list.
	//
	// startOffset (0-based) and numItems are for paging. numItems <= 0 means no limit. Be noted that some databases do not support startOffset nor paging at all.
	GdaoFetchMany(storageId string, filter FilterOpt, sorting *SortingOpt, startOffset, numItems int) ([]IGenericBo, error)

	// GdaoCreate persists one BO to database store and returns the number of saved items.
	//
	// If the BO already existed, this function does not modify the existing one and should return (0, ErrGdaoDuplicatedEntry).
	GdaoCreate(storageId string, bo IGenericBo) (int, error)

	// GdaoUpdate updates one existing BO and returns the number of updated items.
	//
	// If the BO does not exist, this function does not create new BO and should return (0, nil).
	// If update causes data integrity violation, this function should return (0, ErrGdaoDuplicatedEntry).
	GdaoUpdate(storageId string, bo IGenericBo) (int, error)

	// GdaoSave persists one BO to database store and returns the number of saved items.
	//
	// If the BO already existed, this function replaces the existing one; otherwise new BO is created.
	// If data integrity violation occurs, this function should return (0, ErrGdaoDuplicatedEntry)
	GdaoSave(storageId string, bo IGenericBo) (int, error)

	// GetRowMapper returns the IRowMapper associated with the DAO.
	//
	// Available since v0.3.0.
	GetRowMapper() IRowMapper
}

type IRowMapper interface {
	// ToRow transforms a IGenericBo to a row data suitable for persisting to database store.
	ToRow(storageId string, bo IGenericBo) (interface{}, error)

	// ToBo transforms a database row to IGenericBo.
	ToBo(storageId string, row interface{}) (IGenericBo, error)

	// ColumnsList returns list of a column names corresponding to a database store.
	ColumnsList(storageId string) []string

	// ToDbColName maps a IGenericBo field name to the corresponding column name for the database store.
	//
	// Available since v0.5.0
	ToDbColName(storageId, fieldName string) string

	// ToBoFieldName maps a database store's column name to the corresponding IGenericBo field name.
	//
	// Available since v0.5.0
	ToBoFieldName(storageId, colName string) string
}

type SortingField struct {
	FieldName  string
	Descending bool
}

type SortingOpt struct {
	Fields []*SortingField
}