postgresql

Documentation

Index

• Constants
• Variables
• func NewGormDbCreator() data.DbCreator
• func NewGormDialetor(di initDI) gorm.Dialector
• func NewPqErrorTranslator() data.ErrorTranslator
• func Use()
• type GormDialector
  • func NewGormDialectorWithConfig(config postgres.Config) *GormDialector
  • func (d GormDialector) Migrator(db *gorm.DB) gorm.Migrator
• type GormMigrator
  • func NewGormMigrator(db *gorm.DB, dialector gorm.Dialector) *GormMigrator
• type NoOpDbCreator
  • func (g NoOpDbCreator) CreateDatabaseIfNotExist(ctx context.Context, db *gorm.DB) error
  • func (g NoOpDbCreator) Order() int
• type PostgresErrorTranslator
  • func (t PostgresErrorTranslator) Order() int
  • func (t PostgresErrorTranslator) Translate(_ context.Context, err error) error

Constants

const (
	DBCreatorPostgresOrder = iota
)

Variables

var Module = &bootstrap.Module{
	Name:       "postgres-compatible",
	Precedence: bootstrap.DatabasePrecedence,
	Options: []fx.Option{
		fx.Provide(NewGormDialetor,
			pqErrorTranslatorProvider(),
			newAnnotatedGormDbCreator(),
		),
	},
}

Functions

func NewGormDbCreator

func NewGormDbCreator() data.DbCreator

func NewGormDialetor

func NewGormDialetor(di initDI) gorm.Dialector

func NewPqErrorTranslator

func NewPqErrorTranslator() data.ErrorTranslator

func Use

func Use()

Types

type GormDialector

type GormDialector struct {
	postgres.Dialector
}

func NewGormDialectorWithConfig

func NewGormDialectorWithConfig(config postgres.Config) *GormDialector

func (GormDialector) Migrator

func (d GormDialector) Migrator(db *gorm.DB) gorm.Migrator

type GormMigrator

type GormMigrator struct {
	postgres.Migrator
}

GormMigrator Inverted index support: for now, use PostgreSQL-compatible syntax: https://www.cockroachlabs.com/docs/v20.2/inverted-indexes#creation

func NewGormMigrator

func NewGormMigrator(db *gorm.DB, dialector gorm.Dialector) *GormMigrator

type NoOpDbCreator

type NoOpDbCreator struct{}

func (NoOpDbCreator) CreateDatabaseIfNotExist

func (g NoOpDbCreator) CreateDatabaseIfNotExist(ctx context.Context, db *gorm.DB) error

func (NoOpDbCreator) Order

func (g NoOpDbCreator) Order() int

type PostgresErrorTranslator

type PostgresErrorTranslator struct{}

PostgresErrorTranslator implements data.ErrorTranslator it translates pq.Error and pgconn.PgError to data.DataError Note: cockroach uses gorm.io/driver/postgres, which internally uses github.com/jackc/pgx Ref: - Postgres Error: https://www.postgresql.org/docs/11/protocol-error-fields.html - Postgres Error Code: https://www.postgresql.org/docs/11/errcodes-appendix.html

func (PostgresErrorTranslator) Order

func (t PostgresErrorTranslator) Order() int

func (PostgresErrorTranslator) Translate

func (t PostgresErrorTranslator) Translate(_ context.Context, err error) error