orm

Dec 24, 2025

Changes in this version

+ type ColumnChange struct

+ Column string

+ Table string

+ Type string

+ type Config struct

+ DatabaseURL string

+ MigrationsTable string

+ ModelsPackage string

+ type MigrationResult struct

+ ColumnsAdded []ColumnChange

+ ColumnsDropped []ColumnChange

+ Duration time.Duration

+ IndexesCreated []string

+ IndexesDropped []string

+ SQL []string

+ TablesCreated []string

+ TablesDropped []string

type Storm

+ func (s *Storm) AutoMigrate(ctx context.Context, config Config) (MigrationResult, error)

+ func (s *Storm) AutoMigrateDestructive(ctx context.Context, config Config) (MigrationResult, error)

+ func (s *Storm) AutoMigrateDryRun(ctx context.Context, config Config) (MigrationResult, error)

Aug 28, 2025

Changes in this version

type RelationshipMetadata

+ TargetTable string

Jul 23, 2025

Changes in this version

+ type QueryLogger interface

+ LogQuery func(query string, args []interface{}, duration time.Duration, err error)

+ type SimpleQueryLogger struct

+ func (s *SimpleQueryLogger) LogQuery(query string, args []interface{}, duration time.Duration, err error)

type Storm

+ func (s *Storm) GetLogger() QueryLogger

Jul 21, 2025

Changes in this version

+ type Action struct

+ func (a Action) Column() string

+ func (a Action) Expression() string

+ func (a Action) Value() interface{}

type ArrayColumn

+ func (c ArrayColumn[T]) Append(value T) Action

+ func (c ArrayColumn[T]) Concat(values []T) Action

+ func (c ArrayColumn[T]) Prepend(value T) Action

+ func (c ArrayColumn[T]) Remove(value T) Action

type Column

+ func (c Column[T]) Set(value T) Action

+ func (c Column[T]) SetDefault() Action

+ func (c Column[T]) SetNull() Action

type JSONBColumn

+ func (c JSONBColumn) Merge(jsonValue interface{}) Action

+ func (c JSONBColumn) RemovePath(path string) Action

+ func (c JSONBColumn) SetPath(path string, value interface{}) Action

type NumericColumn

+ func (c NumericColumn[T]) Decrement(amount T) Action

+ func (c NumericColumn[T]) Increment(amount T) Action

+ func (c NumericColumn[T]) Multiply(factor T) Action

type StringColumn

+ func (c StringColumn) Concat(suffix string) Action

+ func (c StringColumn) Lower() Action

+ func (c StringColumn) Prepend(prefix string) Action

+ func (c StringColumn) Upper() Action

type TimeColumn

+ func (c TimeColumn) SetCurrentTimestamp() Action

+ func (c TimeColumn) SetNow() Action

Jul 18, 2025

Changes in this version

+ type AuthorizeFunc func(ctx context.Context, query *Query[T]) *Query[T]

type DBExecutor

+ BindNamed func(query string, arg interface{}) (string, []interface{}, error)

type RelationshipMetadata

+ ScanToModel func(ctx context.Context, exec DBExecutor, query string, args []interface{}, ...) error

type Repository

+ func (r *Repository[T]) Authorize(fn AuthorizeFunc[T]) *Repository[T]

Jul 17, 2025

Changes in this version

type JSONData

+ Data *any

+ Valid bool

+ func NewJSONData(data any) JSONData

+ func NewNullJSONData() JSONData

+ func (j *JSONData) Get(v interface{}) error

+ func (j *JSONData) IsNull() bool

+ func (j *JSONData) MustGet(v interface{}) error

+ func (j *JSONData) Set(data interface{})

+ type StringArray []string

+ func (sa *StringArray) Scan(value interface{}) error

+ func (sa StringArray) Value() (driver.Value, error)

Jul 17, 2025

Changes in this version

type Condition

+ func And(conditions ...Condition) Condition

+ func Not(condition Condition) Condition

+ func Or(conditions ...Condition) Condition

Jul 17, 2025

Changes in this version

type Repository

+ func (r *Repository[T]) UpdateFields(ctx context.Context, id interface{}, updates map[string]interface{}) (*T, error)

Jul 17, 2025

Changes in this version

type Query

+ func (q *Query[T]) Update(record *T) error

+ func (q *Query[T]) UpdateMany(updates map[string]interface{}) (int64, error)

type StringColumn

+ func (c StringColumn) FullTextSearch(query string) Condition

+ func (c StringColumn) FullTextSearchLang(language, query string) Condition

Jul 17, 2025

Changes in this version

+ var ErrCanceled = errors.New("operation canceled")

+ var ErrCheckConstraint = errors.New("check constraint violation")

+ var ErrConnectionFailed = errors.New("database connection failed")

+ var ErrDuplicateKey = errors.New("duplicate key violation")

+ var ErrForeignKey = errors.New("foreign key violation")

+ var ErrInvalidStruct = errors.New("invalid struct type")

+ var ErrNoPrimaryKey = errors.New("no primary key defined")

+ var ErrNotFound = errors.New("record not found")

+ var ErrNotNull = errors.New("not null constraint violation")

+ var ErrTimeout = errors.New("operation timeout")

+ func GetColumnName(err error) string

+ func GetConstraintName(err error) string

+ func IsConstraintError(err error) bool

+ func IsRetryable(err error) bool

+ type ArrayColumn struct

+ func (c ArrayColumn[T]) ContainedBy(values []T) Condition

+ func (c ArrayColumn[T]) Contains(value T) Condition

+ func (c ArrayColumn[T]) IsEmpty() Condition

+ func (c ArrayColumn[T]) IsNotEmpty() Condition

+ func (c ArrayColumn[T]) Length() NumericColumn[int]

+ func (c ArrayColumn[T]) Overlaps(values []T) Condition

+ type BelongsTo struct

+ type BoolColumn struct

+ func (c BoolColumn) IsFalse() Condition

+ func (c BoolColumn) IsTrue() Condition

+ type BulkUpdateOptions struct

+ UpdateColumns []string

+ WhereColumns []string

+ type Column struct

+ Name string

+ Table string

+ func (c Column[T]) Asc() string

+ func (c Column[T]) Desc() string

+ func (c Column[T]) Eq(value T) Condition

+ func (c Column[T]) In(values ...T) Condition

+ func (c Column[T]) IsNotNull() Condition

+ func (c Column[T]) IsNull() Condition

+ func (c Column[T]) NotEq(value T) Condition

+ func (c Column[T]) NotIn(values ...T) Condition

+ func (c Column[T]) String() string

+ type ColumnMetadata struct

+ Constraints []string

+ DBName string

+ DBType string

+ Default string

+ FieldName string

+ ForeignKey *ForeignKeyMetadata

+ GetValue func(model interface{}) interface{}

+ GoType string

+ IsAutoGenerated bool

+ IsNil func(model interface{}) bool

+ IsNullable bool

+ IsPointer bool

+ IsPrimaryKey bool

+ IsUnique bool

+ Tags map[string]string

+ type Comparable interface

+ type ComparableColumn struct

+ func (c ComparableColumn[T]) Between(min, max T) Condition

+ func (c ComparableColumn[T]) Gt(value T) Condition

+ func (c ComparableColumn[T]) Gte(value T) Condition

+ func (c ComparableColumn[T]) Lt(value T) Condition

+ func (c ComparableColumn[T]) Lte(value T) Condition

+ type Condition struct

+ func (c Condition) And(other Condition) Condition

+ func (c Condition) Not() Condition

+ func (c Condition) Or(other Condition) Condition

+ func (c Condition) ToSqlizer() squirrel.Sqlizer

+ type DBExecutor interface

+ DriverName func() string

+ ExecContext func(ctx context.Context, query string, args ...interface{}) (sql.Result, error)

+ GetContext func(ctx context.Context, dest interface{}, query string, args ...interface{}) error

+ NamedExecContext func(ctx context.Context, query string, arg interface{}) (sql.Result, error)

+ PrepareContext func(ctx context.Context, query string) (*sql.Stmt, error)

+ PrepareNamedContext func(ctx context.Context, query string) (*sqlx.NamedStmt, error)

+ PreparexContext func(ctx context.Context, query string) (*sqlx.Stmt, error)

+ QueryContext func(ctx context.Context, query string, args ...interface{}) (*sql.Rows, error)

+ QueryRowContext func(ctx context.Context, query string, args ...interface{}) *sql.Row

+ QueryRowxContext func(ctx context.Context, query string, args ...interface{}) *sqlx.Row

+ QueryxContext func(ctx context.Context, query string, args ...interface{}) (*sqlx.Rows, error)

+ Rebind func(query string) string

+ SelectContext func(ctx context.Context, dest interface{}, query string, args ...interface{}) error

+ type DBWrapper interface

+ BeginTxx func(ctx context.Context, opts *sql.TxOptions) (*sqlx.Tx, error)

+ Close func() error

+ Ping func() error

+ PingContext func(ctx context.Context) error

+ Stats func() sql.DBStats

+ type Error struct

+ Args []interface{}

+ Column string

+ Constraint string

+ Err error

+ Op string

+ Query string

+ Retryable bool

+ Table string

+ func (e *Error) Error() string

+ func (e *Error) Is(target error) bool

+ func (e *Error) Unwrap() error

+ type ForeignKeyMetadata struct

+ OnDelete string

+ OnUpdate string

+ ReferencedColumn string

+ ReferencedTable string

+ type HasMany struct

+ type HasManyThrough struct

+ type HasOne struct

+ type JSONBColumn struct

+ func (c JSONBColumn) ContainedBy(value interface{}) Condition

+ func (c JSONBColumn) Contains(value interface{}) Condition

+ func (c JSONBColumn) HasAllKeys(keys []string) Condition

+ func (c JSONBColumn) HasAnyKey(keys []string) Condition

+ func (c JSONBColumn) HasKey(key string) Condition

+ func (c JSONBColumn) Path(path string) JSONBColumn

+ func (c JSONBColumn) PathText(path string) StringColumn

+ type JSONData struct

+ func (j *JSONData) Marshal(v interface{}) error

+ func (j *JSONData) Scan(value interface{}) error

+ func (j *JSONData) Unmarshal(v interface{}) error

+ func (j JSONData) String() string

+ func (j JSONData) Value() (driver.Value, error)

+ type JoinType string

+ const FullJoin

+ const InnerJoin

+ const LeftJoin

+ const RightJoin

+ type MiddlewareContext struct

+ Args []interface{}

+ Context context.Context

+ Duration time.Duration

+ Error error

+ Metadata map[string]interface{}

+ Operation OperationType

+ Query string

+ QueryBuilder interface{}

+ Record interface{}

+ Records interface{}

+ StartTime time.Time

+ TableName string

+ type ModelMetadata struct

+ ColumnMap map[string]string

+ Columns map[string]*ColumnMetadata

+ PrimaryKeys []string

+ Relationships map[string]*RelationshipMetadata

+ ReverseMap map[string]string

+ StructName string

+ TableName string

+ type Numeric interface

+ type NumericColumn struct

+ type OperationType string

+ const OpBulkUpdate

+ const OpCreate

+ const OpCreateMany

+ const OpDelete

+ const OpFind

+ const OpQuery

+ const OpUpdate

+ const OpUpdateMany

+ const OpUpsert

+ const OpUpsertMany

+ type Query struct

+ func (q *Query[T]) Count() (int64, error)

+ func (q *Query[T]) Delete() (int64, error)

+ func (q *Query[T]) ExecuteRaw(query string, args ...interface{}) ([]T, error)

+ func (q *Query[T]) Exists() (bool, error)

+ func (q *Query[T]) Find() ([]T, error)

+ func (q *Query[T]) First() (*T, error)

+ func (q *Query[T]) FullJoin(table, condition string) *Query[T]

+ func (q *Query[T]) Include(relationships ...string) *Query[T]

+ func (q *Query[T]) IncludeWhere(relationship string, conditions ...Condition) *Query[T]

+ func (q *Query[T]) InnerJoin(table, condition string) *Query[T]

+ func (q *Query[T]) Join(joinType JoinType, table, condition string) *Query[T]

+ func (q *Query[T]) JoinRelationship(relationshipName string, joinType JoinType) *Query[T]

+ func (q *Query[T]) LeftJoin(table, condition string) *Query[T]

+ func (q *Query[T]) Limit(limit uint64) *Query[T]

+ func (q *Query[T]) Offset(offset uint64) *Query[T]

+ func (q *Query[T]) OrderBy(expressions ...string) *Query[T]

+ func (q *Query[T]) RawJoin(joinClause string, args ...interface{}) *Query[T]

+ func (q *Query[T]) RightJoin(table, condition string) *Query[T]

+ func (q *Query[T]) Where(condition Condition) *Query[T]

+ func (q *Query[T]) WhereArrayContainedBy(column string, values []interface{}) *Query[T]

+ func (q *Query[T]) WhereArrayContains(column string, value interface{}) *Query[T]

+ func (q *Query[T]) WhereArrayContainsAny(column string, values []interface{}) *Query[T]

+ func (q *Query[T]) WhereArrayEmpty(column string) *Query[T]

+ func (q *Query[T]) WhereArrayLength(column string, length int) *Query[T]

+ func (q *Query[T]) WhereArrayNotEmpty(column string) *Query[T]

+ func (q *Query[T]) WhereFullTextSearch(column string, query string) *Query[T]

+ func (q *Query[T]) WhereFullTextSearchLanguage(column string, language string, query string) *Query[T]

+ func (q *Query[T]) WhereJSONB(column string, path string, value interface{}) *Query[T]

+ func (q *Query[T]) WhereJSONBContainedBy(column string, value interface{}) *Query[T]

+ func (q *Query[T]) WhereJSONBContains(column string, value interface{}) *Query[T]

+ func (q *Query[T]) WhereJSONBExists(column string, key string) *Query[T]

+ func (q *Query[T]) WhereJSONBPath(column string, path string, operator string, value interface{}) *Query[T]

+ func (q *Query[T]) WhereNotSimilarTo(column string, pattern string) *Query[T]

+ func (q *Query[T]) WhereRegex(column string, pattern string) *Query[T]

+ func (q *Query[T]) WhereRegexInsensitive(column string, pattern string) *Query[T]

+ func (q *Query[T]) WhereRegexNot(column string, pattern string) *Query[T]

+ func (q *Query[T]) WhereRegexNotInsensitive(column string, pattern string) *Query[T]

+ func (q *Query[T]) WhereSimilarTo(column string, pattern string) *Query[T]

+ func (q *Query[T]) WithTx(tx *sqlx.Tx) *Query[T]

+ type QueryMiddleware func(next QueryMiddlewareFunc) QueryMiddlewareFunc

+ type QueryMiddlewareFunc func(ctx *MiddlewareContext) error

+ type RelationshipMetadata struct

+ ForeignKey string

+ IsSlice bool

+ Name string

+ SetValue func(model interface{}, value interface{})

+ SourceKey string

+ Target string

+ TargetKey string

+ Through string

+ ThroughFK string

+ ThroughTK string

+ Type string

+ type Repository struct

+ func NewRepositoryWithExecutor[T any](executor DBExecutor, metadata *ModelMetadata) (*Repository[T], error)

+ func NewRepositoryWithTx[T any](tx *sqlx.Tx, metadata *ModelMetadata) (*Repository[T], error)

+ func NewRepository[T any](db *sqlx.DB, metadata *ModelMetadata) (*Repository[T], error)

+ func (r *Repository[T]) AddMiddleware(middleware QueryMiddleware)

+ func (r *Repository[T]) BulkUpdate(ctx context.Context, records []T, opts BulkUpdateOptions) (int64, error)

+ func (r *Repository[T]) Columns() []string

+ func (r *Repository[T]) CountByArrayContains(column string, value interface{}) (int64, error)

+ func (r *Repository[T]) CountByJSONB(column string, path string, value interface{}) (int64, error)

+ func (r *Repository[T]) CountBySearch(column string, query string) (int64, error)

+ func (r *Repository[T]) Create(ctx context.Context, record *T) error

+ func (r *Repository[T]) CreateMany(ctx context.Context, records []*T) error

+ func (r *Repository[T]) Delete(ctx context.Context, id interface{}) error

+ func (r *Repository[T]) DeleteRecord(ctx context.Context, record *T) error

+ func (r *Repository[T]) FindByArrayContains(column string, value interface{}) ([]T, error)

+ func (r *Repository[T]) FindByArrayContainsAny(column string, values []interface{}) ([]T, error)

+ func (r *Repository[T]) FindByID(ctx context.Context, id interface{}) (*T, error)

+ func (r *Repository[T]) FindByJSONB(column string, path string, value interface{}) ([]T, error)

+ func (r *Repository[T]) FindByJSONBContains(column string, value interface{}) ([]T, error)

+ func (r *Repository[T]) FindByRegex(column string, pattern string) ([]T, error)

+ func (r *Repository[T]) FindByRegexInsensitive(column string, pattern string) ([]T, error)

+ func (r *Repository[T]) GetTransactionManager() (*TransactionManager, error)

+ func (r *Repository[T]) IsTransaction() bool

+ func (r *Repository[T]) PrimaryKeys() []string

+ func (r *Repository[T]) Query() *Query[T]

+ func (r *Repository[T]) QueryContext(ctx context.Context) *Query[T]

+ func (r *Repository[T]) Search(column string, query string) ([]T, error)

+ func (r *Repository[T]) SearchWithLanguage(column string, language string, query string) ([]T, error)

+ func (r *Repository[T]) TableName() string

+ func (r *Repository[T]) Update(ctx context.Context, record *T) error

+ func (r *Repository[T]) UpdateMany(ctx context.Context, updates map[string]interface{}, condition Condition) (int64, error)

+ func (r *Repository[T]) Upsert(ctx context.Context, record *T, opts UpsertOptions) error

+ func (r *Repository[T]) UpsertMany(ctx context.Context, records []T, opts UpsertOptions) error

+ func (r *Repository[T]) WithRelationships() *Query[T]

+ func (r *Repository[T]) WithinTransaction(ctx context.Context, fn func(*sqlx.Tx) error) error

+ type Storm struct

+ func NewStorm(db *sqlx.DB) *Storm

+ func (s *Storm) And(conditions ...Condition) Condition

+ func (s *Storm) GetDB() *sqlx.DB

+ func (s *Storm) GetExecutor() DBExecutor

+ func (s *Storm) Not(condition Condition) Condition

+ func (s *Storm) Or(conditions ...Condition) Condition

+ func (s *Storm) WithTransaction(ctx context.Context, fn func(*Storm) error) error

+ func (s *Storm) WithTransactionOptions(ctx context.Context, opts *TransactionOptions, fn func(*Storm) error) error

+ type StringColumn struct

+ func (c StringColumn) Contains(substring string) Condition

+ func (c StringColumn) EndsWith(suffix string) Condition

+ func (c StringColumn) ILike(pattern string) Condition

+ func (c StringColumn) Like(pattern string) Condition

+ func (c StringColumn) Regexp(pattern string) Condition

+ func (c StringColumn) StartsWith(prefix string) Condition

+ type Table struct

+ Name string

+ PrimaryKeys []string

+ Schema string

+ func (t Table) FullName() string

+ func (t Table) GetPrimaryKeyColumns() []string

+ func (t Table) HasPrimaryKey(column string) bool

+ func (t Table) IsCompositePrimaryKey() bool

+ type TimeColumn struct

+ func (c TimeColumn) After(t time.Time) Condition

+ func (c TimeColumn) Before(t time.Time) Condition

+ func (c TimeColumn) LastNDays(days int) Condition

+ func (c TimeColumn) Since(t time.Time) Condition

+ func (c TimeColumn) ThisMonth() Condition

+ func (c TimeColumn) ThisWeek() Condition

+ func (c TimeColumn) Today() Condition

+ func (c TimeColumn) Until(t time.Time) Condition

+ type TransactionManager struct

+ func NewTransactionManager(db *sqlx.DB) *TransactionManager

+ func (tm *TransactionManager) WithTransaction(ctx context.Context, fn func(*sqlx.Tx) error) error

+ func (tm *TransactionManager) WithTransactionOptions(ctx context.Context, opts *TransactionOptions, fn func(*sqlx.Tx) error) error

+ type TransactionOptions struct

+ Isolation sql.IsolationLevel

+ ReadOnly bool

+ func DefaultTransactionOptions() *TransactionOptions

+ func (o *TransactionOptions) ToTxOptions() *sql.TxOptions

+ type UpsertOptions struct

+ ConflictColumns []string

+ UpdateColumns []string

+ UpdateExpr map[string]string

+ type ValidationError struct

+ Field string

+ Message string

+ func (e ValidationError) Error() string

+ type ValidationErrors []ValidationError

+ func (e ValidationErrors) Error() string