21.54. Class UserDataModelMapping

Namespace: ArmoniK.Core.Adapters.MongoDB.Table.DataModel.Auth
Assembly: ArmoniK.Core.Adapters.MongoDB.dll

MongoDB mapping of the User document

public class UserDataModelMapping : IMongoDataModelMapping<UserData>

21.54.1. Inheritance

objectUserDataModelMapping

21.54.2. Implements

IMongoDataModelMapping<UserData>

21.54.3. Inherited Members

object.Equals(object?), object.Equals(object?, object?), object.GetHashCode(), object.GetType(), object.MemberwiseClone(), object.ReferenceEquals(object?, object?), object.ToString()

21.54.4. Properties

21.54.4.1. CollectionName

Gets the name of the MongoDB collection associated with the data model.

public string CollectionName { get; }

21.54.4.1.1. Property Value

string

21.54.5. Methods

21.54.5.1. InitializeCollectionAsync(IClientSessionHandle, IMongoCollection<UserData>, InitDatabase)

Insert data into the collection after its creation. Can be called multiple times

public Task InitializeCollectionAsync(IClientSessionHandle sessionHandle, IMongoCollection<UserData> collection, InitDatabase initDatabase)

21.54.5.1.1. Parameters

sessionHandle IClientSessionHandle

MongoDB Client session

collection IMongoCollection<UserData>

MongoDDB Collection in which to insert data

initDatabase InitDatabase

Data to insert

21.54.5.1.2. Returns

Task

Task representing the asynchronous execution of the method

21.54.5.2. InitializeIndexesAsync(IClientSessionHandle, IMongoCollection<UserData>, MongoDB)

Setup indexes for the collection Can be called multiple times

public Task InitializeIndexesAsync(IClientSessionHandle sessionHandle, IMongoCollection<UserData> collection, MongoDB options)

21.54.5.2.1. Parameters

sessionHandle IClientSessionHandle

MongoDB Client session

collection IMongoCollection<UserData>

MongoDDB Collection in which to insert data

options MongoDB

Options for MongoDB

21.54.5.2.2. Returns

Task

Task representing the asynchronous execution of the method

21.54.5.3. ShardCollectionAsync(IClientSessionHandle, MongoDB)

Setup sharding for the collection Can be called multiple times

public Task ShardCollectionAsync(IClientSessionHandle sessionHandle, MongoDB options)

21.54.5.3.1. Parameters

sessionHandle IClientSessionHandle

MongoDB Client session

options MongoDB

Options for MongoDB

21.54.5.3.2. Returns

Task

Task representing the asynchronous execution of the method