https://github.com/freerware/work
A compact library for tracking and committing changes to your entities.
https://github.com/freerware/work
database design-pattern design-patterns designpattern designpatterns go golang martin-fowler resiliency transactions unit-of-work unitofwork
Last synced: about 1 month ago
JSON representation
A compact library for tracking and committing changes to your entities.
- Host: GitHub
- URL: https://github.com/freerware/work
- Owner: freerware
- License: apache-2.0
- Created: 2019-04-20T17:34:31.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2025-01-18T19:10:12.000Z (about 1 year ago)
- Last Synced: 2025-01-18T19:31:38.448Z (about 1 year ago)
- Topics: database, design-pattern, design-patterns, designpattern, designpatterns, go, golang, martin-fowler, resiliency, transactions, unit-of-work, unitofwork
- Language: Go
- Homepage:
- Size: 336 KB
- Stars: 60
- Watchers: 4
- Forks: 2
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# work
> A compact library for tracking and committing atomic changes to your entities.
[![GoDoc][doc-img]][doc] [![Build Status][ci-img]][ci]
[![Coverage Status][coverage-img]][coverage] [![Release][release-img]][release]
[![License][license-img]][license] [![Blog][blog-img]][blog]
## What is it?
`work` does the heavy lifting of tracking changes that your application makes
to entities within a particular operation. This is accomplished by using what we
refer to as a "work unit", which is essentially an implementation of the
[Unit Of Work][uow] pattern popularized by Martin Fowler. With work units,
you no longer need to write any code to track, apply, or rollback changes
atomically in your application. This lets you focus on just writing the code
that handles changes when they happen.
## Why use it?
- easier management of changes to your entities.
- automatic rollback of changes when chaos ensues.
- centralization of save and rollback functionality.
- reduced overhead when applying changes.
- decoupling of code triggering changes from code that persists the changes.
- production-ready logs and metrics.
- works with your existing persistence layer.
- automatic and configurable retries.
For SQL datastores, also enjoy:
- one transaction, one connection per unit.
- consolidates persistence operations into three operations, regardless of
the amount of entity changes.
- shorter transaction times.
- transaction is opened only once the unit is ready to be saved.
- transaction only remains open as long as it takes for the unit to be saved.
- proper threading of `context.Context` with `database/sql`.
## Getting Started
Ready to get moving? Head over to the [Getting Started][getting-started] page in the wiki.
## Release information
| Version | Supported |
|---------|-----------|
| `V4` | ✅ |
| `V3` | ✅ |
| `V2` | ❌ |
| `V1` | ❌ |
> Versions `1.x.x` and `2.x.x` are no longer supported. Please upgrade to
at least `3.x.x+` to receive the latest and greatest features!
## Dependancy Information
As of [`v3.0.0`][modules-release], the project utilizes [modules][modules-doc].
Prior to `v3.0.0`, the project utilized [`dep`][dep] for dependency management.
In order to transition to modules gracefully, we adhered to the
[best practice recommendations][modules-wiki] authored by the Golang team.
## Contribute
Want to lend us a hand? Check out our guidelines for
[contributing][contributing].
## License
We are rocking an [Apache 2.0 license][apache-license] for this project.
## Code of Conduct
Please check out our [code of conduct][code-of-conduct] to get up to speed
how we do things.
[uow]: https://martinfowler.com/eaaCatalog/unitOfWork.html
[modules-doc]: https://golang.org/doc/go1.11#modules
[modules-wiki]: https://github.com/golang/go/wiki/Modules#releasing-modules-v2-or-higher
[modules-release]: https://github.com/freerware/work/releases/tag/v3.0.0
[dep]: https://golang.github.io/dep/
[contributing]: https://github.com/freerware/work/blob/master/CONTRIBUTING.md
[apache-license]: https://github.com/freerware/work/blob/master/LICENSE.txt
[code-of-conduct]: https://github.com/freerware/work/blob/master/CODE_OF_CONDUCT.md
[concurrency-pr]: https://github.com/freerware/work/pull/35
[actions-pr]: https://github.com/freerware/work/pull/30
[doc-img]: https://pkg.go.dev/badge/github.com/freerware/work/v4.svg
[doc]: https://pkg.go.dev/github.com/freerware/work/v4
[ci-img]: https://github.com/freerware/work/actions/workflows/ci.yaml/badge.svg?branch=master
[ci]: https://github.com/freerware/work/actions/workflows/ci.yaml
[coverage-img]: https://codecov.io/gh/freerware/work/branch/master/graph/badge.svg?token=W5YH9TPP3C
[coverage]: https://codecov.io/gh/freerware/work
[license]: https://opensource.org/licenses/Apache-2.0
[license-img]: https://img.shields.io/badge/License-Apache%202.0-blue.svg
[release]: https://github.com/freerware/work/releases
[release-img]: https://img.shields.io/github/tag/freerware/work.svg?label=version
[blog]: https://medium.com/@freerjm/work-units-ec2da48cf574
[blog-img]: https://img.shields.io/badge/blog-medium-lightgrey
[v4-docs]: https://github.com/freerware/work/blob/master/v4/README.md
[tags]: https://github.com/freerware/work/tags
[dependabot-alerts]: https://github.com/freerware/work/security/dependabot?q=is%3Aclosed
[getting-started]: https://github.com/freerware/work/wiki/Getting-Started