# Blazor.IndexedDB.Framework

**Repository Path**: lanicon/Blazor.IndexedDB.Framework

## Basic Information

- **Project Name**: Blazor.IndexedDB.Framework
- **Description**: A framework for blazor which acts as an interface to IndexedDB
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2021-03-14
- **Last Updated**: 2021-03-14

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# <img src="https://raw.githubusercontent.com/Reshiru/Blazor.IndexedDB.Framework/master/logo.svg?sanitize=true" height="28px"> ARCHIVED: Blazor.IndexedDB.Framework

An easy way to interact with IndexedDB and make it feel like EFCore but async.

# NuGet installation
```powershell
PM> Install-Package Reshiru.Blazor.IndexedDB.Framework
```

## Current features
- Connect and create database
- Add record
- Remove record
- Edit record

## How to use
1. In your startup.cs file add
```CSharp
services.AddSingleton<IIndexedDbFactory, IndexedDbFactory>();
```
IIndexedDbFactory is used to create your database connection and will create the database instance for you.
IndexedDbFactory requires an instance IJSRuntime, should normally already be registered.

2. Create any code first database model you'd like to create and inherit from IndexedDb. (Only properties with the type IndexedSet<> will be used, any other properties are beeing ignored)
```CSharp
public class ExampleDb : IndexedDb
{
  public ExampleDb(IJSRuntime jSRuntime, string name, int version) : base(jSRuntime, name, version) { }
  public IndexedSet<Person> People { get; set; }
}
```
- Your model (eg. person) should contain an Id property or a property marked with the key attribute.
```CSharp
public class Person
{
  [System.ComponentModel.DataAnnotations.Key]
  public long Id { get; set; }
  public string FirstName { get; set; }
  public string LastName { get; set; }
}
```

3. Now you can start using your database.
(Usage in razor via inject: @inject IIndexedDbFactory DbFactory)

### Adding records
```CSharp
using (var db = await this.DbFactory.Create<ExampleDb>())
{
  db.People.Add(new Person()
  {
    FirstName = "First",
    LastName = "Last"
  });
  await db.SaveChanges();
}
```
### Removing records
Note: To remove an element it is faster to use a already created reference. You should be able to also remove an object only by it's id but you have to use the .Remove(object) method (eg. .Remove(new object() { Id = 1 }))
```CSharp
using (var db = await this.DbFactory.Create<ExampleDb>())
{
  var firstPerson = db.People.First();
  db.People.Remove(firstPerson);
  await db.SaveChanges();
}
```
### Modifying records
```CSharp
using (var db = await this.DbFactory.Create<ExampleDb>())
{
  var personWithId1 = db.People.Single(x => x.Id == 1);
  personWithId1.FirstName = "This is 100% a first name";
  await db.SaveChanges();
}
```

## License
Licensed under the [MIT](LICENSE) license.