DbModelFramework 1.5.0

DbModelFramework

Getting started

Environment

Download NuGet-Package

Inject InjectionContainer

As a minimum requirement you have to define a new injection container with at least a DbRequirements class as a part. You can use one of the predifined DbRequirements (DbModelFramework.Sqlite, DbModelFramework.MySql, DbModelFramework.MsSql). The DbRequirements class has to export the type DbModelFramework.DbRequirements.

Your DbRequirements class:

[Export(typeof(DbModelFramework.DbRequirements))]
class DbRequirements : DbModelFramework.Sqlite.DbRequirements
{
	private static readonly string ConnectionString = new SqliteConnectionStringBuilder { DataSource = "database.db" }.ConnectionString;

	public override IDbConnection CreateDbConnection()
	{
		var connection = new SqliteConnection(ConnectionString);
		connection.Open();

		return connection;
	}
}

Injection container creation (System.Composition is required):

var configuration = new ContainerConfiguration();
configuration.WithPart<DbRequirements>();

DbModelFramework.DependencyInjection.InjectionContainer = configuration.CreateContainer();

Use the models

Define a new model class

class MyModel : Model<MyModel>
{
	public string Property1 { get; set; }
	public string Property2 { get; set; }
}

Create a new model instance (insert in db)

var myModel = MyModel.Create();

Get all model data

var myModels = MyModel.Get();

Get all model data which fits in the condition

var myModels = MyModel.Get(model => model.Property1 == "MyValue");

Get model data by primary key

var myModel = MyModel.Get(1); // Get model data with primary key 1

Save changes of a models data (update in db)

myModel.Save();

Delete model data (delete from db)

myModel.Delete();

Reload model data

myModel.Reload();

Advanced

Model-in-Model

class MyReferencedModel : Model<MyReferencedModel>
{
	public string Property { get; set; }
}

class MyReferencingModel : Model<MyReferencingModel>
{
	public MyReferencedModel ReferencedModel { get; set; }
}

Unique values

class MyUniqueValueModel : Model<MyUniqueValueModel>
{
	[Unique]
	public string UniqueProperty { get; set; }
}

Ignore values for db storage

class MyDbIgnoreModel : Model<MyDbIgnoreModel>
{
	[DbIgnore]
	public string NotSavedInDbProperty { get; set; }
	
	public string SavedInDbProperty { get; set; }
}