A better manual for DbUp?
This is my attempt to describe how to use DbUp in a more user friendly manner than the official docs.
My goal is to follow the ideas described by the Divio-team on how to best write documentation.
Guidelines for the documentation
| Tutorials | How-to guides | Reference | Explanation | |
|---|---|---|---|---|
| oriented to | Learning | A goal | Information | Understanding |
| must | Allow the newcomer to get started | Show how to solve a specific problem | Describe the machinery | Explain |
| its form | A lesson | A series of steps | Dry description | Discursive explanation |
| analogy | Teaching a small child how to cook | A recipe in a cookery book | A reference encyclopaedia article | An article on culinary social history |
What is DbUp?
DbUp is a tool for deploying database changes, it started its life supporting only Microsoft SQL Server, but has over time recieved support for other popular alternatives.
The basics of DbUp is fairly simple; supply your database-changes using scripts written in SQL or whatever language your particular database requires, and then DbUp will execute these in the configured order.
These scripts can be provided through a few different means:
- As an embedded source in an assembly
- As an embedded source inside multiple assemblies
- From a defined path
- From the source-code
- Which means you can create dynamically typed scripts based on other inputs using C#
Each option has its pro's and con's, but atleast one of them should provide you with what you need. And you can also mix and match between the various options for the same product if needed.