Wagontrain is a schema migration management tool for Datomic, providing version control and reproducible data structure changes.
To use the latest release, add the following to your deps.edn (Clojure CLI)
com.lambdaisland/wagontrain {:mvn/version "0.6.15"}
or add the following to your project.clj (Leiningen)
[com.lambdaisland/wagontrain "0.6.15"]
Consider if we have a init-conn function:
(def domain-schema
"We can use inflate-schema, so domain-schema can be written in a more condensed way."
[
[:user/uuid :uuid "Unique user identifier"]
[:user/contacts :ref "people you connected to"]
...
])
(def migrations
[{:label :add-initial-schedule
:tx-data #(data/load-schedule "compass/schedule.edn")}
{:label :add-live-set
:tx-data [{:session.type/name "Live Set"
:session.type/color "var(--workshop-color)"
:db/ident :session.type/live-set}]}])
(defn init-conn [{:keys [url]}]
(d/create-database url)
(let [conn (d/connect url)
txes (concat (wagontrain/inflate-schema domain-schema) wagontrain/schema)]
@(transact conn txes)
(wagontrain/migrate! conn migrations)
conn))
Check if a schema is applied?
(wagontrain/applied? (conn) :add-locations)
If we want to rollback certain schema
(wagontrain/rollback! (conn) :add-updated-schedule)
Thank you! wagontrain is made possible thanks to our generous backers. Become a backer on OpenCollective so that we can continue to make wagontrain better.
wagontrain is part of a growing collection of quality Clojure libraries created and maintained by the fine folks at Gaiwan.
Pay it forward by becoming a backer on our OpenCollective, so that we continue to enjoy a thriving Clojure ecosystem.
You can find an overview of all our different projects at lambdaisland/open-source.
We warmly welcome patches to wagontrain. Please keep in mind the following:
- adhere to the LambdaIsland Clojure Style Guide
- write patches that solve a problem
- start by stating the problem, then supply a minimal solution
* - by contributing you agree to license your contributions as MPL 2.0
- don't break the contract with downstream consumers
** - don't break the tests
We would very much appreciate it if you also
- update the CHANGELOG and README
- add tests for new functionality
We recommend opening an issue first, before opening a pull request. That way we can make sure we agree what the problem is, and discuss how best to solve it. This is especially true if you add new dependencies, or significantly increase the API surface. In cases like these we need to decide if these changes are in line with the project's goals.
* This goes for features too, a feature needs to solve a problem. State the problem it solves first, only then move on to solving it.
** Projects that have a version that starts with 0. may still see breaking changes, although we also consider the level of community adoption. The more widespread a project is, the less likely we're willing to introduce breakage. See LambdaIsland-flavored Versioning for more info.
Copyright © 2022-2025 Arne Brasseur and Contributors
Licensed under the term of the Mozilla Public License 2.0, see LICENSE.