https://github.com/duct-framework/migrator.ragtime

Integrant methods for running database migrations using Ragtime
https://github.com/duct-framework/migrator.ragtime

clojure duct integrant migrations ragtime sql

Last synced: about 7 hours ago
JSON representation

Integrant methods for running database migrations using Ragtime

• Host: GitHub
• URL: https://github.com/duct-framework/migrator.ragtime
• Owner: duct-framework
• Created: 2017-03-27T10:46:38.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2024-11-07T21:57:16.000Z (11 days ago)
• Last Synced: 2024-11-07T22:39:07.482Z (11 days ago)
• Topics: clojure, duct, integrant, migrations, ragtime, sql
• Language: Clojure
• Homepage:
• Size: 38.1 KB
• Stars: 5
• Watchers: 3
• Forks: 13
• Open Issues: 3
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Duct migrator.ragtime [![Build Status](https://github.com/duct-framework/migrator.ragtime/actions/workflows/test.yml/badge.svg)](https://github.com/duct-framework/migrator.ragtime/actions/workflows/test.yml)

[Integrant][] methods for running database migrations using

[Ragtime][].

[integrant]: https://github.com/weavejester/integrant

[ragtime]:   https://github.com/weavejester/ragtime

## Installation

Add the following dependency to your deps.edn file:

    org.duct-framework/migrator.ragtime {:mvn/version "0.5.0"}

Or to your Leiningen project file:

    [org.duct-framework/migrator.ragtime "0.5.0"]

## Usage

This library provides the `:duct.migrator/ragtime` Integrant key,

which takes five options:

```edn

{:duct.migrator/ragtime

 {:database         #ig/ref :duct.database/sql

  :logger           #ig/ref :duct/logger

  :strategy         :rebase

  :migrations-file  "migrations.edn"

  :migrations-table "ragtime_migrations"}}

```

### :database

The `:database` key should be a SQL database compatible with the Duct

[database.sql][] library, such as [database.sql.hikaricp][]:

```edn

{:duct.database.sql/hikaricp {:jdbcUrl "jdbc:sqlite:db/foo.sqlite"}}

```

[database.sql]: https://github.com/duct-framework/database.sql

[database.sql.hikaricp]: https://github.com/duct-framework/database.sql.hikaricp

### :logger

The `:logger` key should be a logger compatible with the Duct

[logger][] library, such as [logger.simple][]:

```edn

{:duct.logger/simple {:appenders [{:type :stdout}]}}

```

[logger]: https://github.com/duct-framework/logger

### :strategy

The `:strategy` is either `:apply-new`, `:raise-error` or

`:rebase`. These correspond to the [ragtime strategies][] with the

same names.

[ragtime strategies]: https://weavejester.github.io/ragtime/ragtime.strategy.html

### :migrations-file

A path to an edn file containing a vector of [Ragtime SQL migrations][].

[ragtime sql migrations]: https://github.com/weavejester/ragtime/wiki/SQL-Migrations#edn

### :migrations-table

Finally, the `:migrations-table` optional key corresponds

to the [ragtime sql-database][] option with the same name. It is the

name of the table to store the applied migrations (defaults to

"ragtime_migrations" if not specified).

[ragtime sql-database]: https://weavejester.github.io/ragtime/ragtime.jdbc.html#var-sql-database

## License

Copyright © 2024 James Reeves

Distributed under the Eclipse Public License either version 1.0 or (at

your option) any later version.