UltimateCoder/AspNetCore.Identity.MongoDbCore
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 1 Wiki Activity

Merge pull request #7 from joshuadavidson/patch-1

Browse Source 
Add collection naming & ObjectId documentation
This commit is contained in:
Alexandre SPIESER
2018-09-27 22:17:58 +01:00
committed by GitHub
parent 1ec9d1123e 7c36f72016
commit f95988269c
1 changed files with 17 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+17 -3
View File
@@ -11,8 +11,7 @@ Available as a Nuget package : https://www.nuget.org/packages/AspNetCore.Identit
Install-Package AspNetCore.Identity.MongoDbCore Install-Package AspNetCore.Identity.MongoDbCore
# Usage examples # User and Role Entities
Your user and role entities must inherit from `MongoIdentityUser<TKey>` and `MongoIdentityRole<TKey>` in a way similar to the `IdentityUser<TKey>` and the `IdentityRole<TKey>` in `Microsoft.AspNetCore.Identity`, where `TKey` is the type of the primary key of your document. Your user and role entities must inherit from `MongoIdentityUser<TKey>` and `MongoIdentityRole<TKey>` in a way similar to the `IdentityUser<TKey>` and the `IdentityRole<TKey>` in `Microsoft.AspNetCore.Identity`, where `TKey` is the type of the primary key of your document.
Here is an example: Here is an example:
@@ -41,8 +40,23 @@ public class ApplicationRole : MongoIdentityRole<Guid>
} }
} }
``` ```
The `Id` field is automatically set at instantiation, this also applies to users inheriting from `MongoIdentityUser<int>`, where a random integer is assigned to the `Id`. It is however not advised to rely on such random mechanism to set the primary key of your document. Using documents inheriting from `MongoIdentityRole` and `MongoIdentityUser`, which both use the `Guid` type for primary keys, is recommended. #### Id Fields
The `Id` field is automatically set at instantiation, this also applies to users inheriting from `MongoIdentityUser<int>`, where a random integer is assigned to the `Id`. It is however not advised to rely on such random mechanism to set the primary key of your document. Using documents inheriting from `MongoIdentityRole` and `MongoIdentityUser`, which both use the `Guid` type for primary keys, is recommended. MongoDB ObjectIds can optionally be used in lieu of GUIDs by passing a key type of `MongoDB.Bson.ObjectId`, e.g. `public class ApplicationUser : MongoIdentityUser<ObjectId>`.
#### Collection Names
MongoDB collection names are set to the plural camel case version of the entity class name, e.g. `ApplicationUser` becomes `applicationUsers`. To override this behavior apply the `CollectionName` attribute to MongoDbGenericRepository:
```csharp
using MongoDbGenericRepository.Attributes;
namespace App.Entities
{
// Name this collection Users
[CollectionName("Users")]
public class ApplicationUser : MongoIdentityUser<Guid>
{
...
```
# Configuration
To add the stores, you can use the `IdentityBuilder` extension like so: To add the stores, you can use the `IdentityBuilder` extension like so:
```csharp ```csharp