ServantSoftware.EFCore.Json 1.0.0.281

ServantSoftware.EFCore.Json

ServantSoftware.EFCore.Json is an EF Core provider that allows you to use JSON files as a data source. It's currently in an alpha state, primarily focusing on specific "happy paths" needed for SettingsOnEF and our main product, MockDB. We encourage community contributions to enhance its features and cover a broader range of scenarios.

Features

• Seamless integration with EF Core.
• Allows JSON files to act as data sources for EF Core.
• Optimized for specific scenarios to support the main product.
• Easy setup and configuration.

Getting Started

Prerequisites

• .NET 7.0 or later.
• EF Core compatible version.

Installation

Install the ServantSoftware.EFCore.Json provider using NuGet:

dotnet add package ServantSoftware.EFCore.Json

Usage

After installing the package, you can configure your DbContext to use the JSON provider:

public class MyDbContext : DbContext
{
    protected override void OnConfiguring(DbContextOptionsBuilder optionsBuilder)
    {
        var connectionString = new FileConnectionString() { DataSource = "path/to/your/data.json" };
        optionsBuilder.UseJson(connectionString);
    }
}

This allows you to perform standard EF Core operations on your JSON data source. This provider is based on the JSON ADO.NET Provider. Refer to it for details connection string options.

Contributing

We're open to contributions! Please read contributing guidelines for details on our code of conduct, and the process for submitting pull requests.

Limitations

Being in its alpha state, the ServantSoftware.EFCore.Json provider primarily addresses specific scenarios vital for our product MockDB. Some advanced EF Core features might not be fully supported yet. We are eagerly awaiting community contributions to improve and extend its capabilities.

License

This project is licensed under the MIT License - see the LICENSE.md file for details.

Acknowledgments

• Thanks to the .NET Foundation and EF Core teams for providing an exceptional framework.
• Huge thanks to all who are considering contributing to this nascent project!