XData

XData is .Net domain object oriented data access layer component. It is not "yet another ORM", but a complete feature rich data access layer for Your solutions. Basic idea to create this component was a suppling high quality tool to professional developers, having deep competences in data storage modeling and access.

version 1.2.0

NuGet packages

XData Data Access Layer package

XData WorkSet (UnitOfWork) package - required to use XData WorkSet (UnitOfWork) implementation

XData Security package - ISecuritySession interface implementation helper required to use XData security functionality

XData Three-tier client proxy package - client proxy to use in three-tier environment (Net 4.0 only, required full Net 4.0 Framework version)

XData Cache package - time limited object caching (Net 4.0 only, required full Net 4.0 Framework version)

XData MsSqlSever adapter package - Ms SQL Server database dialect and adapter

XData Oracle adapter package - Oracle database dialect and adapter based on Oracle ODP provider

XData PostgreSql adapter package - PostgreSQL database dialect and adapter based on NpgSql provider

XData SQLite adapter package - SQLite database dialect and adapter (Net 4.0 version has used System.Data.SQLite provider, Net Standard 2.0 version has used Microsoft.Data.Sqlite provider)

XData MySql adapter package - MySQL database dialect and adapter based on MySql.Data provider

XData net 4.0 System.Diagnostics.Trace log writer package - (Net 4.0 only) Log writer over System.Diagnostics.Trace

XData net 4.0 log4net log writer package - (Net 4.0 only) Log writer over Log4Net

XData net 4.0 Inversion of Control container package - Support for registering logic modules using the IoC container (Net 4.0 version only, required full Net 4.5 Framework version). Any IoC container with IDependencyResolver interface implementation is supported. Net Standard 2.0 version does not require additional packages since .Net Standard has built-in support for IoC containers

XData net standard 2.0 Asynchronous Disposable support package - Support for IAsyncDisposable interface for disposable objects (Net Standard 2.0 version only, required Net Standard 2.1 specification version support)

XData net standard 2.0 Asp.Net Core HealthChecks support package - Support for Asp.Net Core HealthChecks (Net Standard 2.0 version only, required Net Standard 2.1 specification version support)

Basic features

Single domain object can be mapped on multiple tables (or views, or procedures) in DB. Every DB object can be mapped multiple times in one (or more mappings).
IQueryable interface is fully supported.
Surrogate primary and foreign keys can be used in automatically or manual mode.
Lazy large object (LOB, XML) binding.
Mapping on UDT (user data types) SQL procedure parameters (limited by chosen ADO .Net provider's capabilities).
Enumeration types mapping support (including bit mask).
Master-slave data mapped entities relation is supported.
Hierarchy organized data mapping.
Optional mapping SQL parts.
Dynamic (LINQ-style, fluent) or static (based on attributes) mapping can be used.
Using statically mapped subqueries in dynamic mapping expression.
Using mapping variables can change query structure dynamically.
Programmer can use (or not use) dictionary data cache using its own decision.
Using SQL procedures and functions as base of mapping.
Same programming modules can be used in two-tier mode (e.g. for debugging) and three-tier mode (in production) based on configuration file settings.
Declarative Unit of Work realization.
Might and flexible data access control rules can be used.
Convenient and powerful built-in JSON serialization system does not require conversion from-to-DTO.
Parts of the mapping description can be inherited using the standard inheritance hierarchy or with the construction of an independent hierarchy of mapping inheritance.

Installation

NuGet configuration

To get XData NuGet packages You will need modify nuget.config as described below and place it in project root folder near Your solution file.

<?xml version="1.0" encoding="utf-8"?>
<configuration>
    <packageSources>
        <clear />
        <add key="xdata" value="https://nuget.pkg.github.com/mickfierte/index.json" />
		<add key="nuget.org" value="https://api.nuget.org/v3/index.json" />
    </packageSources>
	<packageSourceCredentials>
        <xdata>
            <add key="Username" value="API_KEY" />
            <add key="ClearTextPassword" value="API_KEY" />
        </xdata>
    </packageSourceCredentials>
</configuration>

* replace API_KEY with API key provided by author

Net 4.0

Install Nuget package of XData engine package.

Install one of logger Nuget packages for System.Diagnostics.Trace or log4net

Install XData database adapter Nuget package (see above) for Your database (or multiple databases).

Configuration is described here

(Optional) Net 4.0 three-tier architecture client libraries

Additionally required to install XData three tier client package

Configuration is described here

(Optional) Net 4.0 three-tier architecture server

Download and deploy XData three-tier service on any You like WCF host.

Copy data mapping and data logic assemblies to service catalog.

Service configuration is described here

NetStandard 2.0

Install Nuget package of XData engine package.

Install XData database adapter Nuget package (see above) for Your database (or multiple databases).

Configuration is described here

Usage example

Net 4.0:

using (var dataEngine = XDataManager.InitXData(x => 
	x.UseConfiguration(ConfigurationManager
		.OpenExeConfiguration(ConfigurationUserLevel.None))))
{
    using (var dataScope = dataEngine.NewDataScope())
    {
        foreach(var data in dataScope.GetRepository<SomeObject>())
            Console.WriteLine(string.Format("{0}, {1}", data.SomeId, data.Name));
    }                     
}

NetStandard 2.0:

//Set configuration file
var builder = new ConfigurationBuilder();
builder.AddXmlFile("MyConsoleApp.config");
var configFile = builder.Build();

//Set services
using(var serviceProvider = new ServiceCollection()
    .AddLogging()
    // Localization only for ASP.NET Core
    .AddSingleton(typeof(IStringLocalizerFactory), x => null)
    .AddSingleton(typeof(IConfigurationRoot), x => configFile)
    .AddXData()
    .BuildServiceProvider())
{
	//Configure logging
	services.AddLogging(x => x.ClearProviders()
		.AddConfiguration(Configuration.GetSection("Logging"))
		.AddDebug().AddConsole());

	var dataEngine = serviceProvider.GetRequiredService<IDataEngine>();
	
	using (var dataScope = dataEngine.NewDataScope())
	{
		foreach(var data in dataScope.GetRepository<SomeObject>())
			Console.WriteLine($"{data.SomeId}, {data.Name}");
	}
}

static mapping:

[DataObject("T"),
DataTable("T_SOME", "T"),
Column("SomeId", typeof(long?), "T", Flags = DataPropertyFlag.Id),
ColumnDefault(string.Empty, DefaultType.AutoIncrement)]
public class SomeObject : IDataObject
{
    [Property("T")]
    public string Name { get; set; }
}

dynamic mapping:

public partial class SomeObject
{
    public string Name { get; set; }
}

public partial class SomeObject : IDataObject
{
    private static Expression<CustomMapping<SomeObject>> _mapping = () =>
        XDataMapping.GetStructure<SomeObject>("T")
            .DataTable("T_SOME", "T")
            .Column("SomeId", x => x.Field<int?>("T", string.Empty, z => z.Key()))
            .Map(x => Name = x.Field<string>("T", string.Empty))
            .SetBaseTable("T");
}

For more examples and usage, please refer to the documentation.

Release History

1.0.0
- Initially published (deprecated now)
1.1.0
- .Net Standard 2.0 version released
- MySql is now supported
- XML data sources is now supported in dynamic queries
- Local temporary tables is now supported in dynamic queries
- JSON serialization without DTO
- Lot of bugs are fixed
- Documentation is available now
1.2.0
- SQL Blocks is now supported
- IAsyncDisposable is now supported
- Asp.Net Core HealthChecks is now supported
- Using DI containers for trigger logic modules
- Using hierarchical organized objects
- Mapping inheritance
- Bugs are fixed, algorithms are improved

Contacts

Denis Dawydenko – d.dawydenko@gmail.com

Distributed under the MIT license. See LICENSE for more information.

mickfierte / XData