mysql

Documentation

Overview

Package mysql provides database schema introspection for MySQL and MariaDB databases.

Index

• type Inspector
  • func New(db *sql.DB) *Inspector
  • func (i *Inspector) ColumnMeta(ctx context.Context, tableName string) ([]model.ColumnMeta, error)
  • func (i *Inspector) Columns(ctx context.Context, tableName string) ([]string, error)
  • func (i *Inspector) Indexes(ctx context.Context, tableName string) ([]model.Index, error)
  • func (i *Inspector) Relations(ctx context.Context, tableName string) ([]string, error)
  • func (i *Inspector) Tables(ctx context.Context) ([]string, error)

Types

type Inspector

type Inspector struct {
	DB *sql.DB
}

Inspector implements schema introspection for MySQL / MariaDB.

func New

func New(db *sql.DB) *Inspector

New returns a new MySQL Inspector.

func (*Inspector) ColumnMeta

func (i *Inspector) ColumnMeta(ctx context.Context, tableName string) ([]model.ColumnMeta, error)

func (*Inspector) Columns

func (i *Inspector) Columns(ctx context.Context, tableName string) ([]string, error)

Columns returns column descriptors for tableName in "name|type|pk" format, where pk is "1" for primary-key columns, "0" otherwise.

func (*Inspector) Indexes

func (i *Inspector) Indexes(ctx context.Context, tableName string) ([]model.Index, error)

func (*Inspector) Relations

func (i *Inspector) Relations(ctx context.Context, tableName string) ([]string, error)

Relations returns foreign-key descriptors for tableName in "fromCol -> targetTable.targetCol" format.

func (*Inspector) Tables

func (i *Inspector) Tables(ctx context.Context) ([]string, error)

Tables returns all user-defined table names in the current database.