Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cirello-io/pglock
PostgreSQL Lock Client for Go
https://github.com/cirello-io/pglock
lock locking
Last synced: 4 days ago
JSON representation
PostgreSQL Lock Client for Go
- Host: GitHub
- URL: https://github.com/cirello-io/pglock
- Owner: cirello-io
- License: apache-2.0
- Created: 2018-12-17T17:43:41.000Z (almost 6 years ago)
- Default Branch: main
- Last Pushed: 2024-10-27T17:49:39.000Z (12 days ago)
- Last Synced: 2024-10-27T20:53:29.821Z (12 days ago)
- Topics: lock, locking
- Language: Go
- Homepage: https://godoc.org/cirello.io/pglock
- Size: 331 KB
- Stars: 108
- Watchers: 2
- Forks: 23
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-go-extra - pglock - 12-17T17:43:41Z|2022-06-05T15:42:11Z| (Distributed Systems / Advanced Console UIs)
README
# PostgreSQL Lock Client for Go
[](https://godoc.org/cirello.io/pglock)
[](https://github.com/cirello-io/pglock/actions/workflows/go.yml)
[](https://github.com/avelino/awesome-go)
The PostgreSQL Lock Client for Go is a general purpose distributed locking
library built for PostgreSQL. The PostgreSQL Lock Client for Go supports both
fine-grained and coarse-grained locking as the lock keys can be any arbitrary
string, up to a certain length. Please create issues in the GitHub repository
with questions, pull request are very much welcome.
_Recommended PostgreSQL version: 12 or newer_
## Use cases
A common use case for this lock client is:
let's say you have a distributed system that needs to periodically do work on a
given campaign (or a given customer, or any other object) and you want to make
sure that two boxes don't work on the same campaign/customer at the same time.
An easy way to fix this is to write a system that takes a lock on a customer,
but fine-grained locking is a tough problem. This library attempts to simplify
this locking problem on top of PostgreSQL.
Another use case is leader election. If you only want one host to be the leader,
then this lock client is a great way to pick one. When the leader fails, it will
fail over to another host within a customizable lease duration that you set.
## Getting Started
To use the PostgreSQL Lock Client for Go, you must make it sure it is present in
`$GOPATH` or in your vendor directory.
```sh
$ go get -u cirello.io/pglock
```
This package has the `go.mod` file to be used with Go's module system. If you
need to work on this package, use `go mod edit -replace=cirello.io/pglock@yourlocalcopy`.
For your convenience, there is a function in the package called `CreateTable`
that you can use to set up your table, or you may use the schema.sql file.
The package level documentation comment has an example of how to use this
package. Here is some example code to get you started:
```Go
package main
import (
"log"
"cirello.io/pglock"
)
func main() {
db, err := sql.Open("postgres", *dsn)
if err != nil {
log.Fatal("cannot connect to test database server:", err)
}
c, err := pglock.New(db,
pglock.WithLeaseDuration(3*time.Second),
pglock.WithHeartbeatFrequency(1*time.Second),
)
if err != nil {
log.Fatal("cannot create lock client:", err)
}
if err := c.CreateTable(); err != nil {
log.Fatal("cannot create table:", err)
}
l, err := c.Acquire("lock-name")
if err != nil {
log.Fatal("unexpected error while acquiring 1st lock:", err)
}
defer l.Close()
// execute the logic
}
```
## Selected Features
### Send Automatic Heartbeats
When you create the lock client, you can specify `WithHeartbeatFrequency(time.Duration)`
like in the above example, and it will spawn a background goroutine that
continually updates the record version number on your locks to prevent them from
expiring (it does this by calling the `SendHeartbeat()` method in the lock
client.) This will ensure that as long as your application is running, your
locks will not expire until you call `Release()` or `lockItem.Close()`
### Read the data in a lock without acquiring it
You can read the data in the lock without acquiring it. Here's how:
```Go
lock, err := lockClient.Get("kirk");
```
## Logic to avoid problems with clock skew
The lock client never stores absolute times in PostgreSQL. The way locks are
expired is that a call to tryAcquire reads in the current lock, checks the
record version number of the lock and starts a timer. If the lock still has the
same after the lease duration time has passed, the client will determine that
the lock is stale and expire it.
What this means is that, even if two different machines disagree about what time
it is, they will still avoid clobbering each other's locks.
## Go Version Compatibility Promise
This package follows the same guidance as the Go's:
> Each major Go release is supported until there are two newer major releases. For example, Go 1.5 was supported until the Go 1.7 release, and Go 1.6 was supported until the Go 1.8 release. We fix critical problems, including critical security problems, in supported releases as needed by issuing minor revisions (for example, Go 1.6.1, Go 1.6.2, and so on).