https://github.com/aiursoftweb/dbtools

Mirror of https://gitlab.aiursoft.cn/aiursoft/DbTools
https://github.com/aiursoftweb/dbtools

Last synced: 5 days ago
JSON representation

Mirror of https://gitlab.aiursoft.cn/aiursoft/DbTools

• Host: GitHub
• URL: https://github.com/aiursoftweb/dbtools
• Owner: AiursoftWeb
• License: other
• Created: 2023-07-24T11:47:32.000Z (over 1 year ago)
• Default Branch: master
• Last Pushed: 2024-10-16T07:00:40.000Z (28 days ago)
• Last Synced: 2024-10-17T17:56:58.538Z (26 days ago)
• Language: C#
• Homepage:
• Size: 141 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: Readme.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# DBTools

[![MIT licensed](https://img.shields.io/badge/license-MIT-blue.svg)](https://gitlab.aiursoft.cn/aiursoft/DbTools/-/blob/master/LICENSE)

[![Pipeline stat](https://gitlab.aiursoft.cn/aiursoft/DbTools/badges/master/pipeline.svg)](https://gitlab.aiursoft.cn/aiursoft/DbTools/-/pipelines)

[![Test Coverage](https://gitlab.aiursoft.cn/aiursoft/DbTools/badges/master/coverage.svg)](https://gitlab.aiursoft.cn/aiursoft/DbTools/-/pipelines)

[![NuGet version (Aiursoft.CSTools)](https://img.shields.io/nuget/v/Aiursoft.DbTools.svg)](https://www.nuget.org/packages/Aiursoft.DbTools/)

[![ManHours](https://manhours.aiursoft.cn/r/gitlab.aiursoft.cn/aiursoft/dbtools.svg)](https://gitlab.aiursoft.cn/aiursoft/dbtools/-/commits/master?ref_type=heads)

DbTools are Aiursoft's common database tools. It contains a lot of useful database tools for developers.

## Installation

To install `Aiursoft.DbTools` to your project from [nuget.org](https://www.nuget.org/packages/Aiursoft.DbTools/):

```bash

dotnet add package Aiursoft.DbTools

```

## Usage

Easier to register DbContext:

SQLite

```csharp

var services = new ServiceCollection();

services.AddAiurSqliteWithCache("Data Source=app.db");

var built = services.BuildServiceProvider();

var context = built.GetRequiredService();

```

SQL Server

```csharp

var services = new ServiceCollection();

services.AddAiurSqlServerWithCache("Server=(localdb)\\mssqllocaldb;Database=DebugTrusted_Connection=True;MultipleActiveResultSets=true");

var built = services.BuildServiceProvider();

var context = built.GetRequiredService();

```

Easier to update database:

```csharp

var hostBuilder = Host.CreateDefaultBuilder();

hostBuilder.ConfigureServices(services => 

    services.AddAiurSqliteWithCache(@"DataSource=app.db;Cache=Shared")

);

var host = hostBuilder.Build();

// Now update:

await host.UpdateDbAsync(UpdateMode.CreateThenUse);

```

## Switchable database

Supports:

* Sqlite

* MySql

* InMemory

First, install the package:

```bash

dotnet add package Aiursoft.DbTools.Switchable

```

In your `appsettings.json`:

```json

{

  // Database.

  "ConnectionStrings": {

    "AllowCache": "True",

    "DbType": "Sqlite",

    "DefaultConnection": "DataSource=app.db;Cache=Shared"

  },

}

```

In your `startup.cs`:

```csharp

var connectionString = configuration.GetConnectionString("DefaultConnection");

var dbType = configuration.GetSection("ConnectionStrings:DbType").Get();

var allowCache = configuration.GetSection("ConnectionStrings:AllowCache").Get();

services.AddDatabase(connectionString, dbType, allowCache);

```

> Tips

If your database project is different with your web project, you may need the following command to generate migrations:

```bash

cd ./DatabaseProject

dotnet ef migrations add MigrationName --context YourContext --output-dir Migrations --startup-project ../WebProject

dotnet ef database update --context YourContext

```

## How to contribute

There are many ways to contribute to the project: logging bugs, submitting pull requests, reporting issues, and creating suggestions.

Even if you with push rights on the repository, you should create a personal fork and create feature branches there when you need them. This keeps the main repository clean and your workflow cruft out of sight.

We're also interested in your feedback on the future of this project. You can submit a suggestion or feature request through the issue tracker. To make this process more effective, we're asking that these include more information to help define them more clearly.