https://github.com/weavejester/ragtime

Database-independent migration library
https://github.com/weavejester/ragtime

clojure database jdbc migrations sql

Last synced: 29 days ago
JSON representation

Database-independent migration library

• Host: GitHub
• URL: https://github.com/weavejester/ragtime
• Owner: weavejester
• License: epl-1.0
• Created: 2011-11-19T19:06:18.000Z (almost 13 years ago)
• Default Branch: master
• Last Pushed: 2024-03-01T17:49:50.000Z (9 months ago)
• Last Synced: 2024-04-14T03:58:42.007Z (7 months ago)
• Topics: clojure, database, jdbc, migrations, sql
• Language: Clojure
• Homepage:
• Size: 366 KB
• Stars: 600
• Watchers: 9
• Forks: 87
• Open Issues: 22
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE.html

Awesome Lists containing this project

README

        
# Ragtime

[![Build Status](https://travis-ci.org/weavejester/ragtime.svg?branch=master)](https://travis-ci.org/weavejester/ragtime)

Ragtime is a Clojure library for migrating structured data in a way

that's database independent. It defines a common interface for

expressing migrations, much like [Ring][] defines a common interface

for expressing web applications.

[ring]: https://github.com/ring-clojure/ring

## Installation

Add the following dependency to your deps.edn file:

    dev.weavejester/ragtime {:mvn/version "0.9.4"}

Or to your Leiningen project file:

    [dev.weavejester/ragtime "0.9.4"]

## Overview

Ragtime needs three pieces of data to work:

1. A migratable **data store**

2. An ordered sequence of **migrations**

3. A **strategy** on how to deal with conflicts

A data store is an implementation of the `DataStore` protocol, and

tells Ragtime how to record which migrations are applied to an

arbitrary store of data, such as a database.

Since 0.5.0, migrations are implementations of the `Migration` protocol,

which has three methods:

* `id`        - returns a unique ID for the migration

* `run-up!`   - applies the migration to a database

* `run-down!` - rolls back the migration in a database

Ragtime comes with a way of loading SQL migrations from files, and

applying them to a SQL database.

## Documentation

* [Getting Started](https://github.com/weavejester/ragtime/wiki/Getting-Started)

* [Upgrading from 0.3.x](https://github.com/weavejester/ragtime/wiki/Upgrading-from-0.3.x)

* [Upgrading from 0.4.x](https://github.com/weavejester/ragtime/wiki/Upgrading-from-0.4.x)

* [Concepts](https://github.com/weavejester/ragtime/wiki/Concepts)

* [SQL Migrations](https://github.com/weavejester/ragtime/wiki/SQL-Migrations)

* [Leiningen Integration](https://github.com/weavejester/ragtime/wiki/Leiningen-Integration)

* [API docs](http://weavejester.github.io/ragtime)

* [Third-party Libraries](https://github.com/weavejester/ragtime/wiki/Third-party-Libraries)

## License

Copyright © 2024 James Reeves

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

your option) any later version