relational

Documentation

Index

• Variables
• type Condition
• type ConditionGroup
• type DB
  • func (db *DB) AddDateFilters(query *bun.SelectQuery, filters []DateFilter) *bun.SelectQuery
  • func (db *DB) AddKeysetPagination(query *bun.SelectQuery, limit int, cursors ...ConditionGroup) (*bun.SelectQuery, error)
  • func (db *DB) CreateExtensions(extensions []string) error
  • func (db *DB) CreateTables(models []interface{}) error
  • func (db *DB) QueryBuilder(groups []ConditionGroup) (query string, queryArgs []interface{}, err error)
  • func (db *DB) QueryCount(ctx context.Context, model interface{}, query string, ...) (int, error)
  • func (db *DB) RegisterModels(models []interface{}) error
  • func (db *DB) ResetTables(models []interface{}) error
  • func (db *DB) RollbackLastMigration(migrations *migrate.Migrations) error
  • func (db *DB) RunMigrations(migrations *migrate.Migrations) error
• type DateFilter
  • func (df *DateFilter) ParseToUnix(validDBColumns []string) error
• type LogicalOperator
  • func (s LogicalOperator) String() string
• type Operator
  • func (s Operator) String() string
• type Option
  • func WithExtensions(extensions []string) Option
  • func WithRegistrableModels(models []interface{}) Option

Variables

var (
	EqualOperator              = Operator{"="}
	GreaterThanOperator        = Operator{">"}
	LessThanOperator           = Operator{"<"}
	GreaterThanOrEqualOperator = Operator{">="}
	LessThanOrEqualOperator    = Operator{"<="}
	NotEqualOperator           = Operator{"!="}
	InOperator                 = Operator{"IN"}
	BetweenOperator            = Operator{"BETWEEN"}
	LikeOperator               = Operator{"LIKE"}
	ILikeOperator              = Operator{"ILIKE"}
	IsNullOperator             = Operator{"IS NULL"}
	IsNotNullOperator          = Operator{"IS NOT NULL"}
	NotOperator                = Operator{"NOT"}
)

var (
	AndOperator = LogicalOperator{"AND"}
	OrOperator  = LogicalOperator{"OR"}
)

Types

type Condition

type Condition struct {
	Column     string
	Comparison Operator
	LogOp      LogicalOperator
	Value      interface{}
}

type ConditionGroup

type ConditionGroup struct {
	Conditions []Condition
	LogOp      LogicalOperator
}

type DB

type DB struct {
	*bun.DB
}

func (*DB) AddDateFilters

func (db *DB) AddDateFilters(query *bun.SelectQuery, filters []DateFilter) *bun.SelectQuery

func (*DB) AddKeysetPagination

func (db *DB) AddKeysetPagination(query *bun.SelectQuery, limit int, cursors ...ConditionGroup) (*bun.SelectQuery, error)

TODO: Deprecate this function in favor of cursor pagination

func (*DB) CreateExtensions

func (db *DB) CreateExtensions(extensions []string) error

CreateExtensions - Creates a database extension if it doesn't already exist

func (*DB) CreateTables

func (db *DB) CreateTables(models []interface{}) error

CreateTables - Creates the database schema if it doesn't already exist

func (*DB) QueryBuilder

func (db *DB) QueryBuilder(groups []ConditionGroup) (query string, queryArgs []interface{}, err error)

func (*DB) QueryCount

func (db *DB) QueryCount(ctx context.Context, model interface{}, query string, conditions ...interface{}) (int, error)

func (*DB) RegisterModels

func (db *DB) RegisterModels(models []interface{}) error

RegisterModels - Registers many-to-many relationship

func (*DB) ResetTables

func (db *DB) ResetTables(models []interface{}) error

ResetTables - Drops and recreates the database schema

func (*DB) RollbackLastMigration

func (db *DB) RollbackLastMigration(migrations *migrate.Migrations) error

RollbackLastMigration - Rollbacks the last migration

func (*DB) RunMigrations

func (db *DB) RunMigrations(migrations *migrate.Migrations) error

RunMigrations - Executes all pending migrations

type DateFilter

type DateFilter struct {
	DateColumn   string `json:"date_column"`
	FromDate     string `json:"from_date"`
	ToDate       string `json:"to_date"`
	FromDateUnix int64  `json:"-"`
	ToDateUnix   int64  `json:"-"`
}

func (*DateFilter) ParseToUnix

func (df *DateFilter) ParseToUnix(validDBColumns []string) error

type LogicalOperator

type LogicalOperator struct {
	Value string
}

func (LogicalOperator) String

func (s LogicalOperator) String() string

type Operator

type Operator struct {
	Value string
}

func (Operator) String

func (s Operator) String() string

type Option

type Option func(db *DB) error

func WithExtensions

func WithExtensions(extensions []string) Option

func WithRegistrableModels

func WithRegistrableModels(models []interface{}) Option