Help us shape the future of Go! Take the 2026 Go Developer Survey

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
- API
  
  Reference documentation for the pkg.go.dev API
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

introspect

package

Go to main page

Versions in this module

v0

v0.1.0

Aug 23, 2026

Changes in this version

+ const CatalogFormatVersion

+ func Diff(cached, live *Catalog) []string

+ type Catalog struct

+ Composites []*Composite

+ Enums []*Enum

+ FormatVersion int

+ Functions []*Function

+ Schemas []string

+ ServerVersion string

+ Tables []*Table

+ func Introspect(ctx context.Context, db Querier, schemas []string) (*Catalog, error)

+ func (c *Catalog) Composite(schema, name string) *Composite

+ func (c *Catalog) Enum(schema, name string) *Enum

+ func (c *Catalog) EnumByRef(ref string) *Enum

+ func (c *Catalog) Hash() (string, error)

+ func (c *Catalog) Table(schema, name string) *Table

+ type Column struct

+ Comment string

+ EnumRef string

+ Generated bool

+ HasDefault bool

+ IsArray bool

+ Name string

+ NotNull bool

+ PGType string

+ Position int

+ TypeSchema string

+ type Composite struct

+ Fields []*Column

+ Name string

+ Schema string

+ type Constraint struct

+ Columns []string

+ Comment string

+ Name string

+ type Enum struct

+ Comment string

+ Name string

+ Schema string

+ TableBacked bool

+ ValueDescriptions []string

+ Values []string

+ type ForeignKey struct

+ Columns []string

+ Comment string

+ Name string

+ RefColumns []string

+ RefSchema string

+ RefTable string

+ type FuncArg struct

+ Name string

+ PGType string

+ TypeSchema string

+ type Function struct

+ Args []FuncArg

+ Comment string

+ Name string

+ ReturnType string

+ ReturnTypeSchema string

+ ReturnsSet bool

+ Schema string

+ Volatility Volatility

+ type Index struct

+ Columns []string

+ Method string

+ Name string

+ Unique bool

+ type Privileges struct

+ Delete bool

+ Insert bool

+ Select bool

+ Update bool

+ type Querier interface

+ Query func(ctx context.Context, sql string, args ...any) (pgx.Rows, error)

+ QueryRow func(ctx context.Context, sql string, args ...any) pgx.Row

+ type RelKind string

+ const RelMaterializedView

+ const RelTable

+ const RelView

+ type Table struct

+ Columns []*Column

+ Comment string

+ ForeignKeys []*ForeignKey

+ Indexes []*Index

+ Kind RelKind

+ Name string

+ PrimaryKey *Constraint

+ Privileges Privileges

+ RLSEnabled bool

+ Schema string

+ Uniques []*Constraint

+ func (t *Table) Column(name string) *Column

+ func (t *Table) Deletable() bool

+ func (t *Table) IndexedColumns() map[string]bool

+ func (t *Table) Insertable() bool

+ func (t *Table) Updatable() bool

+ type Volatility string

+ const VolatilityImmutable

+ const VolatilityStable

+ const VolatilityVolatile