Popularity
1.9
Growing
Activity
5.2
Growing
17
2
4

Description

This is a New Era of migrations PostgreSQL databases with Golang.

We no longer want to ensure the database schema with incremental patches. Shema MUST match what the app wants! It doesn't matter what was in the database before that.

It could be empty, it could contain some data in any of its previous versions. It doesn't matter anymore. It is important that we carefully transform it into the target state. We will no longer be guessing about the target state of the database by patchset. This is a thing of the past.

This tool allows you to turn schemas into instructions for the database, including migrations between schemas. Create easy-to-read data models as contracts for agreement between architects, development teams, and team leaders. This tool provides agility to change the huge data-layered models.

Programming language: Go
License: MIT License
Tags: SQL     Database     Relational Databases     Golang     Postgresql     Migration     Schema    

goerd alternatives and similar packages

Based on the "Database" category.
Alternatively, view goerd alternatives based on common mentions on social networks and blogs.

Do you think we are missing an alternative of goerd or a related project?

Add another 'Database' Package

README

goerd

This is a New Era of migrations PostgreSQL databases with Golang.

We no longer want to ensure the database schema with incremental patches. Shema MUST match what the app wants! It doesn't matter what was in the database before that.

It could be empty, it could contain some data in any of its previous versions. It doesn't matter anymore. It is important that we carefully transform it into the target state. We will no longer be guessing about the target state of the database by patchset. This is a thing of the past.

This tool allows you to turn schemas into instructions for the database, including migrations between schemas. Create easy-to-read data models as contracts for agreement between architects, development teams, and team leaders. This tool provides agility to change the huge data-layered models.

[Conceptual view](concept.png)

Install

go install github.com/covrom/goerd/cmd/[email protected]

Features

  • Generate yaml short schema description from database
  • Generate plantuml view of schema
  • Create posgresql migrations as a set of SQL queries that apply changes between two schemas, a schema and a database, or two databases using a schema definition that is stored in a yaml or plantuml file.

Migration of the following objects is currently supported:

  • Tables
  • Columns
  • Indexes
  • Constraints and Foreign Keys
  • Views

This set covers 99% of PostgreSQL usecases in Golang services.

Example of generated plantuml:

[Plantuml view](plantuml-example.png)

Usage

Save database schema to yaml schema or PlantUML:

goerd -from "postgres://username:[email protected]:port/dbName" -to ./schema1.yaml

goerd -from "postgres://username:[email protected]:port/dbName" -to ./schema1.puml

Print SQL queries migration between two schemas, dropping queries is commented out:

goerd -from schema1.yml -to schema2.yaml

goerd -from schema1.yml -to "postgres://username:[email protected]:port/dbName"

With dropping queries:

goerd -drop -from schema1.yml -to schema2.yml

goerd -drop -from schema1.yml -to "postgres://username:[email protected]:port/dbName"

Save PlantUML from schema:

goerd -from schema1.yml -to schema1.puml

goerd -from "postgres://username:[email protected]:port/dbName" -to schema1.puml

Apply schema from yaml to database:

goerd -c apply -from schema1.yml -to "postgres://username:[email protected]:port/dbName"

Apply schema from DB1 to DB2:

goerd -c apply -from "postgres://username:[email protected]:port/DB1" -to "postgres://username:[email protected]:port/DB2"

API

See docs.

testing and examples

docker-compose up and see ./output/schema.yaml