Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.md file #8

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update README.md file #8

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 25 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,21 +3,22 @@
Liquo is an experimental Liquibase plugin for oxpecker. It's aimed to make the development of Buffalo apps with Liquibase migrations a bit more easy but avoiding the installation of Java tools for the development workflow.
## Installation

Liquo is provided as a library you can pull it with
Liquo is provided as a library you can pull with

```
go get github.com/wawandco/liquo
```

An then in your cmd/ox/main.go use it by appending it to the CLi plugins.
An then in your `cmd/ox/main.go` use it by appending it to the CLI plugins.

```
...
cl.Plugins = append(cl.Plugins, liquo.Plugins()...)
cli.Remove("pop/generate-migration") // make sure pop plugin is not being used
cli.Use(liquo.Plugins()...)
...
```

## Limited Functionallity
## Limited Functionality

Liquo still experimental, it does not provide the same amount of statements, formats or databases that liquibase supports.

Expand All @@ -29,6 +30,26 @@ Liquo ONLY supports:
- rollback

While is possible to add the rest of statements this is where the tool is at the moment.
## Usage
Generate migration file in `./migrations` default directory:
- `ox generate migration create-users-table`

Generate migration file in `./my/directory` directory:
- `ox generate migration ./my/directory/create-users-table`

Run migrations:
- `ox db migrate`

Run one single migration:
- `ox db migrate up`

Rollback one single migration:
- `ox db migrate down`

Usage notes:
1. Generating a migration file auto-adds the import path in the `changelog.xml` file.
2. If no `--conn` flag is provided, liquo assumes `development` as its standard DB connection.

## License

Liquo is released under the [MIT License](LICENSE).