sqlc

package module

Go to main page

Versions in this module

v0

v0.4.0

Feb 26, 2026

v0.3.0

Feb 24, 2026

Changes in this version

type Relation

+ GetForeignKeyValue func(child *C) any

v0.2.0

Feb 12, 2026

Changes in this version

+ var MySQL = MySQLDialect

+ var PostgreSQL = PostgreSQLDialect

+ var SQLite = SQLiteDialect

+ func Exists(expr clause.Expression) clause.Expression

+ func NotExists(expr clause.Expression) clause.Expression

+ func Preload[P, C any](rel Relation[P, C]) preloadExecutor[P]

+ type JoinOn struct

+ Left clause.Column

+ Right clause.Column

+ func On(left, right interface{ ... }) JoinOn

type QueryBuilder

+ func (q *QueryBuilder[T]) Build() (string, []any, error)

+ func (q *QueryBuilder[T]) BuildE() (string, []any, error)

+ func (q *QueryBuilder[T]) Chunk(ctx context.Context, size int, fn func([]*T) error) error

+ func (q *QueryBuilder[T]) Distinct() *QueryBuilder[T]

+ func (q *QueryBuilder[T]) FirstOr(ctx context.Context, fallback func() *T) (*T, error)

+ func (q *QueryBuilder[T]) FirstOrCreate(ctx context.Context, defaults *T) (*T, error)

+ func (q *QueryBuilder[T]) JoinAs(target tableNamer, alias string, ons ...JoinOn) *QueryBuilder[T]

+ func (q *QueryBuilder[T]) JoinTable(table string, on clause.Expression) *QueryBuilder[T]

+ func (q *QueryBuilder[T]) Last(ctx context.Context) (*T, error)

+ func (q *QueryBuilder[T]) LeftJoinAs(target tableNamer, alias string, ons ...JoinOn) *QueryBuilder[T]

+ func (q *QueryBuilder[T]) LeftJoinTable(table string, on clause.Expression) *QueryBuilder[T]

+ func (q *QueryBuilder[T]) OnlyTrashed() *QueryBuilder[T]

+ func (q *QueryBuilder[T]) Pluck(ctx context.Context, column clause.Columnar, dest any) error

+ func (q *QueryBuilder[T]) RightJoinAs(target tableNamer, alias string, ons ...JoinOn) *QueryBuilder[T]

+ func (q *QueryBuilder[T]) RightJoinTable(table string, on clause.Expression) *QueryBuilder[T]

+ func (q *QueryBuilder[T]) Take(ctx context.Context) (*T, error)

+ func (q *QueryBuilder[T]) ToSQL() (string, []any, error)

+ func (q *QueryBuilder[T]) WithPreload(preload preloadExecutor[T]) *QueryBuilder[T]

+ func (q *QueryBuilder[T]) WithTrashed() *QueryBuilder[T]

+ type Relation struct

+ ForeignKey clause.Column

+ GetLocalKeyValue func(parent *P) any

+ LocalKey clause.Column

+ Setter func(parent *P, children []*C)

+ Type RelationType

+ func HasMany[P, C any](foreignKey clause.Column, localKey clause.Column, setter func(*P, []*C), ...) Relation[P, C]

+ func HasOne[P, C any](foreignKey clause.Column, localKey clause.Column, setter func(*P, *C), ...) Relation[P, C]

+ type RelationType int

+ const RelationHasMany

+ const RelationHasOne

type Repository

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

+ func (r *Repository[T]) Restore(ctx context.Context, id any) error

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

type Schema

+ SetDeletedAt func(m *T)

+ SoftDeleteColumn func() string

+ SoftDeleteValue func() any

v0.1.0

Jan 31, 2026

Changes in this version

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

+ func RegisterSchema[T any](schema Schema[T])

+ func ResolveColumnNames(args []clause.Columnar) []string

+ type AfterCreateInterface interface

+ AfterCreate func(context.Context) error

+ type AfterDeleteInterface interface

+ AfterDelete func(context.Context) error

+ type AfterUpdateInterface interface

+ AfterUpdate func(context.Context) error

+ type BeforeCreateInterface interface

+ BeforeCreate func(context.Context) error

+ type BeforeDeleteInterface interface

+ BeforeDelete func(context.Context) error

+ type BeforeUpdateInterface interface

+ BeforeUpdate func(context.Context) error

+ type Dialect interface

+ Name func() string

+ PlaceholderFormat func() sq.PlaceholderFormat

+ UpsertClause func(tableName string, conflictCols []string, updateCols []string) string

+ type Executor interface

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

+ GetContext func(ctx context.Context, dest any, query string, args ...any) error

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

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

+ SelectContext func(ctx context.Context, dest any, query string, args ...any) error

+ type JSON struct

+ Data T

+ func NewJSON[T any](v T) JSON[T]

+ func (j *JSON[T]) Scan(value any) error

+ func (j *JSON[T]) UnmarshalJSON(data []byte) error

+ func (j JSON[T]) MarshalJSON() ([]byte, error)

+ func (j JSON[T]) Value() (driver.Value, error)

+ type Metrics struct

+ QueryCount metric.Int64Counter

+ QueryDuration metric.Float64Histogram

+ QueryErrors metric.Int64Counter

+ type MySQLDialect struct

+ func (d *MySQLDialect) Name() string

+ func (d *MySQLDialect) PlaceholderFormat() sq.PlaceholderFormat

+ func (d *MySQLDialect) UpsertClause(tableName string, conflictCols []string, updateCols []string) string

+ type ObservabilityConfig struct

+ LogQueries bool

+ Logger *slog.Logger

+ Meter metric.Meter

+ Metrics *Metrics

+ SlowQueryThreshold time.Duration

+ Tracer trace.Tracer

+ type OrderBuilder interface

+ Build func() string

+ type PK = clause.Eq

+ type PostgreSQLDialect struct

+ func (d *PostgreSQLDialect) Name() string

+ func (d *PostgreSQLDialect) PlaceholderFormat() sq.PlaceholderFormat

+ func (d *PostgreSQLDialect) UpsertClause(tableName string, conflictCols []string, updateCols []string) string

+ type QueryBuilder struct

+ func Query[T any](session *Session) *QueryBuilder[T]

+ func (q *QueryBuilder[T]) Avg(ctx context.Context, column clause.Columnar) (float64, error)

+ func (q *QueryBuilder[T]) Count(ctx context.Context) (int64, error)

+ func (q *QueryBuilder[T]) Find(ctx context.Context) ([]*T, error)

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

+ func (q *QueryBuilder[T]) GroupBy(columns ...clause.Columnar) *QueryBuilder[T]

+ func (q *QueryBuilder[T]) Having(expr clause.Expression) *QueryBuilder[T]

+ func (q *QueryBuilder[T]) Join(table string, on clause.Expression) *QueryBuilder[T]

+ func (q *QueryBuilder[T]) LeftJoin(table string, on clause.Expression) *QueryBuilder[T]

+ func (q *QueryBuilder[T]) Limit(n uint64) *QueryBuilder[T]

+ func (q *QueryBuilder[T]) Max(ctx context.Context, column clause.Columnar) (any, error)

+ func (q *QueryBuilder[T]) Min(ctx context.Context, column clause.Columnar) (any, error)

+ func (q *QueryBuilder[T]) Offset(n uint64) *QueryBuilder[T]

+ func (q *QueryBuilder[T]) OrderBy(orders ...OrderBuilder) *QueryBuilder[T]

+ func (q *QueryBuilder[T]) RightJoin(table string, on clause.Expression) *QueryBuilder[T]

+ func (q *QueryBuilder[T]) Scan(ctx context.Context, dest any) error

+ func (q *QueryBuilder[T]) Select(columns ...clause.Columnar) *QueryBuilder[T]

+ func (q *QueryBuilder[T]) Sum(ctx context.Context, column clause.Columnar) (float64, error)

+ func (q *QueryBuilder[T]) Where(expr clause.Expression) *QueryBuilder[T]

+ func (q *QueryBuilder[T]) WithBuilder(fn func(b sq.SelectBuilder) sq.SelectBuilder) *QueryBuilder[T]

+ type Repository struct

+ func NewRepository[T any](session *Session) *Repository[T]

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

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

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

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

+ func (r *Repository[T]) FindOne(ctx context.Context, id any) (*T, error)

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

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

+ func (r *Repository[T]) UpdateColumns(ctx context.Context, id any, assignments ...clause.Assignment) error

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

+ func (r *Repository[T]) Where(conds ...clause.Expression) *Repository[T]

+ type SQLiteDialect struct

+ func (d *SQLiteDialect) Name() string

+ func (d *SQLiteDialect) PlaceholderFormat() sq.PlaceholderFormat

+ func (d *SQLiteDialect) UpsertClause(tableName string, conflictCols []string, updateCols []string) string

+ type Schema interface

+ AutoIncrement func() bool

+ InsertRow func(*T) ([]string, []any)

+ PK func(*T) PK

+ SelectColumns func() []string

+ SetPK func(m *T, val int64)

+ TableName func() string

+ UpdateMap func(*T) map[string]any

+ func LoadSchema[T any]() Schema[T]

+ type Session struct

+ func NewSession(db *sql.DB, dialect Dialect, opts ...SessionOption) *Session

+ func (s *Session) Begin(ctx context.Context) (*Session, error)

+ func (s *Session) Commit() error

+ func (s *Session) Exec(ctx context.Context, query string, args ...any) (sql.Result, error)

+ func (s *Session) Get(ctx context.Context, dest any, query string, args ...any) error

+ func (s *Session) Query(ctx context.Context, query string, args ...any) (*sql.Rows, error)

+ func (s *Session) QueryRow(ctx context.Context, query string, args ...any) *sql.Row

+ func (s *Session) Rollback() error

+ func (s *Session) Select(ctx context.Context, dest any, query string, args ...any) error

+ func (s *Session) Transaction(ctx context.Context, fn func(txSession *Session) error) (err error)

+ type SessionOption func(*Session)

+ func WithDefaultMeter() SessionOption

+ func WithDefaultTracer() SessionOption

+ func WithLogger(logger *slog.Logger) SessionOption

+ func WithMeter(meter metric.Meter) SessionOption

+ func WithQueryLogging(enabled bool) SessionOption

+ func WithSlowQueryThreshold(d time.Duration) SessionOption

+ func WithTracer(tracer trace.Tracer) SessionOption

+ type UpsertOption func(*upsertConfig)

+ func DoUpdate(columns ...clause.Columnar) UpsertOption

+ func OnConflict(columns ...clause.Columnar) UpsertOption

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