Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/managedcode/database

Unified interface for working with a variety of different document-oriented NoSQL databases.
https://github.com/managedcode/database

azure cosmosdb litedb mongodb mssql postgresql repository sqlite tables

Last synced: 4 days ago
JSON representation

Unified interface for working with a variety of different document-oriented NoSQL databases.

Awesome Lists containing this project

README

        

![img|300x200](https://raw.githubusercontent.com/managed-code-hub/Database/main/logo.png)
# Database
[![.NET](https://github.com/managed-code-hub/Database/actions/workflows/dotnet.yml/badge.svg)](https://github.com/managed-code-hub/Database/actions/workflows/dotnet.yml)
[![Coverage Status](https://coveralls.io/repos/github/managed-code-hub/Database/badge.svg?branch=main)](https://coveralls.io/github/managed-code-hub/Database?branch=main)
[![nuget](https://github.com/managed-code-hub/Database/actions/workflows/nuget.yml/badge.svg?branch=main)](https://github.com/managed-code-hub/Database/actions/workflows/nuget.yml)
[![CodeQL](https://github.com/managed-code-hub/Database/actions/workflows/codeql-analysis.yml/badge.svg?branch=main)](https://github.com/managed-code-hub/Database/actions/workflows/codeql-analysis.yml)

| Version | Package | Description |
| ------- | ------- | ----------- |
|[![NuGet Package](https://img.shields.io/nuget/v/ManagedCode.Database.Core.svg)](https://www.nuget.org/packages/ManagedCode.Database.Core) | [ManagedCode.Database.Core](https://www.nuget.org/packages/ManagedCode.Database.Core) | Core |
|[![NuGet Package](https://img.shields.io/nuget/v/ManagedCode.Database.AzureTables.svg)](https://www.nuget.org/packages/ManagedCode.Database.AzureTables) | [ManagedCode.Database.AzureTables](https://www.nuget.org/packages/ManagedCode.Database.AzureTable) | AzureTable |
|[![NuGet Package](https://img.shields.io/nuget/v/ManagedCode.Database.Cosmos.svg)](https://www.nuget.org/packages/ManagedCode.Database.Cosmos) | [ManagedCode.Database.Cosmos](https://www.nuget.org/packages/ManagedCode.Database.Cosmos) | Cosmos DB |
|[![NuGet Package](https://img.shields.io/nuget/v/ManagedCode.Database.LiteDB.svg)](https://www.nuget.org/packages/ManagedCode.Database.LiteDB) | [ManagedCode.Database.LiteDB](https://www.nuget.org/packages/ManagedCode.Database.LiteDB) | LiteDB |
|[![NuGet Package](https://img.shields.io/nuget/v/ManagedCode.Database.MongoDB.svg)](https://www.nuget.org/packages/ManagedCode.Database.MongoDB) | [ManagedCode.Database.MongoDB](https://www.nuget.org/packages/ManagedCode.Database.MongoDB) | MongoDB |
|[![NuGet Package](https://img.shields.io/nuget/v/ManagedCode.Database.SQLite.svg)](https://www.nuget.org/packages/ManagedCode.Database.SQLite) | [ManagedCode.Database.SQLite](https://www.nuget.org/packages/ManagedCode.Database.SQLite) | SQLite |
---

## Introduction
This library provides a unified interface for working with a variety of different document-oriented NoSQL databases.
With this library, you can easily switch between different databases without having to change your code,
making it easy to experiment with different options and find the best solution for your needs.

## Motivation
Document-oriented NoSQL databases are a popular choice for many applications because of their flexibility and ease of use.
However, each database has its own unique syntax and features, making it difficult to switch between them.
This library aims to solve this problem by providing a consistent interface for working with multiple document-oriented NoSQL databases.

## Features
- Provides a single, unified interface for working with multiple document-oriented NoSQL databases.
- Allows you to easily switch between different databases without having to change your code.
- Makes it easy to experiment with different options and find the best solution for your needs.

## Usage

To use the library, simply import it and initialize a client for the database you want to use.

## Contributing

We welcome contributions to this project. If you have an idea for a new feature or improvement, please open an issue to discuss it.
If you want to submit a pull request, please make sure to follow the contribution guidelines and include tests for your changes.

---
# OUTDATED--
## Repository pattern implementation for C#.
A universal repository for working with multiple databases:
- InMemory
- Azure Tables
- CosmosDB
- LiteDB
- SQLite
- MSSQL
- PostgreSQL

## General concept

We don't think you can hide the real database completely behind abstractions, so I recommend using your interfaces that will lend IReposity of the right type.
And do the same with the direct implementation.

```cs
// declare the model as a descendant of the base type.
public class SomeModel : IItem
{

}
```

```cs
// then create an interface
public interface ISomeRepository : IRepository where TItem : IItem
{
}
```

```cs
// create a class inherited from a repository of the desired type
public class SomeRepository : BaseRepository where TItem : class, IItem, new()
{
}
```

And then add your interface and dependency configuration class.
``` cs
services
.AddTransient()
```
This is to define the id type, and the object itself.

---
## Azure Table
```cs
// declare the model as a descendant of the base type.
public class SomeModel : AzureTableItem
{

}

// then create an interface
public interface ISomeRepository : IAzureTableRepository
{
}

// create a class inherited from a repository of the desired type
public class SomeRepository : AzureTableRepository, ISomeRepository
{
public SomeRepository(ILogger logger, IConfiguration config) : base(logger,
new AzureTableRepositoryOptions
{
ConnectionString = "connectionString"
})
{
}
}
```
---
## CosmosDB
```cs
// declare the model as a descendant of the base type.
public class SomeModel : CosmosDbItem
{

}

// then create an interface
public interface ISomeRepository : ICosmosDbRepository
{
}

// create a class inherited from a repository of the desired type
public class SomeRepository : CosmosDbRepository, ISomeRepository
{
public SomeRepository(ILogger logger, IConfiguration config) : base(logger,
new CosmosDbRepositoryOptions
{
ConnectionString = "connectionString"
})
{
}
}
```
---
## LiteDB
```cs
// declare the model as a descendant of the base type.
public class SomeModel : LiteDbItem
{

}

// then create an interface
public interface ISomeRepository : ILiteDbRepository
{
}

// create a class inherited from a repository of the desired type
public class SomeRepository : LiteDbRepository, ISomeRepository
{
public SomeRepository(ILogger logger, IConfiguration config) : base(logger,
new LiteDbRepositoryOptions
{
ConnectionString = "connectionString"
})
{
}
}
```
---
## MongoDB
```cs
// declare the model as a descendant of the base type.
public class SomeModel : MongoDbItem
{

}

// then create an interface
public interface ISomeRepository : IMongoDbRepository
{
}

// create a class inherited from a repository of the desired type
public class SomeRepository : MongoDbRepository, ISomeRepository
{
public SomeRepository(ILogger logger, IConfiguration config) : base(logger,
new LiteDbRepositoryOptions
{
ConnectionString = "connectionString"
})
{
}
}
```
---
## SQLite
```cs
// declare the model as a descendant of the base type.
public class SomeModel : SQLiteItem
{

}

// then create an interface
public interface ISomeRepository : ISQLiteRepository
{
}

// create a class inherited from a repository of the desired type
public class SomeRepository : SQLiteRepository, ISomeRepository
{
public SomeRepository(ILogger logger, IConfiguration config) : base(logger,
new SQLiteRepositoryOptions
{
ConnectionString = "connectionString"
})
{
}
}
```