We provide a data model generated using linq2DB, allowing us to access our database via linq.
A migration tool based on fluent migrator is used for stable and reversible database migrations.
## Data Model
linq2db generates the code that eventually creates the data model by compiling a design time text template.
The main file for the text compilation is the /DataModel/CsDatabase.tt file. In that file, the database connection information should be provided. Follow the instructions in that file for working with the datamodel.
The data model will be generated on every build process for the project guaranteering an up-to-date state of the data model with respect to migrations. The builer in this case is MSBuild, which does not know relative paths used by linqToDB. That means, if, for instance, some library changes require changes to the text compilation process from the text templates, you need to register the path variables used by linqToDB by unloading and editing the CsDatabase.proj!
### Using the data model in your project
Other than including this project, you need to set the configuration string for linqToDb to establish a connection to your database.
You must call the constructor for the data model object with the server provider name and the connection string.
The connection string has the format: "Data Source={dbDataSource}; Database={dbDatabase}; User Id={dbUserId}; Password={dbPassword};".
The provider name is "SqlServer.2008" for our projects. A list of valid alternative names can be found here: https://linq2db.github.io/api/LinqToDB.ProviderName.html
For an example look at the unit test in CsDatabase.Tests/ModelTest.cs
### Changing the target of the data model
If you want to change the database for which the data model should be created, you need to make a few adjustments:
- The namespace should be adjusted in
- cs-database/DataModel/CsDatabase.tt
- cs-database/DataModelConstructor.ttinclude
- The name of the partial class in cs-database/DataModelConstructor.ttinclude
- The configuration string for the database connection will, by default, be fetched from consul. If needed, change the consul query keys in:
- cs-database/DatabaseConnection.ttinclude
- Migrator/Migrator.cs
- If you are connecting a database other than msserver, you also must swap the
It is recommended to include the cs-database/DataModelConstructor.ttinclude so that the database connection can be established with a programmatically obtained connection string (e.g. using consul) rather than having to include a App.config file to your projects.
- Furhtermore you need to adapt the right _providerName in:
- CsDatabase.Tests/ModelTest.cs
- your projects
## Fluent Migrator
## Database Library
[[_TOC_]]
## 📝 Overview
The Database library for .NET simplifies data access within Coscine by providing a data model generated using Entity Framework Core and a migration tool based on fluent migrator, allowing for stable and reversible database migrations to be performed with ease.
## ⚙️ Configuration
To install this library, you can use the NuGet package manager or you can install it using the .NET CLI.
```powershell
Install-PackageCoscine.Database
```
or using the .NET CLI
```powershell
dotnetaddpackageCoscine.Database
```
## 📖 Usage
For examples on how we use this library, look into the source code of the following open-source [Coscine APIs](https://git.rwth-aachen.de/coscine/backend/apis) found in our public GitLab repository:
-`Project`
-`Resource`
-`User`
... and others.
### Data Model
Entity Framework Core generates data models in the Database-First approach by reading the database schema information and generating C# classes that represent the database tables, columns, and relationships. Developers can then use these data models to interact with the database using object-oriented programming techniques.
The data model will be generated on every build process for the project guaranteeing an up-to-date state of the data model with respect to migrations.
#### Using the data model in your project
Other than including this project, you need to set the configuration string for Entity Framework to establish a connection to your database.
You must call the constructor for the data model object with the server provider name and the connection string. The connection string has the format:
```
Data Source={dbDataSource}; Database={dbDatabase}; User Id={dbUserId}; Password={dbPassword};
```
The provider name is "SqlServer.2008" for our projects.
### Fluent Migrator
The fluent migrator provides a command line tool for handling database migrations.
Currently, it provides an intermediary interface for utilizing the fluentMigrator up migration (down migration is currently not supported by us) as well as its rollback function, using the command line arguments:
```
```powershell
--migrate_up
--roll_back<numberofrollbacksteps>
```
...
...
@@ -46,3 +52,26 @@ YYYYMMDDhhmm
```
FluentMigrator uses this identifier to manage its migration versioning. For an example migration, check out the migrations in the test project for the database.
## 👥 Contributing
As an open source plattform and project, we welcome contributions from our community in any form. You can do so by submitting bug reports or feature requests, or by directly contributing to Coscine's source code. To submit your contribution please follow our [Contributing Guideline](https://git.rwth-aachen.de/coscine/docs/public/wiki/-/blob/master/Contributing%20To%20Coscine.md).
## 📄 License
The current open source repository is licensed under the **MIT License**, which is a permissive license that allows the software to be used, modified, and distributed for both commercial and non-commercial purposes, with limited restrictions (see `LICENSE` file)
> The MIT License allows for free use, modification, and distribution of the software and its associated documentation, subject to certain conditions. The license requires that the copyright notice and permission notice be included in all copies or substantial portions of the software. The software is provided "as is" without any warranties, and the authors or copyright holders cannot be held liable for any damages or other liability arising from its use.
## 🆘 Support
1.**Check the documentation**: Before reaching out for support, check the help pages provided by the team at https://docs.coscine.de/en/. This may have the information you need to solve the issue.
2.**Contact the team**: If the documentation does not help you or if you have a specific question, you can reach out to our support team at `servicedesk@itc.rwth-aachen.de` 📧. Provide a detailed description of the issue you're facing, including any error messages or screenshots if applicable.
3.**Be patient**: Our team will do their best to provide you with the support you need, but keep in mind that they may have a lot of requests to handle. Be patient and wait for their response.
4.**Provide feedback**: If the support provided by our support team helps you solve the issue, let us know! This will help us improve our documentation and support processes for future users.
By following these simple steps, you can get the support you need to use Coscine's services as an external user.
## 📦 Release & Changelog
External users can find the _Releases and Changelog_ inside each project's repository. The repository contains a section for Releases (`Deployments > Releases`), where users can find the latest release changelog and source. Withing the Changelog you can find a list of all the changes made in that particular release and version.
By regularly checking for new releases and changes in the Changelog, you can stay up-to-date with the latest improvements and bug fixes by our team and community!
