gostgrator

May 3, 2025

Changes in this version

type Config

+ Conn string

May 3, 2025

Changes in this version

+ var DefaultConfig = Config

+ var Version = "1.0.4"

+ func CreateMigration(cfg Config, description string, mode string) error

+ type Client interface

+ EnsureTable func(ctx context.Context) error

+ ExecContext func(ctx context.Context, script string) (sql.Result, error)

+ GetDatabaseVersionSql func() string

+ GetMd5Sql func(m Migration) string

+ HasVersionTable func(ctx context.Context) (bool, error)

+ PersistActionSql func(m Migration) string

+ QueryContext func(ctx context.Context, query string) (*sql.Rows, error)

+ func NewClient(cfg Config, db *sql.DB) (Client, error)

+ func NewPostgresClient(cfg Config, db *sql.DB) Client

+ func NewSqlite3Client(cfg Config, db *sql.DB) Client

+ type Config struct

+ Driver string

+ MigrationPattern string

+ Newline string

+ SchemaTable string

+ ValidateChecksums bool

+ type Gostgrator struct

+ func NewGostgrator(cfg Config, db *sql.DB) (*Gostgrator, error)

+ func (g *Gostgrator) CreateMigration(description, mode string) error

+ func (g *Gostgrator) Down(ctx context.Context, steps int) ([]Migration, error)

+ func (g *Gostgrator) GetDatabaseVersion(ctx context.Context) (int, error)

+ func (g *Gostgrator) GetMaxVersion() (int, error)

+ func (g *Gostgrator) GetMigrations() ([]Migration, error)

+ func (g *Gostgrator) GetRunnableMigrations(databaseVersion, targetVersion int) ([]Migration, error)

+ func (g *Gostgrator) Migrate(ctx context.Context, target string) ([]Migration, error)

+ func (g *Gostgrator) QueryContext(ctx context.Context, query string) (*sql.Rows, error)

+ func (g *Gostgrator) RunMigrations(ctx context.Context, migrations []Migration) ([]Migration, error)

+ func (g *Gostgrator) ValidateMigrations(ctx context.Context, databaseVersion int) error

+ type Migration struct

+ Action string

+ Filename string

+ Md5 string

+ Name string

+ Version int

+ type PostgresClient struct

+ func (c *PostgresClient) EnsureTable(ctx context.Context) error

+ func (c *PostgresClient) ExecContext(ctx context.Context, script string) (sql.Result, error)

+ func (c *PostgresClient) GetDatabaseVersionSql() string

+ func (c *PostgresClient) GetMd5Sql(m Migration) string

+ func (c *PostgresClient) HasVersionTable(ctx context.Context) (bool, error)

+ func (c *PostgresClient) PersistActionSql(m Migration) string

+ func (c *PostgresClient) QueryContext(ctx context.Context, query string) (*sql.Rows, error)

+ type Sqlite3Client struct

+ func (c *Sqlite3Client) EnsureTable(ctx context.Context) error

+ func (c *Sqlite3Client) ExecContext(ctx context.Context, script string) (sql.Result, error)

+ func (c *Sqlite3Client) GetDatabaseVersionSql() string

+ func (c *Sqlite3Client) GetMd5Sql(m Migration) string

+ func (c *Sqlite3Client) HasVersionTable(ctx context.Context) (bool, error)

+ func (c *Sqlite3Client) PersistActionSql(m Migration) string

+ func (c *Sqlite3Client) QueryContext(ctx context.Context, query string) (*sql.Rows, error)