README
¶
go-dynamolock
why
locking around dynamodb should be simple and easy.
what
a minimal go library for locking around dynamodb.
compared to alternatives it has less code and fewer features.
how
a record in dynamodb uses a uuid and a timetamp to coordinate callers.
to lock, a caller finds the uuid missing and adds it.
while locked, the caller heartbeats the timestamp.
to unlock, the caller removes the uuid.
arbitrary data can be stored atomically in the lock record. it is read via lock, written via unlock, and can be written without unlocking via update.
manipulation of external state while the lock is held is subject to concurrent updates depending on maxAge, heartbeatInterval, and caller clock drift.
in practice, a small heartbeatInterval, a large maxAge, and reasonable clock drift should be safe.
prefer to store data within the lock when possible, since those updates compare and swap with the uuid.
install
go get github.com/nathants/go-dynamolock
usage
package main
import (
"context"
"time"
"github.com/nathants/go-dynamolock"
"github.com/aws/aws-sdk-go/service/dynamodb/dynamodbattribute"
)
type Data struct {
Value string
}
func main() {
ctx := context.Background()
// dynamodb table
table := "table"
// dynamodb key
id := "lock1"
// after a failure to unlock/heartbeat, this much time must pass before lock is available
maxAge := time.Second * 30
// how often to heartbeat lock timestamp
heartbeat := time.Second * 1
// lock and read data
unlock, _, data, err := dynamolock.Lock[Data](ctx, table, id, maxAge, heartbeat)
if err != nil {
// TODO handle lock contention
panic(err)
}
// do work with the lock
time.Sleep(time.Second * 1)
data.Value = "updated"
// unlock and write data
err = unlock(data)
if err != nil {
panic(err)
}
}
Documentation
Source Files