Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rugal/lein-flyway
https://github.com/rugal/lein-flyway
Last synced: about 6 hours ago
JSON representation
- Host: GitHub
- URL: https://github.com/rugal/lein-flyway
- Owner: Rugal
- License: other
- Created: 2023-10-30T13:10:45.000Z (about 1 year ago)
- Default Branch: master
- Last Pushed: 2024-09-17T04:48:17.000Z (4 months ago)
- Last Synced: 2024-11-28T22:41:45.361Z (about 1 month ago)
- Language: Clojure
- Size: 57.6 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Leiningen Flyway plugin
[](https://clojars.org/al.rug/lein-flyway)
This is an flyway plugin that fits for the latest `flyway-core:10.12.0`.
Why having another flyway plugin given we already have [lein-flyway](https://github.com/metaphor/lein-flyway)? Seems like this plugin is inactive.
Nothing special but get myself familiarize with leiningen [plugin](https://leiningen.org/plugins.html) development, along with playing around flyway-core API.
## Usage
### add plugin
Put `[flyway "1.0.0"]` into the `:plugins` vector of your `:user` profile or `:plugins` vector of your project.clj.
### add flyway configuration
You must prepare your migration file, basically SQL file. Then `edn` format flyway configuration file.
The actual directory structure does not matter. Below is a demonstration for a simple project.
```
src
└── ...
resources
└── database
├── flyway.edn
└── migration
├── V1__Base_Line.sql
└── V999__Sample_Data.sql
```
A sample `flyway.edn` can be found [here](sample/resources/database/flyway.edn). Instead of having the ability to configure flyway in `project.clj`, this plugin is designed to offload it to one single flyway configuration file.
### add plugin configuration
Add flyway plugin configuration in `project.clj`
```clojure
{:flyway {:flyway-configuration-path "resources/database/flyway.edn"}}
```
### Run flyway
```shell
lein help flyway # get all available task
lein flyway [task] # execute task
```
## License
Copyright © 2023 FIXME
This program and the accompanying materials are made available under the
terms of the Eclipse Public License 2.0 which is available at
http://www.eclipse.org/legal/epl-2.0.
This Source Code may also be made available under the following Secondary
Licenses when the conditions for such availability set forth in the Eclipse
Public License, v. 2.0 are satisfied: GNU General Public License as published by
the Free Software Foundation, either version 2 of the License, or (at your
option) any later version, with the GNU Classpath Exception which is available
at https://www.gnu.org/software/classpath/license.html.