I started to remember where I had left
trek and felt that it would be a good idea to write design documents. As I started to document the current behavior I realized I could simplify it in the name of a MVP.
I wrote up a README.md for what I thought
trek should do for a 188.8.131.52 release.
Aspirational README. WIP. Does not compile.
trek is a simple database migrator. It has two commands:
create NAME will make a
NAME-VERSION.sql file in the path pointed at by
NAME using the current date time as ISO8601
create will return a exit code of
1 if the file creation fails for any reason.
apply executes the the non-applied migrations in
DIRPATH together in a single
apply returns a JSON list of migrations entries as seen in the example above. The formatting of
trek JSON is not shown.
- If any of the sql files fail the transaction will be aborted and
trekwill return an exit code of
applyreturns a exit code of
- if any
*.sqlfiles cannot be parsed in the
applywill return exit code