https://github.com/adonmo/goroom

An embedded data store version manager
https://github.com/adonmo/goroom

golang gorm migrations room version-control

Last synced: about 1 month ago
JSON representation

An embedded data store version manager

• Host: GitHub
• URL: https://github.com/adonmo/goroom
• Owner: adonmo
• License: mit
• Created: 2020-05-22T08:54:41.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2020-06-30T14:37:49.000Z (over 4 years ago)
• Last Synced: 2024-06-20T03:53:06.655Z (7 months ago)
• Topics: golang, gorm, migrations, room, version-control
• Language: Go
• Homepage:
• Size: 8.82 MB
• Stars: 7
• Watchers: 4
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# goroom

### Blog

* For a primer on Go-Room, refer to the blog on [Basic Usage](https://medium.com/adonmo-tech/go-room-5c1d4f46a77e)

* For a peek into the architecture, refer to the blog on [Internals](https://medium.com/adonmo-tech/go-room-internals-5b3475266fbb?sk=5ee4ae78890bfa73abab3184739efeef)

* For a guide to advanced usage, refer to the blog for [Ninja Users](https://medium.com/adonmo-tech/go-room-ninja-79be873f7cbf?source=friends_link&sk=1124bce19212beceba7d3845608ea904)

### Brief

The primary function of Room is to ease version management and migration of databases that are created by apps on the edge devices and are tightly coupled with the version of app that creates and manages them.

### Features

* Using Room a developer can ensure that as they deliver updates to App and underlying associated Data Store they can

have a smooth transition of Data Store on the edge device without risk of data loss.  

* A typical way to handle upgrades would be to create the data store from scratch again. This is not desirable if the

data stored on the edge device is things like valuable insights/events recorded by the device and pending sync/upload to the

server. Since data collection is a major use case of edge devices I think a version manager like Room is necessary.

### Android Room

Room is inspired by its [namesake](https://developer.android.com/training/data-storage/room) in Android World which does the same thing but at a deeper level by even providing the ORM.

The Room presented here is agnostic to data stores and provides flexibility to the developer on how they [signal](https://github.com/gamble09/groom/blob/master/orm/orm.go#L31) and [handle schema changes](https://github.com/gamble09/groom/blob/master/orm/orm.go#L36).

### Gotchas

* It is purely a utility that serves the minimal purpose of carrying out migrations and verifying that DB is upto the version expected by the app currently.  

* A lot of power is still in the developers hands as they have the freedom to execute any operations on the DB themselves.

* Doing stuff like deleting/updating Room's metadata tables is a big No-No :). Plz...

### Sample

For understanding on how the migration and versioning works check [examples](https://github.com/gamble09/groom/tree/master/example).  

### How to Run Sample

To run the example which also serves as an integration test with GORM go to the examples folder and run

```sh

go test -v ./...

```