README
¶
CockroachDB Driver for Journey
Modeled after twrobel3's CockroachDB driver for mattes/migrate.
All db connection params are defined in the URL string, see this to know what's supported.
Migration script names should take the form <int_version>_<title>.up.sql and <int_version>_<title>.down.sql. I recommend using a timestamp (seconds since epoch) for <int_version> values.
By default, each migration script will run within a transaction, but you can opt-out of this by including the comment:
-- disable_ddl_transaction
as the first line in your script. Due to the nature of CockroachDB, disabling transactions may be necessary for scripts that need to alter the schema and insert reference/seed data.
Note that advisory locks are not supported in CockroachDB; therefore a manual lock table (with default name schema_lock) is used. This driver will acquire the lock and release it at the beginning and end of every migration script.
See db-journey/journey for details on using the journey CLI.
Documentation
¶
Index ¶
- Variables
- func FilterCustomQuery(u *nurl.URL) *nurl.URL
- func GenerateAdvisoryLockId(databaseName string) (string, error)
- func PopulateConfig(driver *Driver, instance *sql.DB, config *Config) error
- type Config
- type Driver
- func (driver *Driver) Close() error
- func (driver *Driver) Execute(statement string) error
- func (driver *Driver) FilenameExtension() string
- func (driver *Driver) Initialize(url string) error
- func (driver *Driver) Migrate(f file.File, pipe chan interface{})
- func (driver *Driver) SetDB(db *sql.DB)
- func (driver *Driver) Version() (file.Version, error)
- func (driver *Driver) Versions() (file.Versions, error)
- type Error
Constants ¶
This section is empty.
Variables ¶
var ( ErrNilConfig = fmt.Errorf("no config") ErrNoDatabaseName = fmt.Errorf("no database name") )
var DefaultLockTable = "schema_lock"
var DefaultMigrationsTable = "schema_migrations"
Functions ¶
func FilterCustomQuery ¶
FilterCustomQuery filters all query values starting with `x-`
func GenerateAdvisoryLockId ¶
Types ¶
type Driver ¶
type Driver struct {
// contains filtered or unexported fields
}
func (*Driver) FilenameExtension ¶
FilenameExtension returns "sql".
func (*Driver) Initialize ¶
Initialize opens and verifies the database handle.
type Error ¶
type Error struct {
// Optional: the line number
Line uint
// Query is a query excerpt
Query []byte
// Err is a useful/helping error message for humans
Err string
// OrigErr is the underlying error
OrigErr error
}
Error should be used for errors involving queries ran against the database
Source Files