Documentation
¶
Index ¶
- Constants
- Variables
- type AddColumnQuery
- type AfterDeleteHook
- type AfterInsertHook
- type AfterScanRowHook
- type AfterSelectHook
- type AfterUpdateHook
- type Applier
- type ApplyFunc
- type ArrayAggBuilder
- type AuditedModel
- type AvgBuilder
- type BaseModel
- type BeforeDeleteHook
- type BeforeInsertHook
- type BeforeScanRowHook
- type BeforeSelectHook
- type BeforeUpdateHook
- type BitAndBuilder
- type BitOrBuilder
- type BoolAndBuilder
- type BoolOrBuilder
- type BunDeleteQuery
- type BunInsertQuery
- type BunSelectQuery
- type BunUpdateQuery
- type CaseBuilder
- type CaseWhenBuilder
- type CheckBuilder
- type ColumnConstraint
- type ColumnInfo
- type ConditionBuilder
- type ConflictAction
- type ConflictBuilder
- type ConflictUpdateBuilder
- type CountBuilder
- type CreateIndexQuery
- type CreateTableQuery
- type CreatedModel
- type CumeDistBuilder
- type DB
- type DataTypeDef
- type DateTimeUnit
- type DeleteQuery
- type DenseRankBuilder
- type Dialect
- type DropColumnQuery
- type DropIndexQuery
- type DropTableQuery
- type Executor
- type ExprBuilder
- type Field
- type FirstValueBuilder
- type ForeignKeyBuilder
- type FrameBoundKind
- type FrameType
- type FromDirection
- type FuzzyKind
- type IDModel
- type IndexMethod
- type InsertQuery
- type JSONArrayAggBuilder
- type JSONObjectAggBuilder
- type JoinType
- type LagBuilder
- type LastValueBuilder
- type LeadBuilder
- type MaxBuilder
- type MergeInsertBuilder
- type MergeQuery
- type MergeUpdateBuilder
- type MergeWhenBuilder
- type MinBuilder
- type Model
- type NTileBuilder
- type NthValueBuilder
- type NullsMode
- type OrderBuilder
- type PKField
- type PartitionStrategy
- type PercentRankBuilder
- type PrimaryKeyBuilder
- type QueryBuilder
- type RankBuilder
- type RawQuery
- type ReferenceAction
- type Relation
- type RelationSpec
- type RowNumberBuilder
- type SelectQuery
- type StatisticalMode
- type StdDevBuilder
- type StringAggBuilder
- type SumBuilder
- type Table
- type TableTarget
- type TruncateTableQuery
- type Tx
- type UniqueBuilder
- type UpdateQuery
- type VarianceBuilder
- type WindowArrayAggBuilder
- type WindowAvgBuilder
- type WindowBitAndBuilder
- type WindowBitOrBuilder
- type WindowBoolAndBuilder
- type WindowBoolOrBuilder
- type WindowCountBuilder
- type WindowJSONArrayAggBuilder
- type WindowJSONObjectAggBuilder
- type WindowMaxBuilder
- type WindowMinBuilder
- type WindowStdDevBuilder
- type WindowStringAggBuilder
- type WindowSumBuilder
- type WindowVarianceBuilder
Constants ¶
const ( // JoinType constants. JoinDefault = orm.JoinDefault JoinInner = orm.JoinInner JoinLeft = orm.JoinLeft JoinRight = orm.JoinRight JoinFull = orm.JoinFull JoinCross = orm.JoinCross // FuzzyKind constants. FuzzyStarts = orm.FuzzyStarts FuzzyEnds = orm.FuzzyEnds FuzzyContains = orm.FuzzyContains // NullsMode constants. NullsDefault = orm.NullsDefault NullsRespect = orm.NullsRespect NullsIgnore = orm.NullsIgnore // FromDirection constants. FromDefault = orm.FromDefault FromFirst = orm.FromFirst FromLast = orm.FromLast // FrameType constants. FrameDefault = orm.FrameDefault FrameRows = orm.FrameRows FrameRange = orm.FrameRange FrameGroups = orm.FrameGroups // FrameBoundKind constants. FrameBoundNone = orm.FrameBoundNone FrameBoundUnboundedPreceding = orm.FrameBoundUnboundedPreceding FrameBoundUnboundedFollowing = orm.FrameBoundUnboundedFollowing FrameBoundCurrentRow = orm.FrameBoundCurrentRow FrameBoundPreceding = orm.FrameBoundPreceding FrameBoundFollowing = orm.FrameBoundFollowing // StatisticalMode constants. StatisticalDefault = "" StatisticalPopulation = orm.StatisticalPopulation StatisticalSample = orm.StatisticalSample // ConflictAction constants. ConflictDoNothing = orm.ConflictDoNothing ConflictDoUpdate = orm.ConflictDoUpdate // DateTimeUnit constants. UnitYear = orm.UnitYear UnitMonth = orm.UnitMonth UnitDay = orm.UnitDay UnitHour = orm.UnitHour UnitMinute = orm.UnitMinute UnitSecond = orm.UnitSecond // Placeholder key for named arguments in database queries. PlaceholderKeyOperator = orm.PlaceholderKeyOperator // System operators for audit tracking. OperatorSystem = orm.OperatorSystem OperatorCronJob = orm.OperatorCronJob OperatorAnonymous = orm.OperatorAnonymous // SQL expression placeholders for query building. ExprOperator = orm.ExprOperator ExprTableColumns = orm.ExprTableColumns ExprColumns = orm.ExprColumns ExprTablePKs = orm.ExprTablePKs ExprPKs = orm.ExprPKs ExprTableName = orm.ExprTableName ExprTableAlias = orm.ExprTableAlias // Database column names for audit fields. ColumnID = orm.ColumnID ColumnCreatedAt = orm.ColumnCreatedAt ColumnUpdatedAt = orm.ColumnUpdatedAt ColumnCreatedBy = orm.ColumnCreatedBy ColumnUpdatedBy = orm.ColumnUpdatedBy ColumnCreatedByName = orm.ColumnCreatedByName ColumnUpdatedByName = orm.ColumnUpdatedByName // Go struct field names corresponding to audit columns. FieldID = orm.FieldID FieldCreatedAt = orm.FieldCreatedAt FieldUpdatedAt = orm.FieldUpdatedAt FieldCreatedBy = orm.FieldCreatedBy FieldUpdatedBy = orm.FieldUpdatedBy FieldCreatedByName = orm.FieldCreatedByName FieldUpdatedByName = orm.FieldUpdatedByName // ReferenceAction constants. ReferenceCascade = orm.ReferenceCascade ReferenceRestrict = orm.ReferenceRestrict ReferenceSetNull = orm.ReferenceSetNull ReferenceSetDefault = orm.ReferenceSetDefault ReferenceNoAction = orm.ReferenceNoAction // IndexMethod constants. IndexBTree = orm.IndexBTree IndexHash = orm.IndexHash IndexGIN = orm.IndexGIN IndexGiST = orm.IndexGiST IndexSPGiST = orm.IndexSPGiST IndexBRIN = orm.IndexBRIN // PartitionStrategy constants. PartitionRange = orm.PartitionRange PartitionList = orm.PartitionList PartitionHash = orm.PartitionHash )
Variables ¶
var ( ApplySort = orm.ApplySort // DataType is the factory for creating type-safe SQL data type definitions. DataType = orm.DataType )
var ( NotNull = orm.NotNull Nullable = orm.Nullable Default = orm.Default PrimaryKey = orm.PrimaryKey Unique = orm.Unique AutoIncrement = orm.AutoIncrement Check = orm.Check References = orm.References )
DDL constraint constructors.
Functions ¶
This section is empty.
Types ¶
type AddColumnQuery ¶
type AddColumnQuery = orm.AddColumnQuery
type AfterDeleteHook ¶
type AfterDeleteHook interface {
bun.AfterDeleteHook
// AfterDelete is invoked with the query context and the delete query that was executed.
AfterDelete(ctx context.Context, query *BunDeleteQuery) error
}
AfterDeleteHook is called after a DELETE query is executed. Implement this on model structs to perform cleanup or trigger side effects after deletion.
type AfterInsertHook ¶
type AfterInsertHook interface {
bun.AfterInsertHook
// AfterInsert is invoked with the query context and the insert query that was executed.
AfterInsert(ctx context.Context, query *BunInsertQuery) error
}
AfterInsertHook is called after an INSERT query is executed. Implement this on model structs to trigger side effects after successful insertion.
type AfterScanRowHook ¶
type AfterScanRowHook = bun.AfterScanRowHook
type AfterSelectHook ¶
type AfterSelectHook interface {
bun.AfterSelectHook
// AfterSelect is invoked with the query context and the select query that was executed.
AfterSelect(ctx context.Context, query *BunSelectQuery) error
}
AfterSelectHook is called after a SELECT query is executed. Implement this on model structs to post-process fetched data or perform side effects.
type AfterUpdateHook ¶
type AfterUpdateHook interface {
bun.AfterUpdateHook
// AfterUpdate is invoked with the query context and the update query that was executed.
AfterUpdate(ctx context.Context, query *BunUpdateQuery) error
}
AfterUpdateHook is called after an UPDATE query is executed. Implement this on model structs to trigger side effects after successful update.
type ArrayAggBuilder ¶
type ArrayAggBuilder = orm.ArrayAggBuilder
type AuditedModel ¶
type AuditedModel = orm.AuditedModel
type AvgBuilder ¶
type AvgBuilder = orm.AvgBuilder
type BeforeDeleteHook ¶
type BeforeDeleteHook interface {
bun.BeforeDeleteHook
// BeforeDelete is invoked with the query context and the delete query about to be executed.
BeforeDelete(ctx context.Context, query *BunDeleteQuery) error
}
BeforeDeleteHook is called before a DELETE query is executed. Implement this on model structs to validate or perform cleanup before deletion.
type BeforeInsertHook ¶
type BeforeInsertHook interface {
bun.BeforeInsertHook
// BeforeInsert is invoked with the query context and the insert query about to be executed.
BeforeInsert(ctx context.Context, query *BunInsertQuery) error
}
BeforeInsertHook is called before an INSERT query is executed. Implement this on model structs to set default values or validate data before insertion.
type BeforeScanRowHook ¶
type BeforeScanRowHook = bun.BeforeScanRowHook
type BeforeSelectHook ¶
type BeforeSelectHook interface {
bun.BeforeSelectHook
// BeforeSelect is invoked with the query context and the select query about to be executed.
BeforeSelect(ctx context.Context, query *BunSelectQuery) error
}
BeforeSelectHook is called before a SELECT query is executed. Implement this on model structs to modify the query or add conditions before data is fetched.
type BeforeUpdateHook ¶
type BeforeUpdateHook interface {
bun.BeforeUpdateHook
// BeforeUpdate is invoked with the query context and the update query about to be executed.
BeforeUpdate(ctx context.Context, query *BunUpdateQuery) error
}
BeforeUpdateHook is called before an UPDATE query is executed. Implement this on model structs to validate changes or modify fields before the update.
type BitAndBuilder ¶
type BitAndBuilder = orm.BitAndBuilder
type BitOrBuilder ¶
type BitOrBuilder = orm.BitOrBuilder
type BoolAndBuilder ¶
type BoolAndBuilder = orm.BoolAndBuilder
type BoolOrBuilder ¶
type BoolOrBuilder = orm.BoolOrBuilder
type BunDeleteQuery ¶
type BunDeleteQuery = bun.DeleteQuery
type BunInsertQuery ¶
type BunInsertQuery = bun.InsertQuery
type BunSelectQuery ¶
type BunSelectQuery = bun.SelectQuery
type BunUpdateQuery ¶
type BunUpdateQuery = bun.UpdateQuery
type CaseBuilder ¶
type CaseBuilder = orm.CaseBuilder
type CaseWhenBuilder ¶
type CaseWhenBuilder = orm.CaseWhenBuilder
type CheckBuilder ¶
type CheckBuilder = orm.CheckBuilder
type ColumnConstraint ¶
type ColumnConstraint = orm.ColumnConstraint
type ColumnInfo ¶
type ColumnInfo = orm.ColumnInfo
type ConditionBuilder ¶
type ConditionBuilder = orm.ConditionBuilder
type ConflictAction ¶
type ConflictAction = orm.ConflictAction
type ConflictBuilder ¶
type ConflictBuilder = orm.ConflictBuilder
type ConflictUpdateBuilder ¶
type ConflictUpdateBuilder = orm.ConflictUpdateBuilder
type CountBuilder ¶
type CountBuilder = orm.CountBuilder
type CreateIndexQuery ¶
type CreateIndexQuery = orm.CreateIndexQuery
type CreateTableQuery ¶
type CreateTableQuery = orm.CreateTableQuery
type CreatedModel ¶
type CreatedModel = orm.CreatedModel
type CumeDistBuilder ¶
type CumeDistBuilder = orm.CumeDistBuilder
type DateTimeUnit ¶
type DateTimeUnit = orm.DateTimeUnit
type DeleteQuery ¶
type DeleteQuery = orm.DeleteQuery
type DenseRankBuilder ¶
type DenseRankBuilder = orm.DenseRankBuilder
type DropColumnQuery ¶
type DropColumnQuery = orm.DropColumnQuery
type DropIndexQuery ¶
type DropIndexQuery = orm.DropIndexQuery
type DropTableQuery ¶
type DropTableQuery = orm.DropTableQuery
type ExprBuilder ¶
type ExprBuilder = orm.ExprBuilder
type FirstValueBuilder ¶
type FirstValueBuilder = orm.FirstValueBuilder
type ForeignKeyBuilder ¶
type ForeignKeyBuilder = orm.ForeignKeyBuilder
type FrameBoundKind ¶
type FrameBoundKind = orm.FrameBoundKind
type FromDirection ¶
type FromDirection = orm.FromDirection
type IndexMethod ¶
type IndexMethod = orm.IndexMethod
type InsertQuery ¶
type InsertQuery = orm.InsertQuery
type JSONArrayAggBuilder ¶
type JSONArrayAggBuilder = orm.JSONArrayAggBuilder
type JSONObjectAggBuilder ¶
type JSONObjectAggBuilder = orm.JSONObjectAggBuilder
type LagBuilder ¶
type LagBuilder = orm.LagBuilder
type LastValueBuilder ¶
type LastValueBuilder = orm.LastValueBuilder
type LeadBuilder ¶
type LeadBuilder = orm.LeadBuilder
type MaxBuilder ¶
type MaxBuilder = orm.MaxBuilder
type MergeInsertBuilder ¶
type MergeInsertBuilder = orm.MergeInsertBuilder
type MergeQuery ¶
type MergeQuery = orm.MergeQuery
type MergeUpdateBuilder ¶
type MergeUpdateBuilder = orm.MergeUpdateBuilder
type MergeWhenBuilder ¶
type MergeWhenBuilder = orm.MergeWhenBuilder
type MinBuilder ¶
type MinBuilder = orm.MinBuilder
type NTileBuilder ¶
type NTileBuilder = orm.NTileBuilder
type NthValueBuilder ¶
type NthValueBuilder = orm.NthValueBuilder
type OrderBuilder ¶
type OrderBuilder = orm.OrderBuilder
type PartitionStrategy ¶
type PartitionStrategy = orm.PartitionStrategy
type PercentRankBuilder ¶
type PercentRankBuilder = orm.PercentRankBuilder
type PrimaryKeyBuilder ¶
type PrimaryKeyBuilder = orm.PrimaryKeyBuilder
type QueryBuilder ¶
type QueryBuilder = orm.QueryBuilder
type RankBuilder ¶
type RankBuilder = orm.RankBuilder
type ReferenceAction ¶
type ReferenceAction = orm.ReferenceAction
type RelationSpec ¶
type RelationSpec = orm.RelationSpec
type RowNumberBuilder ¶
type RowNumberBuilder = orm.RowNumberBuilder
type SelectQuery ¶
type SelectQuery = orm.SelectQuery
type StatisticalMode ¶
type StatisticalMode = orm.StatisticalMode
type StdDevBuilder ¶
type StdDevBuilder = orm.StdDevBuilder
type StringAggBuilder ¶
type StringAggBuilder = orm.StringAggBuilder
type SumBuilder ¶
type SumBuilder = orm.SumBuilder
type TableTarget ¶
type TableTarget[T orm.Executor] = orm.TableTarget[T]
type TruncateTableQuery ¶
type TruncateTableQuery = orm.TruncateTableQuery
type UniqueBuilder ¶
type UniqueBuilder = orm.UniqueBuilder
type UpdateQuery ¶
type UpdateQuery = orm.UpdateQuery
type VarianceBuilder ¶
type VarianceBuilder = orm.VarianceBuilder
type WindowArrayAggBuilder ¶
type WindowArrayAggBuilder = orm.WindowArrayAggBuilder
type WindowAvgBuilder ¶
type WindowAvgBuilder = orm.WindowAvgBuilder
type WindowBitAndBuilder ¶
type WindowBitAndBuilder = orm.WindowBitAndBuilder
type WindowBitOrBuilder ¶
type WindowBitOrBuilder = orm.WindowBitOrBuilder
type WindowBoolAndBuilder ¶
type WindowBoolAndBuilder = orm.WindowBoolAndBuilder
type WindowBoolOrBuilder ¶
type WindowBoolOrBuilder = orm.WindowBoolOrBuilder
type WindowCountBuilder ¶
type WindowCountBuilder = orm.WindowCountBuilder
type WindowJSONArrayAggBuilder ¶
type WindowJSONArrayAggBuilder = orm.WindowJSONArrayAggBuilder
type WindowJSONObjectAggBuilder ¶
type WindowJSONObjectAggBuilder = orm.WindowJSONObjectAggBuilder
type WindowMaxBuilder ¶
type WindowMaxBuilder = orm.WindowMaxBuilder
type WindowMinBuilder ¶
type WindowMinBuilder = orm.WindowMinBuilder
type WindowStdDevBuilder ¶
type WindowStdDevBuilder = orm.WindowStdDevBuilder
type WindowStringAggBuilder ¶
type WindowStringAggBuilder = orm.WindowStringAggBuilder
type WindowSumBuilder ¶
type WindowSumBuilder = orm.WindowSumBuilder
type WindowVarianceBuilder ¶
type WindowVarianceBuilder = orm.WindowVarianceBuilder