mehen

type ContextInterface interface {
	// NoACL declares that no ACL-checks are needed.
	NoACL() SqlInterface

	// SetAuditableContext sets database setting name into current transaction's variable for auditing purposes.
	SetAuditableContext(databaseSettingName string, value interface{}) error
}

type Database interface {
	sqlbuilder.Database
	Settings
}

type DatabaseTransactionContext interface {
	sqlbuilder.SQLBuilder
	Settings
}

type InsertUpdateDeleteInterface interface {
	// Insert executes a sql insert query and returns inserted records ID (only if query ends with "returning id;").
	Insert() (int, error)
	// Update executes a sql update query and returns affected rows count (do not use `;` in the sql).
	Update() (int, error)
	// Delete executes a sql delete query.
	Delete() error
}

type Interface interface {
	// Context sets an query context:
	// tx - database or transaction reference
	Context(tx DatabaseTransactionContext) ContextInterface
}

type Pagination struct {
	Sort           string
	SortDescending bool
	Offset         int
	Limit          int
}

type QueryInterface interface {
	// QueryOne executes a sql select query to retrieve one object.
	QueryOne(result interface{}) error
	// Query executes a sql select query to retrieve many objects.
	Query(result interface{}) error
	// QueryWithCount executes a count and a select query to retrieve many objects and the total count.
	// Meant to be used with pagination.
	QueryWithCount(result interface{}) (int, error)
}

type Settings interface {
	// SetStatementTimeout sets the default statement timeout (in seconds).
	// Database queries will return with an error after this time. 0 = no timeout.
	SetStatementTimeout(int)

	// StatementTimeout returns the default statement timeout (in seconds).
	// Database queries will return with an error after this time. 0 = no timeout.
	StatementTimeout() int
}

type SqlContextInterface interface {
	InsertUpdateDeleteInterface
	QueryInterface

	// Parameter declares an sql parameter
	// key - key of the parameter (i.e. "application_id").
	// value - value of the parameter.
	Parameter(key string, value interface{}) SqlContextInterface

	// ParameterNullable declares an sql parameter
	// key - key of the parameter (i.e. "application_id").
	// value - value of the parameter. If value is default, then parameter will be used as NULL
	ParameterNullable(key string, value interface{}) SqlContextInterface

	// Pagination declares pagination settings (with automatic count query).
	// pagination - pagination settings.
	// selectFields - these fields will be selected when performing query.
	Pagination(pagination Pagination, selectFields []string) QueryInterface

	// PaginationWithCountSQLTemplate declares pagination settings (with implicit count sql template).
	// pagination - pagination settings.
	// countSQLTemplateOverride - this sql template will be used for count query (optional).
	PaginationWithCountSQLTemplate(pagination Pagination, countSQLTemplateOverride string) QueryInterface
}

type SqlInterface interface {
	// SQL sets the sql template to be used for the query.
	// Possible placeholders:
	// {{select}} - use when querying with count.
	// {{footer}} - use when using pagination or querying with count.
	// Custom parameters are also allowed (i.e. {{id}})) but have to be provided by Parameter-declarations.
	SQL(sqlTemplate string) SqlContextInterface
}

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

type TransactionContext interface {
	sqlbuilder.Tx
	Settings
}