rio

package module

Go to main page

Versions in this module

v0

v0.9.0

Jul 10, 2026

Changes in this version

type NativeCell

+ SetUint64 func(uint64) error

type RawQuery

+ func (r RawQuery[T]) Rows(ctx context.Context, db Queryer) iter.Seq2[T, error]

v0.8.0

Jul 10, 2026

Changes in this version

type DB

+ func NewNative(nc NativeConfig, dialect Dialect, opts ...Option) *DB

+ func (d *DB) Native() any

+ type NativeCell interface

+ ScanKind func() NativeScanKind

+ SetBool func(bool) error

+ SetBytes func([]byte) error

+ SetFloat64 func(float64) error

+ SetInt64 func(int64) error

+ SetNull func() error

+ SetString func(string) error

+ SetTime func(time.Time) error

+ type NativeConfig struct

+ DB NativeDB

+ Handle any

+ SQLView *sql.DB

+ type NativeDB interface

+ Begin func(ctx context.Context, opts *sql.TxOptions) (NativeTx, error)

+ Close func() error

+ Exec func(ctx context.Context, sql string, args []any) (rowsAffected int64, err error)

+ Query func(ctx context.Context, sql string, args []any) (NativeRows, error)

+ type NativeRows interface

+ Close func()

+ Columns func() []string

+ Err func() error

+ Next func() bool

+ Scan func(dest ...any) error

+ type NativeScanKind uint8

+ const NativeKindBool

+ const NativeKindBytes

+ const NativeKindFloat

+ const NativeKindInt

+ const NativeKindJSON

+ const NativeKindScanner

+ const NativeKindString

+ const NativeKindTime

+ const NativeKindUint

+ type NativeTx interface

+ Commit func(ctx context.Context) error

+ Exec func(ctx context.Context, sql string, args []any) (int64, error)

+ Query func(ctx context.Context, sql string, args []any) (NativeRows, error)

+ Rollback func(ctx context.Context) error

type Tx

+ func (t *Tx) NativeTx() any

v0.7.2

Jul 10, 2026

v0.7.1

Jul 10, 2026

v0.7.0

Jul 10, 2026

Changes in this version

type Dialect

+ var ClickHouse Dialect = clickhouseDialect{}

type Query

+ func (q Query[T]) Final() Query[T]

v0.6.0

Jul 10, 2026

v0.5.0

Jul 10, 2026

v0.4.0

Jul 9, 2026

Changes in this version

type Query

+ func (q Query[T]) RestoreAll(ctx context.Context, db Queryer) (int64, error)

v0.3.0

Jul 9, 2026

Changes in this version

+ func SyncRelation[T any, K any](ctx context.Context, db Queryer, row *T, relation string, ids []K) error

+ func WriteColumns(w io.Writer, pkgName string, models ...any) error

type Compiled

+ func (c *Compiled[T]) Rows(ctx context.Context, db Queryer, args ...any) iter.Seq2[T, error]

type Query

+ func (q Query[T]) Scope(fns ...func(Query[T]) Query[T]) Query[T]

v0.2.0

Jul 9, 2026

Changes in this version

+ func Attach[T any](ctx context.Context, db Queryer, row *T, relation string, ids ...any) error

+ func Detach[T any](ctx context.Context, db Queryer, row *T, relation string, ids ...any) error

+ func Pluck[V any, T any](ctx context.Context, db Queryer, q Query[T], column string) ([]V, error)

type Query

+ func (q Query[T]) Rows(ctx context.Context, db Queryer) iter.Seq2[T, error]

+ func (q Query[T]) WhereHas(path string, opts ...RelOption) Query[T]

+ func (q Query[T]) WhereHasNot(path string, opts ...RelOption) Query[T]

+ func (q Query[T]) WithCount(relation string) Query[T]

type RelOption

+ func RelLimit(n int) RelOption

v0.1.1

Jul 9, 2026

v0.1.0

Jul 9, 2026

Changes in this version

+ var ErrDuplicateKey = errors.New("rio: duplicate key violates unique constraint")

+ var ErrForeignKeyViolated = errors.New("rio: foreign key constraint violated")

+ var ErrMissingWhere = errors.New(...)

+ var ErrMultipleRows = errors.New("rio: expected exactly one row, found more")

+ var ErrNoPrimaryKey = errors.New("rio: model has no primary key")

+ var ErrNotFound = fmt.Errorf("rio: record not found (%w)", sql.ErrNoRows)

+ var ErrStaleObject = errors.New("rio: stale object: version conflict or row deleted")

+ func Delete[T any](ctx context.Context, db Queryer, row *T) error

+ func Exec(ctx context.Context, db Queryer, sqlText string, args ...any) (sql.Result, error)

+ func Find[T any](ctx context.Context, db Queryer, key ...any) (*T, error)

+ func ForceDelete[T any](ctx context.Context, db Queryer, row *T) error

+ func InsertAll[T any](ctx context.Context, db Queryer, rows []T) error

+ func Insert[T any](ctx context.Context, db Queryer, row *T) error

+ func Restore[T any](ctx context.Context, db Queryer, row *T) error

+ func Update[T any](ctx context.Context, db Queryer, row *T, cols ...string) error

+ func UpsertAll[T any](ctx context.Context, db Queryer, rows []T, opts ...UpsertOption) error

+ func Upsert[T any](ctx context.Context, db Queryer, row *T, opts ...UpsertOption) error

+ type BelongsTo struct

+ func (r *BelongsTo[T]) Set(row *T)

+ func (r *BelongsTo[T]) UnmarshalJSON(b []byte) error

+ func (r BelongsTo[T]) Loaded() bool

+ func (r BelongsTo[T]) MarshalJSON() ([]byte, error)

+ func (r BelongsTo[T]) Row() *T

+ type Compiled struct

+ func Compile[T any](q Query[T]) (*Compiled[T], error)

+ func MustCompile[T any](q Query[T]) *Compiled[T]

+ func (c *Compiled[T]) All(ctx context.Context, db Queryer, args ...any) ([]T, error)

+ func (c *Compiled[T]) Count(ctx context.Context, db Queryer, args ...any) (int64, error)

+ func (c *Compiled[T]) Exists(ctx context.Context, db Queryer, args ...any) (bool, error)

+ func (c *Compiled[T]) First(ctx context.Context, db Queryer, args ...any) (*T, error)

+ func (c *Compiled[T]) Sole(ctx context.Context, db Queryer, args ...any) (*T, error)

+ type DB struct

+ func New(db *sql.DB, dialect Dialect, opts ...Option) *DB

+ func (d *DB) Close() error

+ func (d *DB) Tx(ctx context.Context, fn func(tx *Tx) error) error

+ func (d *DB) TxWith(ctx context.Context, opts *sql.TxOptions, fn func(tx *Tx) error) (err error)

+ func (d *DB) Unwrap() *sql.DB

+ type Dialect interface

+ var MySQL Dialect = mysqlDialect{}

+ var Postgres Dialect = postgresDialect{}

+ var SQLite Dialect = sqliteDialect{}

+ type Expr string

+ type HasMany struct

+ func (r *HasMany[T]) Set(rows []T)

+ func (r *HasMany[T]) UnmarshalJSON(b []byte) error

+ func (r HasMany[T]) Loaded() bool

+ func (r HasMany[T]) MarshalJSON() ([]byte, error)

+ func (r HasMany[T]) Rows() []T

+ type HasOne struct

+ func (r *HasOne[T]) Set(row *T)

+ func (r *HasOne[T]) UnmarshalJSON(b []byte) error

+ func (r HasOne[T]) Loaded() bool

+ func (r HasOne[T]) MarshalJSON() ([]byte, error)

+ func (r HasOne[T]) Row() *T

+ type ManyToMany struct

+ func (r *ManyToMany[T]) Set(rows []T)

+ func (r *ManyToMany[T]) UnmarshalJSON(b []byte) error

+ func (r ManyToMany[T]) Loaded() bool

+ func (r ManyToMany[T]) MarshalJSON() ([]byte, error)

+ func (r ManyToMany[T]) Rows() []T

+ type Option func(*config)

+ func WithClock(now func() time.Time) Option

+ func WithErrorTranslator(f func(error) error) Option

+ func WithQueryHook(h QueryHook) Option

+ func WithStmtCache(capacity ...int) Option

+ func WithTableNamer(f func(structName string) string) Option

+ func WithoutArgs() Option

+ type Query struct

+ func From[T any]() Query[T]

+ func (q Query[T]) All(ctx context.Context, db Queryer) ([]T, error)

+ func (q Query[T]) AllRows() Query[T]

+ func (q Query[T]) Count(ctx context.Context, db Queryer) (int64, error)

+ func (q Query[T]) CreateOrFirst(ctx context.Context, db Queryer, row *T) error

+ func (q Query[T]) DeleteAll(ctx context.Context, db Queryer) (int64, error)

+ func (q Query[T]) Exists(ctx context.Context, db Queryer) (bool, error)

+ func (q Query[T]) First(ctx context.Context, db Queryer) (*T, error)

+ func (q Query[T]) FirstOrCreate(ctx context.Context, db Queryer, row *T) error

+ func (q Query[T]) ForUpdate() Query[T]

+ func (q Query[T]) ForceDeleteAll(ctx context.Context, db Queryer) (int64, error)

+ func (q Query[T]) GroupBy(expr string) Query[T]

+ func (q Query[T]) Having(expr string, args ...any) Query[T]

+ func (q Query[T]) Join(clause string) Query[T]

+ func (q Query[T]) Limit(n int) Query[T]

+ func (q Query[T]) Offset(n int) Query[T]

+ func (q Query[T]) OnlyTrashed() Query[T]

+ func (q Query[T]) OrderBy(expr string) Query[T]

+ func (q Query[T]) Restore(ctx context.Context, db Queryer) (int64, error)

+ func (q Query[T]) Sole(ctx context.Context, db Queryer) (*T, error)

+ func (q Query[T]) UpdateAll(ctx context.Context, db Queryer, set Set) (int64, error)

+ func (q Query[T]) Where(expr string, args ...any) Query[T]

+ func (q Query[T]) With(path string, opts ...RelOption) Query[T]

+ func (q Query[T]) WithTrashed() Query[T]

+ type QueryEvent struct

+ Args []any

+ Duration time.Duration

+ Err error

+ Model string

+ Op string

+ Query string

+ RowsAffected int64

+ type QueryHook interface

+ AfterQuery func(ctx context.Context, e *QueryEvent)

+ BeforeQuery func(ctx context.Context, e *QueryEvent) context.Context

+ type Queryer interface

+ Tx func(ctx context.Context, fn func(tx *Tx) error) error

+ type RawQuery struct

+ func Raw[T any](sqlText string, args ...any) RawQuery[T]

+ func (r RawQuery[T]) All(ctx context.Context, db Queryer) ([]T, error)

+ func (r RawQuery[T]) First(ctx context.Context, db Queryer) (*T, error)

+ func (r RawQuery[T]) Sole(ctx context.Context, db Queryer) (*T, error)

+ type RelOption func(*relQuery)

+ func RelOrder(expr string) RelOption

+ func RelWhere(expr string, args ...any) RelOption

+ func RelWithTrashed() RelOption

+ type Set map[string]any

+ type TableNamer interface

+ TableName func() string

+ type Tx struct

+ func (t *Tx) Tx(ctx context.Context, fn func(tx *Tx) error) (err error)

+ func (t *Tx) Unwrap() *sql.Tx

+ type UpsertOption func(*upsertSpec)

+ func DoNothing() UpsertOption

+ func DoUpdate(cols ...string) UpsertOption

+ func KeepTrashed() UpsertOption

+ func OnConflict(cols ...string) UpsertOption

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL