sqlutil

package

v0.34.1 Latest Latest Go to latest Published: Sep 29, 2025 License: Apache-2.0 Imports: 20 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/target/goalert

Links

Open Source Insights

Documentation ¶

Index ¶

func QuoteID(parts ...string) string
func Rollback(ctx context.Context, errMsg string, tx *sql.Tx)
func RollbackContext(ctx context.Context, errMsg string, tx Tx)
func SplitQuery(query string) []string
type BoolArray
- func (s *BoolArray) Scan(src interface{}) error
- func (s BoolArray) Value() (driver.Value, error)
type Error
- func MapError(err error) *Error
- func (e Error) Error() string
type IntArray
- func (a *IntArray) Scan(src interface{}) error
- func (a IntArray) Value() (driver.Value, error)
type Interval
- func IntervalMicro(dur time.Duration) Interval
type Listener
- func NewListener(p *pgxpool.Pool) *Listener
- func (l *Listener) Handle(channel string, fn func(context.Context, string) error)
- func (l *Listener) Run(ctx context.Context)
- func (l *Listener) Shutdown(context.Context) error
- func (l *Listener) Start()
- func (l *Listener) Stop()
type NullTime
- func (n *NullTime) Scan(src interface{}) error
- func (n NullTime) Value() (driver.Value, error)
type NullUUID
- func (u *NullUUID) Scan(src interface{}) (err error)
- func (u NullUUID) Value() (driver.Value, error)
type NullUUIDArray
- func (s *NullUUIDArray) Scan(src interface{}) error
- func (s NullUUIDArray) Value() (driver.Value, error)
type StringArray
- func (s *StringArray) Scan(src interface{}) error
- func (s StringArray) Value() (driver.Value, error)
type Tx
type UUIDArray
- func (s *UUIDArray) Scan(src interface{}) error
- func (s UUIDArray) Value() (driver.Value, error)

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func QuoteID ¶

func QuoteID(parts ...string) string

func Rollback ¶ added in v0.31.0

func Rollback(ctx context.Context, errMsg string, tx *sql.Tx)

Rollback will roll back the transaction, logging any potential errors other than ErrTxDone and ErrConnDone, which are expected.

Primarily, it's intended to be used with defer as an alternative to calling defer tx.Rollback() which ignores ALL errors.

func RollbackContext ¶ added in v0.31.0

func RollbackContext(ctx context.Context, errMsg string, tx Tx)

RollbackContext provides the same functionality as Rollback, but for a pgx.Tx.

func SplitQuery ¶ added in v0.32.0

func SplitQuery(query string) []string

SplitQuery will split a SQL query into individual queries.

It will split on semicolons, but will ignore semicolons inside of $$ blocks.

Types ¶

type BoolArray ¶

type BoolArray []bool

func (*BoolArray) Scan ¶

func (s *BoolArray) Scan(src interface{}) error

func (BoolArray) Value ¶

func (s BoolArray) Value() (driver.Value, error)

type Error ¶

type Error struct {
	Code           string
	Message        string
	Detail         string
	Hint           string
	TableName      string
	ConstraintName string
	Where          string
	ColumnName     string
	Position       int
	// contains filtered or unexported fields
}

Error represents a driver-agnostic SQL error.

func MapError ¶

func MapError(err error) *Error

MapError will return a Error from the given err object or nil otherwise.

func (Error) Error ¶

func (e Error) Error() string

type IntArray ¶

type IntArray []int

func (*IntArray) Scan ¶

func (a *IntArray) Scan(src interface{}) error

func (IntArray) Value ¶

func (a IntArray) Value() (driver.Value, error)

type Interval ¶ added in v0.34.0

type Interval = pgtype.Interval

func IntervalMicro ¶ added in v0.34.0

func IntervalMicro(dur time.Duration) Interval

IntervalMicro returns a new Interval with the given duration in microseconds.

type Listener ¶

type Listener struct {
	// contains filtered or unexported fields
}

Listener will listen for NOTIFY commands on a set of channels.

func NewListener ¶

func NewListener(p *pgxpool.Pool) *Listener

NewListener will create and initialize a Listener which will automatically reconnect and listen to the provided channels when running.

func (*Listener) Handle ¶ added in v0.34.0

func (l *Listener) Handle(channel string, fn func(context.Context, string) error)

Handle will register a handler for a specific channel.

func (*Listener) Run ¶ added in v0.34.0

func (l *Listener) Run(ctx context.Context)

Run will start the listener and begin listening for notifications.

func (*Listener) Shutdown ¶ added in v0.25.0

func (l *Listener) Shutdown(context.Context) error

Shutdown will shut down the listener and returns after all connections have been completed. It is not necessary to call Stop() before Close().

func (*Listener) Start ¶

func (l *Listener) Start()

Start will enable reconnections and messages.

func (*Listener) Stop ¶

func (l *Listener) Stop()

Stop will end all current connections and stop reconnecting.

type NullTime ¶

type NullTime struct {
	Time  time.Time
	Valid bool // Valid is true if Time is not null
}

func (*NullTime) Scan ¶

func (n *NullTime) Scan(src interface{}) error

func (NullTime) Value ¶

func (n NullTime) Value() (driver.Value, error)

type NullUUID ¶ added in v0.28.0

type NullUUID struct {
	UUID  uuid.UUID
	Valid bool
}

func (*NullUUID) Scan ¶ added in v0.28.0

func (u *NullUUID) Scan(src interface{}) (err error)

func (NullUUID) Value ¶ added in v0.28.0

func (u NullUUID) Value() (driver.Value, error)

type NullUUIDArray ¶ added in v0.28.0

type NullUUIDArray struct {
	UUIDArray UUIDArray
	Valid     bool
}

func (*NullUUIDArray) Scan ¶ added in v0.28.0

func (s *NullUUIDArray) Scan(src interface{}) error

func (NullUUIDArray) Value ¶ added in v0.28.0

func (s NullUUIDArray) Value() (driver.Value, error)

type StringArray ¶

type StringArray []string

func (*StringArray) Scan ¶

func (s *StringArray) Scan(src interface{}) error

func (StringArray) Value ¶

func (s StringArray) Value() (driver.Value, error)

type Tx ¶ added in v0.31.1

type Tx interface {
	Rollback(ctx context.Context) error
}

type UUIDArray ¶

type UUIDArray []string

func (*UUIDArray) Scan ¶

func (s *UUIDArray) Scan(src interface{}) error

func (UUIDArray) Value ¶

func (s UUIDArray) Value() (driver.Value, error)

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL