doomig's Introduction

doomig

Welcome to doomig. It is a migration tool for database schemas.
This is in response to 2 things

Tired of migration tools costing money for commonly used features
Wanting to dive more into Scala 3

It supports

Postgresql (soon it will support MySql)
migrations up and down based upon files in a directory following a specific naming convention.
- This convention can be user defined but must include some named fields in the regex.
Dry runs that validate the schema using doobie typechecking

It is definitely still in the beginning days so there will be some movement here and there.

Code Wise

It uses Scala3, doobie with a tagless final style that uses cats-effect.

Run application

Add ddl files for up and down to a directory. By default, you should follow this naming convention for the files. You can override this naming convention by defining your own up and down regex. The regex must have the following named groups.

version
desc

req	Argument	Value
Y	0	up or down
Y	--source-folder	Directory to search migration files for
N	--destination-version	Version you want to migrate to
N	--db-table-name	Name of the migration table. Defaults to doomig_version
Y	--db-url	Jdbc url
Y	--db-user	database user name
Y	--db-password	database password
N	--db-driver	database driver; defaults to org.postgresql.Driver
N	--dry-run	Only tells you what would run and checks the ddl
N	--file-regex	Needs to be the regex for the --direction specified (up, down)
Y	--help	Prints out the help

Up to date values are defined in Conf.scala

sbt run app/run

Run Unit tests tests

sbt core/test

doomig's People

Contributors

Watchers

doomig's Issues

Move from fs2 streams for walking the directory tree

We are not really using fs2 streams in a streaming way and the code is a bit awkward because of that. Probably want to go our own way or using something more cats-io level.

More unit testing

And update to architecture based upon that.

May want to create a docker image people can use.

Need a way to run the integration tests

Need to package and deploy the jars

Need to package the jars using sbt-assembly
Need to publish the jars to an artifactory so others can download and use

Create a sbt plugin for the migrator may make sense

Directory walking needs to work on the resources directory

Currently only works on the file system which is fine for some use cases but not for others.

Add descriptions to the command line options

Logging output issues

Currently because the logger is passed in at the top level down into the doobie layer the name used for the logger is com.strad.doomig.app.*. This causes issues when wanting to silence the verbose output of doobie but keep the logging for com.strad.doomig.app Main ...i.e. standard console logging.

There are two possible solutions to this problem

Create a new logger with a name that mirrors the lowerlevel VersionDb class.
Just use println logging for things at the main level that we definitely want to print out.