Inspecting queries

ant never hides what it sends. Each of these lets you look, from a single query up to a whole unit of work.

ToSQL

ToSQLfunc (q *Query[T]) ToSQL() (string, []any, error)ToSQL returns the SELECT this query would run. returns a query's statement and arguments, with no database involved.

text, args, err := db.Users.Where(ant.Gt(&U.Age, 18)).OrderBy(&U.Name).Limit(5).ToSQL()

SELECT "users"."id", ... FROM "users" WHERE "users"."age" > $1 ORDER BY "users"."name" LIMIT $2

args is [18 5]. ToSQLContextfunc (q *Query[T]) ToSQLContext(ctx context.Context) (string, []any, error)ToSQLContext is ToSQL with global filters resolved against ctx. applies global filters from a context. UpdateSQLfunc (q *Query[T]) UpdateSQL(ctx context.Context, set ...Assignment) (string, []any, error)UpdateSQL returns the statement Update would run, for sending it some other way, such as in a pipelined batch. and DeleteSQLfunc (q *Query[T]) DeleteSQL(ctx context.Context) (string, []any, error)DeleteSQL returns the statement Delete would run. do the same for writes.

Explain

Explainfunc (q *Query[T]) Explain(ctx context.Context) (string, error)Explain returns the database's plan for this query. returns the database's plan.

plan, err := db.Users.Where(ant.Gt(&U.Age, 18)).Explain(ctx)

Debug

Debugfunc (q *Query[T]) Debug() *Query[T]Debug logs this query's SQL and values when it runs, at info level, through slog's default logger. logs one query's SQL and values, through slog's default logger, for a moment at a desk. It shows values, so don't leave it in code.

users, err := db.Users.Where(ant.Eq(&U.Name, "Alice")).Debug().All(ctx)

DryRun

ant.DryRunfunc DryRun[DB any](ctx context.Context, db *DB, fn func(tx *DB) error) ([]Statement, error)DryRun runs fn in a transaction and rolls it back, returning every statement it ran. runs real code in a transaction, returns every statement, and rolls back, which shows what a unit of work decides to write. Sequences still move on, and whatever the function does outside the database still happens.

statements, err := ant.DryRun(ctx, db, func(tx *AppDB) error {
	return tx.Users.Insert(ctx, &User{Name: "Temp", Email: "temp@example.com"})
})

for _, s := range statements {
	fmt.Println(s.SQL)
}

See it tested: tests/features/developer_tooling