Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

dbw

package module

Go to main page

Versions in this module

v0

v0.1.4

Jul 29, 2024

v0.1.3

Jul 16, 2024

Changes in this version

type OpType

+ const DefaultBatchSize

type Option

+ func WithBatchSize(size int) Option

type Options

+ WithBatchSize int

v0.1.2

Feb 12, 2024

v0.1.1

Nov 1, 2023

v0.1.0

Aug 28, 2023

Changes in this version

+ const DefaultLimit

+ var ErrInternal = errors.New("internal error")

+ var ErrInvalidFieldMask = errors.New("invalid field mask")

+ var ErrInvalidParameter = errors.New("invalid parameter")

+ var ErrMaxRetries = errors.New("too many retries")

+ var ErrRecordNotFound = errors.New("record not found")

+ var ErrUnknown = errors.New("unknown")

+ func BuildUpdatePaths(fieldValues map[string]interface{}, fieldMask []string, ...) (masks []string, nulls []string)

+ func Clear(i interface{}, fields []string, depth int) error

+ func InitNonCreatableFields(fields []string)

+ func InitNonUpdatableFields(fields []string)

+ func Intersection(av, bv []string) ([]string, map[string]string, map[string]string, error)

+ func NewId(prefix string, opt ...Option) (string, error)

+ func NonCreatableFields() []string

+ func NonUpdatableFields() []string

+ func TestCreateTables(t *testing.T, conn *DB)

+ func UpdateFields(i interface{}, fieldMaskPaths []string, setToNullPaths []string) (map[string]interface{}, error)

+ type Backoff interface

+ Duration func(attemptNumber uint) time.Duration

+ type Column struct

+ Name string

+ Table string

+ type ColumnValue struct

+ Column string

+ Value interface{}

+ func SetColumnValues(columnValues map[string]interface{}) []ColumnValue

+ func SetColumns(names []string) []ColumnValue

+ type Columns []string

+ type ConstBackoff struct

+ DurationMs time.Duration

+ func (b ConstBackoff) Duration(attempt uint) time.Duration

+ type Constraint string

+ type DB struct

+ func Open(dbType DbType, connectionUrl string, opt ...Option) (*DB, error)

+ func OpenWith(dialector Dialector, opt ...Option) (*DB, error)

+ func TestSetup(t *testing.T, opt ...TestOption) (*DB, string)

+ func TestSetupWithMock(t *testing.T) (*DB, sqlmock.Sqlmock)

+ func (db *DB) Close(ctx context.Context) error

+ func (db *DB) DbType() (typ DbType, rawName string, e error)

+ func (db *DB) Debug(on bool)

+ func (db *DB) LogLevel(l LogLevel)

+ func (db *DB) SqlDB(_ context.Context) (*sql.DB, error)

+ type DbType int

+ const Postgres

+ const Sqlite

+ const UnknownDB

+ func StringToDbType(dialect string) (DbType, error)

+ func (db DbType) String() string

+ type Dialector interface

+ type DoNothing bool

+ type ExpBackoff struct

+ func (b ExpBackoff) Duration(attempt uint) time.Duration

+ type ExprValue struct

+ Sql string

+ Vars []interface{}

+ func Expr(expr string, args ...interface{}) ExprValue

+ type LogLevel int

+ const Default

+ const Error

+ const Info

+ const Silent

+ const Warn

+ type OnConflict struct

+ Action interface{}

+ Target interface{}

+ type OpType int

+ const CreateOp

+ const DeleteOp

+ const UnknownOp

+ const UpdateOp

+ type Option func(*Options)

+ func WithAfterWrite(fn func(i interface{}, rowsAffected int) error) Option

+ func WithBeforeWrite(fn func(i interface{}) error) Option

+ func WithDebug(with bool) Option

+ func WithFieldMaskPaths(paths []string) Option

+ func WithLimit(limit int) Option

+ func WithLogLevel(l LogLevel) Option

+ func WithLogger(l hclog.Logger) Option

+ func WithLookup(enable bool) Option

+ func WithMaxOpenConnections(max int) Option

+ func WithMinOpenConnections(max int) Option

+ func WithNullPaths(paths []string) Option

+ func WithOnConflict(onConflict *OnConflict) Option

+ func WithOrder(withOrder string) Option

+ func WithPrngValues(withPrngValues []string) Option

+ func WithReturnRowsAffected(rowsAffected *int64) Option

+ func WithSkipVetForWrite(enable bool) Option

+ func WithTable(name string) Option

+ func WithVersion(version *uint32) Option

+ func WithWhere(whereClause string, args ...interface{}) Option

+ type Options struct

+ WithAfterWrite func(i interface{}, rowsAffected int) error

+ WithBeforeWrite func(i interface{}) error

+ WithDebug bool

+ WithFieldMaskPaths []string

+ WithLimit int

+ WithLogger hclog.Logger

+ WithLookup bool

+ WithMaxOpenConnections int

+ WithMinOpenConnections int

+ WithNullPaths []string

+ WithOnConflict *OnConflict

+ WithOrder string

+ WithPrngValues []string

+ WithRowsAffected *int64

+ WithSkipVetForWrite bool

+ WithTable string

+ WithVersion *uint32

+ WithWhereClause string

+ WithWhereClauseArgs []interface{}

+ func GetOpts(opt ...Option) Options

+ type RW struct

+ func New(underlying *DB) *RW

+ func (rw *RW) Begin(ctx context.Context) (*RW, error)

+ func (rw *RW) Commit(ctx context.Context) error

+ func (rw *RW) Create(ctx context.Context, i interface{}, opt ...Option) error

+ func (rw *RW) CreateItems(ctx context.Context, createItems []interface{}, opt ...Option) error

+ func (rw *RW) DB() *DB

+ func (rw *RW) Delete(ctx context.Context, i interface{}, opt ...Option) (int, error)

+ func (rw *RW) DeleteItems(ctx context.Context, deleteItems []interface{}, opt ...Option) (int, error)

+ func (rw *RW) Dialect() (_ DbType, rawName string, _ error)

+ func (rw *RW) DoTx(ctx context.Context, retryErrorsMatchingFn func(error) bool, retries uint, ...) (RetryInfo, error)

+ func (rw *RW) Exec(ctx context.Context, sql string, values []interface{}, opt ...Option) (int, error)

+ func (rw *RW) IsTx() bool

+ func (rw *RW) LookupBy(ctx context.Context, resourceWithIder interface{}, opt ...Option) error

+ func (rw *RW) LookupByPublicId(ctx context.Context, resource ResourcePublicIder, opt ...Option) error

+ func (rw *RW) LookupWhere(ctx context.Context, resource interface{}, where string, args []interface{}, ...) error

+ func (rw *RW) Query(ctx context.Context, sql string, values []interface{}, opt ...Option) (*sql.Rows, error)

+ func (rw *RW) Rollback(ctx context.Context) error

+ func (rw *RW) ScanRows(rows *sql.Rows, result interface{}) error

+ func (rw *RW) SearchWhere(ctx context.Context, resources interface{}, where string, args []interface{}, ...) error

+ func (rw *RW) Update(ctx context.Context, i interface{}, fieldMaskPaths []string, ...) (int, error)

+ type Reader interface

+ Dialect func() (_ DbType, rawName string, _ error)

+ LookupBy func(ctx context.Context, resource interface{}, opt ...Option) error

+ LookupByPublicId func(ctx context.Context, resource ResourcePublicIder, opt ...Option) error

+ LookupWhere func(ctx context.Context, resource interface{}, where string, args []interface{}, ...) error

+ Query func(ctx context.Context, sql string, values []interface{}, opt ...Option) (*sql.Rows, error)

+ ScanRows func(rows *sql.Rows, result interface{}) error

+ SearchWhere func(ctx context.Context, resources interface{}, where string, args []interface{}, ...) error

+ type ResourcePrivateIder interface

+ GetPrivateId func() string

+ type ResourcePublicIder interface

+ GetPublicId func() string

+ type RetryInfo struct

+ Backoff time.Duration

+ Retries int

+ type TestOption func(*testOptions)

+ func WithTestDatabaseUrl(url string) TestOption

+ func WithTestDialect(dialect string) TestOption

+ func WithTestMigration(migrationFn func(ctx context.Context, dialect, url string) error) TestOption

+ func WithTestMigrationUsingDB(migrationFn func(ctx context.Context, db *sql.DB) error) TestOption

+ type TxHandler func(Reader, Writer) error

+ type UpdateAll bool

+ type VetForWriter interface

+ VetForWrite func(ctx context.Context, r Reader, opType OpType, opt ...Option) error

+ type Writer interface

+ Begin func(ctx context.Context) (*RW, error)

+ Commit func(ctx context.Context) error

+ Create func(ctx context.Context, i interface{}, opt ...Option) error

+ CreateItems func(ctx context.Context, createItems []interface{}, opt ...Option) error

+ Delete func(ctx context.Context, i interface{}, opt ...Option) (int, error)

+ DeleteItems func(ctx context.Context, deleteItems []interface{}, opt ...Option) (int, error)

+ Dialect func() (_ DbType, rawName string, _ error)

+ DoTx func(ctx context.Context, retryErrorsMatchingFn func(error) bool, retries uint, ...) (RetryInfo, error)

+ Exec func(ctx context.Context, sql string, values []interface{}, opt ...Option) (int, error)

+ Query func(ctx context.Context, sql string, values []interface{}, opt ...Option) (*sql.Rows, error)

+ Rollback func(ctx context.Context) error

+ ScanRows func(rows *sql.Rows, result interface{}) error

+ Update func(ctx context.Context, i interface{}, fieldMaskPaths []string, ...) (int, error)