Infotekka.LightData 3.1.0

Nuget Package Url

https://www.nuget.org/packages/Infotekka.LightData

Introduction

LightData is a asynchronous lightweight SQL based ORM that is designed to be used with data-first applications. It can quickly connect you to your datasource and provide fully functional models to create, read, update, and delete table data, plus execute stored procedures and retrieve results.

Getting Started

While it is possible to write your own models, there is a suggested convention to most effectively use the LightData tools. There is a built-in Model Builder which will generate code based on your database and create C# classes to match.

1. Set up a simple C# library project (for example My.NameSpace.Project.Data, which your main application will reference. This is to separate the data access from the main application and makes testing easier.
2. Create a complimentary test project for the new library project.
   1. Create a test class called ModelBuilder.
   2. Add a using directive for both Infotekka.LightData and Infotekka.LightData.Schema.
   3. Create a test called BuildModels.
   4. Use the methods in Infotekka.LightData.ModelBuilder to generate code models and write them to the filesystem. For example:

       string connectionString = "[Your Connection String]";
       string nameSpace = "Your.Project.Application.Data"; //This is the namespace that new models will use.
       string literalConnectionStringProperty = "Runtime.ConnectionString"; //This is literal code that will be inserted into the ConnectionString property on new models, it should reference a class and property available to all models.
       string path = "../../../../Your.Project.Application.Data"; //A path on the filesystem where the models will be written. This example is relative to the test.
   
       var tables = SchemaCore.GetTables(connectionString);
   
       foreach (var t in tables) {
           string classname = t.TableName.CapFirstVariableName();
           string fname = $"{path}/{classname}.cs";
           if (System.IO.File.Exists(fname)) { System.IO.File.Delete(fname); }
           Infotekka.CoreData.ModelBuilder.BuildModel(path, t, nameSpace, csStringMap);
       }
   

3. Connect to and use your data. The model builder creates a class for each table, with a subclass that defines the record structure in the table. Access the data by creating an instance of the table class then calling .Load() or .LoadAsnyc() against it. Without paramters .Load() will load the entire table, however you can pass a simple lambda query in the function. For example await myTable.Load(l => l.FirstName == "James");.

Contribute

Still working on this part, find us at https://www.infotekka.com for questions and comments.