Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/reecerussell/tx-command
A simple commanding library with support for executing commands within a database transaction.
https://github.com/reecerussell/tx-command
cqrs nuget rdbms sql
Last synced: 3 days ago
JSON representation
A simple commanding library with support for executing commands within a database transaction.
- Host: GitHub
- URL: https://github.com/reecerussell/tx-command
- Owner: reecerussell
- License: mit
- Created: 2021-03-09T18:52:14.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2023-03-05T19:39:21.000Z (almost 2 years ago)
- Last Synced: 2025-02-02T18:44:46.019Z (8 days ago)
- Topics: cqrs, nuget, rdbms, sql
- Language: C#
- Homepage:
- Size: 110 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://codecov.io/gh/reecerussell/tx-command)
[](https://www.codefactor.io/repository/github/reecerussell/tx-command)
[](https://www.nuget.org/packages/TxCommand/)
# TxCommand
TxCommand is a simple commanding package which provides commanding interfaces that can be executed within a transaction. TxCommand is built in a way where it can be extended to support multiple platforms and drivers.
| Package | Version | Downloads |
| ---------------------- | --------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- |
| TxCommand |  | [](https://www.nuget.org/packages/TxCommand/) |
| TxCommand.Abstractions |  | [](https://www.nuget.org/packages/TxCommand.Abstractions/) |
| TxCommand.Sql |  | [](https://www.nuget.org/packages/TxCommand.Sql/) |
| TxCommand.Sql.Abstractions |  | [](https://www.nuget.org/packages/TxCommand.Sql.Abstractions/) |
| TxCommand.Mongo |  | [](https://www.nuget.org/packages/TxCommand.Mongo/) |
| TxCommand.Mongo.Abstractions |  | [](https://www.nuget.org/packages/TxCommand.Mongo.Abstractions/) |
## Get Started
For this example, we'll be using the Sql variant of TxCommand, `TxCommand.Sql`. To get started, install the `TxCommand.Sql` package to your project - this can be done either with the NuGet Package Manager or the NuGet CLI.
```
> Install-Package TxCommand.Sql
```
After installing the TxCommand, the package can be easily configured in your DI setup. For example:
```csharp
public void ConfigureServices(IServiceCollection services)
{
// TxCommand.Sql depends on an IDbConnection, so here we configure
// an instance of MySqlConnection.
services.AddTransient(_ => new MySqlConnection(""));
// Configure TxCommand and the Sql package.
services.AddTxCommand(o => o.AddSql());
}
```
Once the DI is configured, you're good to go. The next step is to setup a command. Below is an example of a command that is used to insert a `Car` record into a database.
```csharp
using System;
using System.Data;
using TxCommand.Abstractions;
...
// This is the command which is used to create a car record. It implemented the
// ITxCommand interface, which has an optional type parameter used as a result.
public class CreateCarCommand : ITxCommand
{
public string Reg { get; set; }
public CreateCarCommand(string reg)
{
Reg = reg;
}
// This is the main entrypoint to the command.
public async Task ExecuteAsync(IDbConnection connection, IDbTransaction transaction)
{
const string query = "INSERT INTO `Cars` (`Reg`) VALUES (@Reg); SELECT LAST_INSERT_ID();";
return await connection.ExecuteScalarAsync(query, new {Reg}, transaction);
}
// Validate is used to validate that the data passed to the command
// is valid, before execution.
public void Validate()
{
if (string.IsNullOrEmpty(Reg))
{
throw new ArgumentException("Reg cannot be empty", nameof(Reg));
}
}
}
```
Now we got the command sorted, the final step is to execute it. To execute the command we use the `ISession` interface. A `Session` is used to execute a set of command within a single transaction. An instance of `ISession` can be instantiated using the `ISessionFactory` dependency.
```csharp
using TxCommand.Abstractions;
...
public class CarFactory
{
private readonly ISessionFactory _sessionFactory;
// ISessionFactory can be injected into another service, using the DI container.
public CarFactory(ISessionFactory sessionFactory)
{
_sessionFactory = sessionFactory;
}
public async Task CreateAsync(string reg)
{
// A session should be disposed to commit the transaction. Alternatively,
// session.CommitAsync() can be called - or even session.RollbackAsync();
using (var session = _sessionFactory.Create())
{
// Create a new instance of the command.
var command = new CreateCarCommand(reg);
// Then call execute! The session will first call command.Validate(),
// then it will be executed and return the result of the command.
return await session.ExecuteAsync(command);
}
}
}
```
## Contributing
Not much here, but feel free to raise an issue or open a Pull Request if you think of an enhancement or spot a bug!