database

Documentation

Index

• func DetectDriver(dsn string) string
• func Register(name string, factory DriverFactory)
• type BaseDialect
  • func (d *BaseDialect) CaseInsensitiveLike() string
  • func (d *BaseDialect) LimitOffset(limit, offset int) string
  • func (d *BaseDialect) MapType(dbType string) string
  • func (d *BaseDialect) OnConflictClause(columns []string, action string) string
  • func (d *BaseDialect) Placeholder(n int) string
  • func (d *BaseDialect) QuoteIdentifier(name string) string
  • func (d *BaseDialect) ReturningClause(cols ...string) string
  • func (d *BaseDialect) SupportsArrays() bool
  • func (d *BaseDialect) SupportsCTE() bool
  • func (d *BaseDialect) SupportsFullJoin() bool
  • func (d *BaseDialect) SupportsReturning() bool
  • func (d *BaseDialect) SupportsWindowFunctions() bool
  • func (d *BaseDialect) UpsertSupport() bool
• type Column
• type Database
  • func Open(driverName, dsn string) (Database, error)
• type Dialect
• type DriverFactory
• type Relation
• type Result
• type Row
• type Rows
• type SchemaIntrospector
• type StandardType
  • func StandardizeType(dbType, driverName string) StandardType
• type TableSchema
• type Tx

Functions

func DetectDriver

func DetectDriver(dsn string) string

func Register

func Register(name string, factory DriverFactory)

Types

type BaseDialect

type BaseDialect struct{}

func (*BaseDialect) CaseInsensitiveLike

func (d *BaseDialect) CaseInsensitiveLike() string

func (*BaseDialect) LimitOffset

func (d *BaseDialect) LimitOffset(limit, offset int) string

func (*BaseDialect) MapType

func (d *BaseDialect) MapType(dbType string) string

func (*BaseDialect) OnConflictClause

func (d *BaseDialect) OnConflictClause(columns []string, action string) string

func (*BaseDialect) Placeholder

func (d *BaseDialect) Placeholder(n int) string

func (*BaseDialect) QuoteIdentifier

func (d *BaseDialect) QuoteIdentifier(name string) string

func (*BaseDialect) ReturningClause

func (d *BaseDialect) ReturningClause(cols ...string) string

func (*BaseDialect) SupportsArrays

func (d *BaseDialect) SupportsArrays() bool

func (*BaseDialect) SupportsCTE

func (d *BaseDialect) SupportsCTE() bool

func (*BaseDialect) SupportsFullJoin

func (d *BaseDialect) SupportsFullJoin() bool

func (*BaseDialect) SupportsReturning

func (d *BaseDialect) SupportsReturning() bool

func (*BaseDialect) SupportsWindowFunctions

func (d *BaseDialect) SupportsWindowFunctions() bool

func (*BaseDialect) UpsertSupport

func (d *BaseDialect) UpsertSupport() bool

type Column

type Column struct {
	Name       string
	Type       string
	IsNullable bool
}

type Database

type Database interface {
	Connect(ctx context.Context, dsn string) error
	Close() error
	Ping(ctx context.Context) error

	Query(ctx context.Context, query string, args ...interface{}) (Rows, error)
	QueryRow(ctx context.Context, query string, args ...interface{}) Row
	Exec(ctx context.Context, query string, args ...interface{}) (Result, error)

	Begin(ctx context.Context) (Tx, error)

	Dialect() Dialect
	DriverName() string
	Introspector() SchemaIntrospector
}

func Open

func Open(driverName, dsn string) (Database, error)

type Dialect

type Dialect interface {
	Placeholder(n int) string
	SupportsReturning() bool
	ReturningClause(cols ...string) string
	LimitOffset(limit, offset int) string
	QuoteIdentifier(name string) string
	MapType(dbType string) string
	CaseInsensitiveLike() string

	// Query builder capabilities
	SupportsFullJoin() bool
	SupportsWindowFunctions() bool
	SupportsCTE() bool
	SupportsArrays() bool
	OnConflictClause(columns []string, action string) string
	UpsertSupport() bool
}

type DriverFactory

type DriverFactory func() Database

type Relation

type Relation struct {
	ChildTable   string
	ChildColumn  string
	ParentTable  string
	ParentColumn string
}

type Result

type Result interface {
	LastInsertId() (int64, error)
	RowsAffected() (int64, error)
}

type Row

type Row interface {
	Scan(dest ...interface{}) error
}

type Rows

type Rows interface {
	Next() bool
	Scan(dest ...interface{}) error
	Close() error
	Err() error
}

type SchemaIntrospector

type SchemaIntrospector interface {
	LoadSchema(ctx context.Context) ([]TableSchema, error)
	GetColumns(ctx context.Context, tableName string) ([]Column, error)
	GetRelations(ctx context.Context) ([]Relation, error)
}

type StandardType

type StandardType string

const (
	TypeInteger   StandardType = "integer"
	TypeBigInt    StandardType = "bigint"
	TypeString    StandardType = "string"
	TypeText      StandardType = "text"
	TypeBoolean   StandardType = "boolean"
	TypeTimestamp StandardType = "timestamp"
	TypeUUID      StandardType = "uuid"
	TypeJSON      StandardType = "json"
	TypeFloat     StandardType = "float"
	TypeDecimal   StandardType = "decimal"
	TypeDate      StandardType = "date"
	TypeTime      StandardType = "time"
	TypeBytea     StandardType = "bytea"
)

func StandardizeType

func StandardizeType(dbType, driverName string) StandardType

type TableSchema

type TableSchema struct {
	TableName string
	Columns   []Column
	Relations []Relation
}

type Tx

type Tx interface {
	Query(ctx context.Context, query string, args ...interface{}) (Rows, error)
	QueryRow(ctx context.Context, query string, args ...interface{}) Row
	Exec(ctx context.Context, query string, args ...interface{}) (Result, error)
	Commit(ctx context.Context) error
	Rollback(ctx context.Context) error
}