errors.go

package pgkit

import (
	"errors"
	"fmt"

	"github.com/jackc/pgx/v5/pgconn"
	"github.com/retailancer/pgkit/query"
)

var (
	// ErrNotFound is returned when no records match the query.
	ErrNotFound = errors.New("pgkit: record not found")

	// ErrMultipleRecords is returned when a single record was expected but multiple were returned.
	ErrMultipleRecords = errors.New("pgkit: multiple records returned")

	// ErrUniqueViolation is returned when a unique constraint is violated.
	ErrUniqueViolation = errors.New("pgkit: unique constraint violation")

	// ErrForeignKeyViolation is returned when a foreign key constraint is violated.
	ErrForeignKeyViolation = errors.New("pgkit: foreign key constraint violation")

	// ErrCheckViolation is returned when a check constraint is violated.
	ErrCheckViolation = errors.New("pgkit: check constraint violation")

	// ErrNullViolation is returned when a NOT NULL constraint is violated.
	ErrNullViolation = errors.New("pgkit: not-null constraint violation")

	// ErrConnectionFailed is returned when connection to database cannot be established.
	ErrConnectionFailed = errors.New("pgkit: connection failed")

	// ErrTxClosed is returned when an action is performed on an already committed/rolled back transaction.
	ErrTxClosed = errors.New("pgkit: transaction already closed")

	// ErrUnknownQuery is returned when an unsupported query type is executed.
	ErrUnknownQuery = errors.New("pgkit: unknown query type")

	// ErrTxAlreadyStarted is returned when starting an already active transaction on a client.
	ErrTxAlreadyStarted = errors.New("pgkit: transaction already started")

	// ErrInvalidPointer is returned when a non-pointer type is passed to Scan methods.
	ErrInvalidPointer = query.ErrInvalidPointer

	// ErrDataCannotBeScanned is returned when query result shape doesn't match scan destination structure.
	ErrDataCannotBeScanned = query.ErrDataCannotBeScanned

	// ErrColumnNotFound is returned when a column referenced by a query is not present
	// on the target table. For example soft-deleting a table that lacks the configured
	// SoftDeleteColumn, or explicitly requesting updated_at on a table without one.
	ErrColumnNotFound = query.ErrColumnNotFound

	// ErrTableNotFound is returned when the target table does not exist in the configured schema.
	ErrTableNotFound = query.ErrTableNotFound

	// ErrSoftDeleteNotConfigured is returned when a soft delete is requested but no
	// SoftDeleteColumn was set in Options.
	ErrSoftDeleteNotConfigured = query.ErrSoftDeleteNotConfigured

	// ErrResolverRequired is returned when a query needs column introspection but has no
	// resolver available. Queries using Omit, or Join without Selection, require a live handle.
	ErrResolverRequired = query.ErrResolverRequired

	// ErrSelectionConflict is returned when Selection and Omit are both set on the same
	// Get or Join. They are mutually exclusive.
	ErrSelectionConflict = query.ErrSelectionConflict

	// ErrAllColumnsOmitted is returned when Omit would remove every column from a table.
	ErrAllColumnsOmitted = query.ErrAllColumnsOmitted

	// ErrJoinConditionMissing is returned when a Join has an empty On map.
	ErrJoinConditionMissing = query.ErrJoinConditionMissing

	// ErrEmptyData is returned when a write query has no fields to write.
	ErrEmptyData = query.ErrEmptyData

	// ErrEmptyConflictOn is returned when an Upsert has no conflict target.
	ErrEmptyConflictOn = query.ErrEmptyConflictOn

	// ErrEmptyValues is returned when an InsertMany has no rows.
	ErrEmptyValues = query.ErrEmptyValues

	// ErrRowLengthMismatch is returned when an InsertMany row has fewer values than fields.
	ErrRowLengthMismatch = query.ErrRowLengthMismatch

	// ErrIndexOutOfBounds is returned when a scan index falls outside the result set.
	ErrIndexOutOfBounds = query.ErrIndexOutOfBounds

	// ErrUnsupportedQuery is returned when an unrecognised query type is built.
	ErrUnsupportedQuery = query.ErrUnsupportedQuery

	// ErrColumnLookupFailed is returned when column introspection fails — for example
	// when the information_schema query fails or the caller lacks privileges.
	ErrColumnLookupFailed = query.ErrColumnLookupFailed
)

type SchemaError = query.SchemaError

func NewSchemaError(sentinel error, schema, table, column, field string) *SchemaError {
	return query.NewSchemaError(sentinel, schema, table, column, field)
}

// IsPgErrorCode checks if err or any error in its chain is a PostgreSQL error with the specified code.
func IsPgErrorCode(err error, code string) bool {
	var pgErr *pgconn.PgError
	if errors.As(err, &pgErr) {
		return pgErr.Code == code
	}
	return false
}

// MapError translates standard pgconn.PgError errors into friendly sentinel errors.
func MapError(err error) error {
	if err == nil {
		return nil
	}
	var pgErr *pgconn.PgError
	if errors.As(err, &pgErr) {
		switch pgErr.Code {
		case "23505": // unique_violation
			return fmt.Errorf("%w: %w", ErrUniqueViolation, pgErr)
		case "23503": // foreign_key_violation
			return fmt.Errorf("%w: %w", ErrForeignKeyViolation, pgErr)
		case "23514": // check_violation
			return fmt.Errorf("%w: %w", ErrCheckViolation, pgErr)
		case "23502": // not_null_violation
			return fmt.Errorf("%w: %w", ErrNullViolation, pgErr)
		case "42703": // undefined_column
			return fmt.Errorf("%w: %w", ErrColumnNotFound, pgErr)
		case "42P01": // undefined_table
			return fmt.Errorf("%w: %w", ErrTableNotFound, pgErr)
		}
	}
	return err
}