dbhelper

Documentation

Overview

Package dbhelper wraps SQL and specific capabilities of an SQL db

Index

• func Register(driverName string, helper Helper)
• type Helper
  • func GetHelper(driverName string) (Helper, bool)

Functions

func Register

func Register(driverName string, helper Helper)

Register registers a new SQL helper

Types

type Helper

type Helper interface {
	fmt.Stringer
	// Supports indicates if this helper supports this driver name
	Supports(driverName string) bool
	// PreConnect calculates the connect URL for the db from a canonical URL used in Fn config
	PreConnect(url *url.URL) (string, error)
	// PostCreate  Apply any configuration to the DB prior to use
	PostCreate(db *sqlx.DB) (*sqlx.DB, error)
	// CheckTableExists checks if a table exists in the DB
	CheckTableExists(tx *sqlx.Tx, table string) (bool, error)
	// IsDuplicateKeyError determines if an error indicates if the prior error was caused by a duplicate key insert
	IsDuplicateKeyError(err error) bool
}

Helper provides DB-specific SQL capabilities

func GetHelper

func GetHelper(driverName string) (Helper, bool)

GetHelper returns a helper for a specific driver