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

postgres

package module

Go to main page

Versions in this module

v1

v1.17.1

Feb 3, 2026

v1.17.0

Feb 2, 2026

v1.4.1

Sep 9, 2025

v1.4.0

Jul 20, 2025

Changes in this version

+ const Name

+ var ConfigNotFound = errors.New("not found database configuration")

+ var FailedToGenerateDSN = errors.New("failed to generate DSN, please check the database configuration")

+ type Config struct

+ func NewConfig(config config.Config, connection string) *Config

+ func (r *Config) Config() config.Config

+ func (r *Config) Connection() string

+ func (r *Config) Readers() []contracts.FullConfig

+ func (r *Config) Writers() []contracts.FullConfig

type Docker

+ func (r *Docker) Reuse(containerID string, port int) error

+ type Grammar struct

+ func NewGrammar(prefix string) *Grammar

+ func (r *Grammar) CompileAdd(blueprint driver.Blueprint, command *driver.Command) string

+ func (r *Grammar) CompileChange(blueprint driver.Blueprint, command *driver.Command) []string

+ func (r *Grammar) CompileColumns(schema, table string) (string, error)

+ func (r *Grammar) CompileComment(blueprint driver.Blueprint, command *driver.Command) string

+ func (r *Grammar) CompileCreate(blueprint driver.Blueprint) string

+ func (r *Grammar) CompileDefault(_ driver.Blueprint, _ *driver.Command) string

+ func (r *Grammar) CompileDrop(blueprint driver.Blueprint) string

+ func (r *Grammar) CompileDropAllDomains(domains []string) string

+ func (r *Grammar) CompileDropAllTables(schema string, tables []driver.Table) []string

+ func (r *Grammar) CompileDropAllTypes(schema string, types []driver.Type) []string

+ func (r *Grammar) CompileDropAllViews(schema string, views []driver.View) []string

+ func (r *Grammar) CompileDropColumn(blueprint driver.Blueprint, command *driver.Command) []string

+ func (r *Grammar) CompileDropForeign(blueprint driver.Blueprint, command *driver.Command) string

+ func (r *Grammar) CompileDropFullText(blueprint driver.Blueprint, command *driver.Command) string

+ func (r *Grammar) CompileDropIfExists(blueprint driver.Blueprint) string

+ func (r *Grammar) CompileDropIndex(blueprint driver.Blueprint, command *driver.Command) string

+ func (r *Grammar) CompileDropPrimary(blueprint driver.Blueprint, command *driver.Command) string

+ func (r *Grammar) CompileDropUnique(blueprint driver.Blueprint, command *driver.Command) string

+ func (r *Grammar) CompileForeign(blueprint driver.Blueprint, command *driver.Command) string

+ func (r *Grammar) CompileForeignKeys(schema, table string) string

+ func (r *Grammar) CompileFullText(blueprint driver.Blueprint, command *driver.Command) string

+ func (r *Grammar) CompileInRandomOrder(builder sq.SelectBuilder, conditions *driver.Conditions) sq.SelectBuilder

+ func (r *Grammar) CompileIndex(blueprint driver.Blueprint, command *driver.Command) string

+ func (r *Grammar) CompileIndexes(schema, table string) (string, error)

+ func (r *Grammar) CompileJsonColumnsUpdate(values map[string]any) (map[string]any, error)

+ func (r *Grammar) CompileJsonContains(column string, value any, isNot bool) (string, []any, error)

+ func (r *Grammar) CompileJsonContainsKey(column string, isNot bool) string

+ func (r *Grammar) CompileJsonLength(column string) string

+ func (r *Grammar) CompileJsonSelector(column string) string

+ func (r *Grammar) CompileJsonValues(args ...any) []any

+ func (r *Grammar) CompileLockForUpdate(builder sq.SelectBuilder, conditions *driver.Conditions) sq.SelectBuilder

+ func (r *Grammar) CompileLockForUpdateForGorm() clause.Expression

+ func (r *Grammar) CompilePlaceholderFormat() driver.PlaceholderFormat

+ func (r *Grammar) CompilePrimary(blueprint driver.Blueprint, command *driver.Command) string

+ func (r *Grammar) CompilePrune(_ string) string

+ func (r *Grammar) CompileRandomOrderForGorm() string

+ func (r *Grammar) CompileRename(blueprint driver.Blueprint, command *driver.Command) string

+ func (r *Grammar) CompileRenameColumn(blueprint driver.Blueprint, command *driver.Command, _ []driver.Column) (string, error)

+ func (r *Grammar) CompileRenameIndex(blueprint driver.Blueprint, command *driver.Command, _ []driver.Index) []string

+ func (r *Grammar) CompileSharedLock(builder sq.SelectBuilder, conditions *driver.Conditions) sq.SelectBuilder

+ func (r *Grammar) CompileSharedLockForGorm() clause.Expression

+ func (r *Grammar) CompileTableComment(blueprint driver.Blueprint, command *driver.Command) string

+ func (r *Grammar) CompileTables(_ string) string

+ func (r *Grammar) CompileTypes() string

+ func (r *Grammar) CompileUnique(blueprint driver.Blueprint, command *driver.Command) string

+ func (r *Grammar) CompileVersion() string

+ func (r *Grammar) CompileViews(database string) string

+ func (r *Grammar) EscapeNames(names []string) []string

+ func (r *Grammar) GetAttributeCommands() []string

+ func (r *Grammar) ModifyDefault(_ driver.Blueprint, column driver.ColumnDefinition) string

+ func (r *Grammar) ModifyGeneratedAs(_ driver.Blueprint, column driver.ColumnDefinition) string

+ func (r *Grammar) ModifyGeneratedAsForChange(_ driver.Blueprint, column driver.ColumnDefinition) string

+ func (r *Grammar) ModifyIncrement(blueprint driver.Blueprint, column driver.ColumnDefinition) string

+ func (r *Grammar) ModifyNullable(_ driver.Blueprint, column driver.ColumnDefinition) string

+ func (r *Grammar) TypeBigInteger(column driver.ColumnDefinition) string

+ func (r *Grammar) TypeBoolean(column driver.ColumnDefinition) string

+ func (r *Grammar) TypeChar(column driver.ColumnDefinition) string

+ func (r *Grammar) TypeDate(column driver.ColumnDefinition) string

+ func (r *Grammar) TypeDateTime(column driver.ColumnDefinition) string

+ func (r *Grammar) TypeDateTimeTz(column driver.ColumnDefinition) string

+ func (r *Grammar) TypeDecimal(column driver.ColumnDefinition) string

+ func (r *Grammar) TypeDouble(column driver.ColumnDefinition) string

+ func (r *Grammar) TypeEnum(column driver.ColumnDefinition) string

+ func (r *Grammar) TypeFloat(column driver.ColumnDefinition) string

+ func (r *Grammar) TypeInteger(column driver.ColumnDefinition) string

+ func (r *Grammar) TypeJson(column driver.ColumnDefinition) string

+ func (r *Grammar) TypeJsonb(column driver.ColumnDefinition) string

+ func (r *Grammar) TypeLongText(column driver.ColumnDefinition) string

+ func (r *Grammar) TypeMediumInteger(column driver.ColumnDefinition) string

+ func (r *Grammar) TypeMediumText(column driver.ColumnDefinition) string

+ func (r *Grammar) TypeSmallInteger(column driver.ColumnDefinition) string

+ func (r *Grammar) TypeString(column driver.ColumnDefinition) string

+ func (r *Grammar) TypeText(column driver.ColumnDefinition) string

+ func (r *Grammar) TypeTime(column driver.ColumnDefinition) string

+ func (r *Grammar) TypeTimeTz(column driver.ColumnDefinition) string

+ func (r *Grammar) TypeTimestamp(column driver.ColumnDefinition) string

+ func (r *Grammar) TypeTimestampTz(column driver.ColumnDefinition) string

+ func (r *Grammar) TypeTinyInteger(column driver.ColumnDefinition) string

+ func (r *Grammar) TypeTinyText(column driver.ColumnDefinition) string

+ func (r *Grammar) TypeUuid(column driver.ColumnDefinition) string

type Postgres

+ func (r *Postgres) Grammar() driver.Grammar

+ func (r *Postgres) Pool() database.Pool

+ func (r *Postgres) Processor() driver.Processor

+ type Processor struct

+ func NewProcessor() *Processor

+ func (r Processor) ProcessColumns(dbColumns []driver.DBColumn) []driver.Column

+ func (r Processor) ProcessForeignKeys(dbForeignKeys []driver.DBForeignKey) []driver.ForeignKey

+ func (r Processor) ProcessIndexes(dbIndexes []driver.DBIndex) []driver.Index

+ func (r Processor) ProcessTypes(types []driver.Type) []driver.Type

type ServiceProvider

+ func (r *ServiceProvider) Relationship() binding.Relationship

v0

v0.0.1

Jan 9, 2025

Changes in this version

+ const Binding

+ const DriverName

+ var App foundation.Application

+ var OrmDatabaseConfigNotFound = errors.New("orm database config not found")

+ type ConfigBuilder struct

+ func NewConfigBuilder(config contractsconfig.Config, connection string) *ConfigBuilder

+ func (c *ConfigBuilder) Config() contractsconfig.Config

+ func (c *ConfigBuilder) Connection() string

+ func (c *ConfigBuilder) Reads() []contracts.FullConfig

+ func (c *ConfigBuilder) Writes() []contracts.FullConfig

+ type Docker struct

+ func NewDocker(database, username, password string) *Docker

+ func (r *Docker) Build() error

+ func (r *Docker) Config() testing.DatabaseConfig

+ func (r *Docker) Database(name string) (testing.DatabaseDriver, error)

+ func (r *Docker) Driver() database.Driver

+ func (r *Docker) Fresh() error

+ func (r *Docker) Image(image testing.Image)

+ func (r *Docker) Ready() error

+ func (r *Docker) Shutdown() error

+ type Postgres struct

+ func NewPostgres(configBuilder *ConfigBuilder, log log.Log) *Postgres

+ func (r *Postgres) Config() database.Config1

+ func (r *Postgres) Docker() (testing.DatabaseDriver, error)

+ func (r *Postgres) Gorm() (*gorm.DB, error)

+ type ServiceProvider struct

+ func (receiver *ServiceProvider) Boot(app foundation.Application)

+ func (receiver *ServiceProvider) Register(app foundation.Application)