Class BatchManager
Represent a batch manager.
Inheritance
Namespace: Paradigm.ORM.Data.Batching
Assembly: Paradigm.ORM.Data.dll
Syntax
public class BatchManager : object, IBatchManager, IDisposableRemarks
The function of a batch manager is to manage secuential batches that may require actions inbetween. For example when saving a list of entities, if the entities have children, we need to execute the first batch of parents, then extract the ids, set the ids on children, and then execute the second batch for the children.
Constructors
| Improve this Doc View SourceBatchManager(IDatabaseConnector)
Initializes a new instance of the BatchManager class.
Declaration
public BatchManager(IDatabaseConnector connector)Parameters
| Type | Name | Description |
|---|---|---|
| IDatabaseConnector | connector | The database connector. |
Properties
| Improve this Doc View SourceMaxCount
Gets or sets the maximum count of command steps per batch.
Declaration
public int MaxCount { get; set; }Property Value
| Type | Description |
|---|---|
| System.Int32 |
Methods
| Improve this Doc View SourceAdd(ICommandBatchStep)
Adds the specified command to the current batch.
Declaration
public IBatchManager Add(ICommandBatchStep command)Parameters
| Type | Name | Description |
|---|---|---|
| ICommandBatchStep | command | The command. |
Returns
| Type | Description |
|---|---|
| IBatchManager | Returns the batch manager instance. |
AddNewBatch()
Adds a new batch to the manager.
Declaration
public IBatchManager AddNewBatch()Returns
| Type | Description |
|---|---|
| IBatchManager | Returns the batch manager instance. |
Remarks
The batch manager can handle several batches. When adding commands to manager, the manager will add the command to the current active batch manager as new batch step.
AddNewBatch(Action)
Adds a new batch to the manager.
Declaration
public IBatchManager AddNewBatch(Action action)Parameters
| Type | Name | Description |
|---|---|---|
| Action | action | The action. |
Returns
| Type | Description |
|---|---|
| IBatchManager | Returns the batch manager instance. |
Remarks
The batch manager can handle several sequential batches. When adding commands to manager, the manager will add the command to the current active batch as a new batch step.
AddNewBatch(Func<Task>)
Adds a new batch to the manager.
Declaration
public IBatchManager AddNewBatch(Func<Task> action)Parameters
| Type | Name | Description |
|---|---|---|
| Func<Task> | action | The action. |
Returns
| Type | Description |
|---|---|
| IBatchManager | Returns the batch manager instance. |
Remarks
The batch manager can handle several sequential batches. When adding commands to manager, the manager will add the command to the current active batch as a new batch step.
Dispose()
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
Declaration
public void Dispose()Execute()
Executes all the batch steps.
Declaration
public void Execute()ExecuteAsync()
Executes all the batch steps.
Declaration
public Task ExecuteAsync()Returns
| Type | Description |
|---|---|
| Task |
Reset()
Resets the batch manager. All the steps and command will be cleared.
Declaration
public void Reset()