database

Documentation

Index

• Constants
• func CheckMySQLDump() error
• func CompressionExtension(format string) string
• func ResolveCompressionFormat(outputPath, requested string) (string, error)
• func StartSSHTunnel(ctx context.Context, conn *Connection) (func() error, error)
• type Connection
  • func (c *Connection) Connect() (*sql.DB, error)
  • func (c *Connection) DSN() string
  • func (c *Connection) TestConnection() error
• type DumpOptions
• type DumpResult
• type Dumper
  • func NewDumper(options *DumpOptions) *Dumper
  • func (d *Dumper) Dump() (result *DumpResult, err error)
• type Inspector
  • func NewInspector(db *sql.DB) *Inspector
  • func (i *Inspector) GetAllTablesInfo() ([]TableInfo, error)
  • func (i *Inspector) GetTableInfo(tableName string) (*TableInfo, error)
  • func (i *Inspector) ListTables() ([]string, error)
• type SSHConfig
  • func (c SSHConfig) Enabled() bool
• type TableInfo

Constants

const (
	CompressionAuto = "auto"
	CompressionNone = "none"
	CompressionGzip = "gzip"
	CompressionZstd = "zstd"
)

Compression formats supported by dbdump.

Functions

func CheckMySQLDump

func CheckMySQLDump() error

CheckMySQLDump verifies that mysqldump is available

func CompressionExtension

func CompressionExtension(format string) string

func ResolveCompressionFormat

func ResolveCompressionFormat(outputPath, requested string) (string, error)

func StartSSHTunnel

func StartSSHTunnel(ctx context.Context, conn *Connection) (func() error, error)

StartSSHTunnel starts an SSH local-forward tunnel and mutates the connection to use the forwarded localhost endpoint.

Types

type Connection

type Connection struct {
	Host     string
	Port     int
	User     string
	Password string
	Database string
	SSH      SSHConfig
}

Connection represents a database connection configuration

func (*Connection) Connect

func (c *Connection) Connect() (*sql.DB, error)

Connect establishes a connection to the database

func (*Connection) DSN

func (c *Connection) DSN() string

DSN returns the data source name for MySQL connection Uses mysql.Config for proper escaping and timeout configuration

func (*Connection) TestConnection

func (c *Connection) TestConnection() error

TestConnection tests if the connection is valid

type DumpOptions

type DumpOptions struct {
	Connection    *Connection
	ExcludeTables []string
	OutputFile    string
	DryRun        bool
	Compression   string
}

DumpOptions contains options for dumping the database

type DumpResult

type DumpResult struct {
	OutputFile      string
	Duration        time.Duration
	ExcludedTables  []string
	FileSize        int64
	FileSizeDisplay string
}

DumpResult contains the result of a dump operation

type Dumper

type Dumper struct {
	// contains filtered or unexported fields
}

Dumper handles database dumping operations

func NewDumper

func NewDumper(options *DumpOptions) *Dumper

NewDumper creates a new Dumper

func (*Dumper) Dump

func (d *Dumper) Dump() (result *DumpResult, err error)

Dump performs the database dump

type Inspector

type Inspector struct {
	// contains filtered or unexported fields
}

Inspector handles database inspection operations

func NewInspector

func NewInspector(db *sql.DB) *Inspector

NewInspector creates a new Inspector

func (*Inspector) GetAllTablesInfo

func (i *Inspector) GetAllTablesInfo() ([]TableInfo, error)

GetAllTablesInfo retrieves information for all tables

func (*Inspector) GetTableInfo

func (i *Inspector) GetTableInfo(tableName string) (*TableInfo, error)

GetTableInfo retrieves detailed information about a table

func (*Inspector) ListTables

func (i *Inspector) ListTables() ([]string, error)

ListTables returns a list of all tables in the database

type SSHConfig

type SSHConfig struct {
	Host      string
	Port      int
	User      string
	KeyFile   string
	LocalPort int
}

SSHConfig describes an optional SSH tunnel used to reach the database.

func (SSHConfig) Enabled

func (c SSHConfig) Enabled() bool

Enabled reports whether SSH tunneling should be used.

type TableInfo

type TableInfo struct {
	Name        string
	RowCount    int64
	DataSize    int64
	IndexSize   int64
	TotalSize   int64
	SizeDisplay string
}

TableInfo represents information about a table