pglock
PostgreSQL Lock Client for Go
Safety scan
A static text scan, not a guarantee. Select the badge to see what was scanned and every finding.
Check it deeper on your machine
It has changed since its scan on 11 Nov 2026.
As a Claude Code plugin, install it and then ask Claude Code:
/plugin marketplace add keithmackay/mackayi/plugin install scanskillsafety@mackayiDo a deep scan of https://github.com/cirello-io/pglock with scanskillsafety
Or from a terminal, clone it and run it:
git clone https://github.com/keithmackay/scanskillsafety-skill ~/.claude/skills/scanskillsafetynode ~/.claude/skills/scanskillsafety/cli.cjs --deep 'https://github.com/cirello-io/pglock'
It checks the exact commit: every file, its packages against OSV (api.osv.dev), how it compares with this page's scan (findsafeskills.com receives the repository's address), and, if you agree, Claude reading every file with your own Claude subscription. It never runs the code.
Badge for your README
Markdown
[](/listings/cirello-io--pglock)HTML
<a href="/listings/cirello-io--pglock"><img src="/api/listings/cirello-io--pglock/badge.svg" alt="findsafeskills safety rating" /></a>Install
Install instructions from the README
As written by the repo's author. findsafeskills has not verified these steps.
To use the PostgreSQL Lock Client for Go, you must make it sure it is present in `$GOPATH` or in your vendor directory.
$ 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:
package main
import (
"context"
"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.AcquireContext(context.Background(), "lock-name")
if err != nil {
log.Fatal("unexpected error while acquiring 1st lock:", err)
}
defer l.Close()
// execute the logic
}What was scanned
The files the safety scan read, as written by the repository's author and shown as plain text. Lines with a finding are marked.
README.md · README · 107 lines
View this file on GitHub (read at the repository's current version: the scan did not record which commit it read)
- # 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: 15 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 (
- "context"
- "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.AcquireContext(context.Background(), "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 `ReleaseContext()` 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.GetContext(context.Background(), "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).
Ratings and comments
Sign in to rate this skill.
Sign inFree to use. If it’s helped, pass it on.