Skip to content

Commit 9f44c61

Browse files
committed
Merge remote-tracking branch 'origin/main'
2 parents 491c432 + dd6bb88 commit 9f44c61

File tree

2 files changed

+60
-0
lines changed

2 files changed

+60
-0
lines changed

LICENSE

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2021 Synnotech AG
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

README.md

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
# Synnotech.Migrations
2+
3+
*A lightweight generic migration engine for .NET*
4+
5+
[![License](https://img.shields.io/badge/License-MIT-green.svg?style=for-the-badge)](https://github.com/Synnotech-AG/Synnotech.Migrations/blob/main/LICENSE)
6+
[![NuGet](https://img.shields.io/badge/NuGet-0.6.0-blue.svg?style=for-the-badge)](https://www.nuget.org/packages?q=Synnotech.Migrations)
7+
8+
When starting a new project, do you always spent too much time on how you can migrate your database? Do you want a migration mechanism that is independent of any persistence technology, like ORMs for relational databases? Worry no more because **Synnotech.Migrations** offers just that! Our generic migration engine is written in such a way so that you can easily adapt it to your own data access layer, no matter the technology: relational databases with and without ORMs, document or graph databases, the file system, or web services - the possibilities are endless.
9+
10+
**Synnotech.Migrations** also offers integration packages that get you started quickly:
11+
12+
- [Raven DB](https://github.com/Synnotech-AG/Synnotech.Migrations/tree/main/Code/src/Synnotech.Migrations.RavenDB)
13+
- Linq2Db *to be completed*
14+
- Entity Framework Core *to be completed*
15+
- Entity Framework *to be completed*
16+
17+
Please visit the corresponding pages for further documentation.
18+
19+
## Our Philosophy for Migrations
20+
21+
- **The dev is in control**: Synnotech.Migrations is unobtrusive, it does not care about the internal structure of your migrations. We recommend choosing the best tools to manipulate your target system, e.g. TSQL for MS SQL Server, PL/SQL for Oracle, RQL or the RavenDB.Client for Raven DB, HTTP calls for a web service. Simply execute the code you want within your migrations.
22+
- **We don't look back**: Migrations should not have a `Down` method to reverse it. Not only does this extend the time you need to implement a migration, but it also might lead to data loss, e.g. when a column or table is dropped that was previously added. If one of your migrations is erroneous, write a new one that fixes it.
23+
- **No addtional CLI tools**: Synnotech.Migrations offers you an API that you can directly call within your apps. You don't need additional tools for the command line.
24+
25+
## Supported Frameworks
26+
27+
**Synnotech.Migrations** is build for .NET Standard 2.0, so you can use it on [all platforms that support it](https://docs.microsoft.com/en-us/dotnet/standard/net-standard), e.g. like:
28+
29+
- .NET 5 or newer
30+
- .NET Core 2.0 or newer
31+
- .NET Framework 4.6.1 or newer
32+
- Mono 4.6 or newer
33+
- Unity 2018.1
34+
35+
## Contributions Are Welcome
36+
37+
If you have questions or have an idea for a new feature, please create an issue.
38+
39+
*TODO: we need to create contributing guidelines*

0 commit comments

Comments
 (0)