Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
- API
  
  Reference documentation for the pkg.go.dev API
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

pgmesh

package module

Go to main page

Versions in this module

v0

v0.0.3

Jul 28, 2026

Changes in this version

+ var ErrCrossShardTransaction = errors.New("pgmesh: transaction cannot span physical shards")

type QuerySpan

+ func (s *QuerySpan) SetMultiRoute(mode RouteMode)

v0.0.2

Jul 28, 2026

Changes in this version

type Mesh

+ func (m *Mesh[R, W, SK]) StartSpan(ctx context.Context, storeName string, queryName string, kind QueryKind) (context.Context, *QuerySpan)

+ type MeshOption func(*meshConfig)

+ func WithLogger(logger *slog.Logger) MeshOption

+ func WithMeterProvider(provider metric.MeterProvider) MeshOption

+ func WithReplicaSet(name, primaryDSN string, replicaDSNs ...string) MeshOption

+ func WithTracerProvider(provider trace.TracerProvider) MeshOption

+ func WithVShardMapping(mainReplicaSet string, vshards []uint64, mirrorReplicaSets ...string) MeshOption

+ type NodeFactory func(context.Context, string) (Node[R, W], error)

+ type QuerySpan struct

+ func (s *QuerySpan) End(err error)

+ func (s *QuerySpan) SetRoute(vshard uint64, replicaSet string, mode RouteMode, writeMirrorCount int)

v0.0.1

Jul 20, 2026

Changes in this version

+ const AttributeQueryError

+ const AttributeQueryKind

+ const AttributeQueryName

+ const AttributeReplicaSet

+ const AttributeRouteMode

+ const AttributeVShard

+ const AttributeWriteMirrorCount

+ const MetricQueryCount

+ const MetricQueryDuration

+ var ErrDuplicateReplicaSet = errors.New("pgmesh: duplicate replica set")

+ var ErrDuplicateVShard = errors.New("pgmesh: virtual shard is already linked")

+ var ErrEmptyDSN = errors.New("pgmesh: connection DSN must not be empty")

+ var ErrEmptyReplicaSetName = errors.New("pgmesh: replica set name must not be empty")

+ var ErrMirrorConfiguration = errors.New("pgmesh: inconsistent mirror configuration")

+ var ErrMissingVShard = errors.New("pgmesh: virtual shard is not linked")

+ var ErrNilReplicaSet = errors.New("pgmesh: replica set must not be nil")

+ var ErrNoNodeFactory = errors.New("pgmesh: node factory is required")

+ var ErrNoReplicaSets = errors.New("pgmesh: at least one replica set is required")

+ var ErrNoShardHasher = errors.New("pgmesh: shard hasher is required")

+ var ErrNoVShards = errors.New("pgmesh: at least one virtual shard is required")

+ var ErrUnknownReplicaSet = errors.New("pgmesh: unknown replica set")

+ var ErrVShardOutOfRange = errors.New("pgmesh: virtual shard is out of range")

+ func VShardRange(from, to uint64) []uint64

+ type Builder struct

+ func NewBuilder[R any, W Mirrorable[W], SK any](numVShards uint64) *Builder[R, W, SK]

+ func (b *Builder[R, W, SK]) Build() (*Mesh[R, W, SK], error)

+ func (b *Builder[R, W, SK]) Link(vshard uint64, rs *ReplicaSet[R, W]) *Builder[R, W, SK]

+ func (b *Builder[R, W, SK]) WithHasher(hasher ShardHasher[SK]) *Builder[R, W, SK]

+ func (b *Builder[R, W, SK]) WithLogger(logger *slog.Logger) *Builder[R, W, SK]

+ func (b *Builder[R, W, SK]) WithMeterProvider(provider metric.MeterProvider) *Builder[R, W, SK]

+ func (b *Builder[R, W, SK]) WithTracerProvider(provider trace.TracerProvider) *Builder[R, W, SK]

+ type Connection struct

+ DSN string

+ type IntShardKey interface

+ type Mesh struct

+ func CreateMesh[R any, W Mirrorable[W], SK any](ctx context.Context, opts *Options[R, W, SK]) (*Mesh[R, W, SK], error)

+ func (m *Mesh[R, W, SK]) AllShards() []*Shard[R, W]

+ func (m *Mesh[R, W, SK]) Shard(key SK) (*Shard[R, W], error)

+ func (m *Mesh[R, W, SK]) StartQueryTrace(ctx context.Context, queryName string, kind QueryKind) (context.Context, *QueryTrace)

+ type Mirrorable interface

+ WithMirrors func(...W) W

+ type Node struct

+ func NewNode[R any, W Mirrorable[W]](reader R, writer W) Node[R, W]

+ func (n Node[R, W]) Reader() R

+ func (n Node[R, W]) Writer() W

+ type Options struct

+ CreateNode func(context.Context, string) (Node[R, W], error)

+ Logger *slog.Logger

+ MeterProvider metric.MeterProvider

+ ReplicaSets []ReplicaSetSpec

+ ShardHasher ShardHasher[SK]

+ Shards Shards

+ TracerProvider trace.TracerProvider

+ type QueryKind string

+ const QueryKindRead

+ const QueryKindWrite

+ type QueryTrace struct

+ func (t *QueryTrace) End(err error)

+ func (t *QueryTrace) SetRoute(vshard uint64, replicaSet string, mode RouteMode, writeMirrorCount int)

+ type ReplicaSet struct

+ func NewReplicaSet[R any, W Mirrorable[W]](name string, primary Node[R, W], replicas []Node[R, W]) *ReplicaSet[R, W]

+ func (s *ReplicaSet[R, W]) Name() string

+ func (s *ReplicaSet[R, W]) Read() R

+ func (s *ReplicaSet[R, W]) WithWriteMirrors(writes ...W) *ReplicaSet[R, W]

+ func (s *ReplicaSet[R, W]) Write() W

+ func (s *ReplicaSet[R, W]) WriteMirrorCount() int

+ type ReplicaSetSpec struct

+ Name string

+ Primary Connection

+ Replicas []Connection

+ type RouteMode string

+ const RouteModePrimary

+ const RouteModeRead

+ const RouteModeTransaction

+ type Shard struct

+ func (s *Shard[R, W]) VShardIndex() uint64

+ type ShardHasher interface

+ Hash func(SK) uint64

+ func ConstantShardHashFor[SK any](vshard uint64) ShardHasher[SK]

+ func ModularShardHashFor[SK IntShardKey](numVShards uint64) ShardHasher[SK]

+ type Shards struct

+ Mappings []VShardMapping

+ NumVShards uint64

+ type VShardMapping struct

+ MainReplicaSet string

+ MirrorReplicaSets []string

+ VShards []uint64