query.go

// Copyright (c) HashiCorp, Inc.
// SPDX-License-Identifier: MPL-2.0

package dbw

import (
	"context"
	"database/sql"
	"fmt"
)

// Query will run the raw query and return the *sql.Rows results. Query will
// operate within the context of any ongoing transaction for the Reader.  The
// caller must close the returned *sql.Rows. Query can/should be used in
// combination with ScanRows. The WithDebug option is supported.
func (rw *RW) Query(ctx context.Context, sql string, values []interface{}, opt ...Option) (*sql.Rows, error) {
	const op = "dbw.Query"
	if rw.underlying == nil {
		return nil, fmt.Errorf("%s: missing underlying db: %w", op, ErrInternal)
	}
	if sql == "" {
		return nil, fmt.Errorf("%s: missing sql: %w", op, ErrInvalidParameter)
	}
	opts := GetOpts(opt...)
	db := rw.underlying.wrapped.WithContext(ctx)
	if opts.WithDebug {
		db = db.Debug()
	}
	db = db.Raw(sql, values...)
	if db.Error != nil {
		return nil, fmt.Errorf("%s: %w", op, db.Error)
	}
	return db.Rows()
}

// ScanRows will scan the rows into the interface
func (rw *RW) ScanRows(rows *sql.Rows, result interface{}) error {
	const op = "dbw.ScanRows"
	if rw.underlying == nil {
		return fmt.Errorf("%s: missing underlying db: %w", op, ErrInternal)
	}
	if rows == nil {
		return fmt.Errorf("%s: missing rows: %w", op, ErrInvalidParameter)
	}
	if isNil(result) {
		return fmt.Errorf("%s: missing result: %w", op, ErrInvalidParameter)
	}
	return rw.underlying.wrapped.ScanRows(rows, result)
}