Go Audit

The Bun adapter installs a Bun QueryHook so every insert, update, and delete is captured automatically.

Installation

go get github.com/gopackx/go-audit/adapters/bun

Setup

import (
    "context"
    "database/sql"

    "github.com/gopackx/go-audit"
    auditbun "github.com/gopackx/go-audit/adapters/bun"
    "github.com/uptrace/bun"
    "github.com/uptrace/bun/dialect/pgdialect"
)

// sqlDB is the underlying *sql.DB (not *bun.DB)
bunDB := bun.NewDB(sqlDB, pgdialect.New())

auditor, err := audit.New(sqlDB, audit.Config{
    Dialect: audit.PostgreSQL,
    UserFunc: func(ctx context.Context) (string, string) {
        return "user-123", "user"
    },
    DataAudit: audit.DataAuditConfig{Enabled: true},
})
if err != nil {
    return err
}

auditbun.Register(bunDB, auditor)

if err := auditor.AutoMigrate(context.Background()); err != nil {
    return err
}

audit.New and Bun both use the same *sql.DB. The audit hook is attached to bunDB.

How It Works

The adapter installs a single QueryHook on the bun.DB that:

Records INSERTs with new_values.
Before each UPDATE/DELETE, issues a SELECT against the same table to snapshot affected rows (skipped if DataAudit.SkipOldValues is set).
Records UPDATEs with diffed old/new values.
Records DELETEs with old values.

Snapshot Strategy (UPDATE/DELETE)

The adapter tries two strategies in order:

By primary key. If the caller's model has PK values set (NewUpdate().Model(&x).WherePK() or bulk model updates), snapshots are SELECT ... WHERE pk IN (...).
By rendered WHERE clause. Otherwise, the adapter parses the rendered SQL and issues an equivalent SELECT * FROM <table> WHERE <same clause>.

Supported Operations

db.NewInsert()
db.NewUpdate()
db.NewDelete()

Batch operations are grouped under one transaction_id.

Caveats

Transactions. The snapshot SELECT runs against the base *bun.DB, not the current *bun.Tx. Rows written earlier in the same transaction are not visible to the snapshot. For strict transaction-local audits, load old values explicitly before the write, or use the GORM adapter.
Bulk without PKs. If a bulk UPDATE/DELETE uses a custom predicate without PK hints, the adapter emits one audit entry per snapshotted row logging old values only — post-state is not available after a bulk write.
Raw SQL via db.ExecContext bypasses the hook and is not audited.

Bun Adapter