repository

type Filter struct {
	// Template contains a filter template.
	// SQL:
	//   Contains a template string with placeholders (?).
	//   All values in a filter that are filled in using user-defined values should use a placeholder (?) to prevent
	//   SQL injection.
	// Example: `name = ? AND age = ?`
	Template string
	// Values contains a sequence of values for the placeholders defined in the template.
	// The values are replaced in the order they are defined in the template.
	// Example: `["Test", 33]`
	Values []interface{}
}

type Model interface {
	// TableName returns the table/collection name for a certain model.
	TableName() string
	// GetID returns the unique identifier for this Model.
	// It returns the ID of the model that has been persisted. It returns 0 if no value has been defined.
	// For SQL environments, this would be the primary key.
	GetID() uint
}

type ModelSQL struct {
	// ID contains the primary key identifier.
	ID uint `gorm:"primary_key"`
	// CreatedAt contains the date and time at which this model has been persisted.
	CreatedAt time.Time `json:"created_at"`
	// UpdatedAt contains the last date and time when this model has been updated.
	UpdatedAt time.Time `json:"updated_at"`
	// DeletedAt is used to implement soft record deletion. If set, the record will be considered
	// as deleted.
	DeletedAt *time.Time `json:"deleted_at" sql:"index"`
}

type Option interface {
	// IsOption is a dummy method used to identify repository options.
	IsOption()
}

type OrderByField string

type Repository interface {
	// FirstOrCreate inserts a new entry if the given filters don't find any existing record.
	// entity: must be a pointer to a Model implementation. Results will be saved in this argument if the record exists.
	FirstOrCreate(entity Model, filters ...Filter) error
	// Create inserts a single entry.
	// entity: The entry to insert.
	Create(entity Model) (Model, error)
	// CreateBulk is a bulk operation to create multiple entries with a single operation.
	// entities: should be a slice of a Model implementation.
	CreateBulk(entities []Model) ([]Model, error)
	// Find filters entries and stores filtered entries in output.
	// output: will contain the result of the query. It must be a pointer to a slice.
	// options: configuration options for the search. Refer to the implementation's set of options to get a lit of options.
	Find(output interface{}, options ...Option) error
	// FindOne filters entries and stores the first filtered entry in output.
	// output: must be a pointer to a Model implementation.
	FindOne(output Model, filters ...Filter) error
	// Last gets the last record ordered by primary key desc.
	// output: must be a pointer to a Model implementation.
	Last(output Model, filters ...Filter) error
	// Update updates all model entries that match the provided filters with the given data.
	// data: must be a map[string]interface{}
	// filters: selection criteria for entries that should be updated.
	Update(data interface{}, filters ...Filter) error
	// Delete removes all the model entries that match filters.
	// filters: selection criteria for entries that should be deleted.
	Delete(filters ...Filter) error
	// Count counts all the model entries that match filters.
	// filters: selection criteria for entries that should be considered when counting entries.
	Count(filters ...Filter) (uint64, error)
	// Model returns this repository's model.
	Model() Model
}

type SQLOption func(r *gorm.DB)