Help us shape the future of Go! Take the 2026 Go Developer Survey

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

retention

package

Go to main page

Versions in this module

v1

v1.9.0

Nov 2, 2026

Changes in this version

+ const KindActivityLog

+ const KindContactUpsert

+ const StateDead

+ const StateDone

+ const StateInFlight

+ const StatePending

+ const StateSuppressed

+ var ErrNotFound = errors.New("retention: not found")

+ var MongoMigrations = migrate.NewGroup("authsome-retention", migrate.DependsOn("authsome"))

+ var PostgresMigrations = migrate.NewGroup("authsome-retention", migrate.DependsOn("authsome"))

+ var SettingConsentPurpose = settings.Define("retention.consent_purpose", "marketing", ...)

+ var SettingEnabled = settings.Define("retention.enabled", true, ...)

+ var SettingRequireConsent = settings.Define("retention.require_consent", false, ...)

+ var SqliteMigrations = migrate.NewGroup("authsome-retention", migrate.DependsOn("authsome"))

+ func Retryable(err error) (bool, time.Duration)

+ type Activity struct

+ ExternalID string

+ OccurredAt time.Time

+ Properties map[string]string

+ Redelivery bool

+ Type string

+ type Capability uint8

+ const CapActivities

+ const CapActivityDedupe

+ const CapContacts

+ func (c Capability) Has(want Capability) bool

+ type Config struct

+ AuditRetention time.Duration

+ BaseBackoff time.Duration

+ BatchSize int

+ DoneRetention time.Duration

+ Lease time.Duration

+ MaxAttempts int

+ Providers []ProviderConfig

+ PurgeInterval time.Duration

+ TickInterval time.Duration

+ type Contact struct

+ AppID id.AppID

+ Email string

+ FirstName string

+ LastName string

+ Traits map[string]string

+ UserID id.UserID

+ type ContactRef struct

+ AppID id.AppID

+ EnvID id.EnvironmentID

+ ID id.RetentionRefID

+ Provider string

+ RemoteID string

+ RemoteObjectType string

+ SyncedAt time.Time

+ UserID id.UserID

+ func (c *ContactRef) Ref() RemoteRef

+ type GenericProvider struct

+ func NewGenericProvider(cfg ProviderConfig) (*GenericProvider, error)

+ func (g *GenericProvider) Capabilities() Capability

+ func (g *GenericProvider) LogActivity(ctx context.Context, ref RemoteRef, a *Activity) error

+ func (g *GenericProvider) Name() string

+ func (g *GenericProvider) UpsertContact(ctx context.Context, c *Contact) (RemoteRef, error)

+ type HubSpotProvider struct

+ func NewHubSpotProvider(cfg ProviderConfig) (*HubSpotProvider, error)

+ func (h *HubSpotProvider) Capabilities() Capability

+ func (h *HubSpotProvider) LogActivity(ctx context.Context, ref RemoteRef, a *Activity) error

+ func (h *HubSpotProvider) Name() string

+ func (h *HubSpotProvider) UpsertContact(ctx context.Context, c *Contact) (RemoteRef, error)

+ type Job struct

+ AppID id.AppID

+ Attempts int

+ CreatedAt time.Time

+ EnvID id.EnvironmentID

+ ID id.RetentionJobID

+ IdempotencyKey string

+ InFlightUntil time.Time

+ Kind string

+ LastError string

+ NextAttemptAt time.Time

+ Payload map[string]string

+ Provider string

+ Reclaimed bool

+ State string

+ UserID id.UserID

+ func (j *Job) Redelivered() bool

+ type MemoryStore struct

+ func NewMemoryStore() *MemoryStore

+ func (s *MemoryStore) ClaimDue(_ context.Context, limit int, lease time.Duration, now time.Time) ([]*Job, error)

+ func (s *MemoryStore) DeleteRef(_ context.Context, appID id.AppID, envID id.EnvironmentID, userID id.UserID, ...) error

+ func (s *MemoryStore) Enqueue(_ context.Context, j *Job) error

+ func (s *MemoryStore) GetJob(_ context.Context, jobID id.RetentionJobID) (*Job, error)

+ func (s *MemoryStore) GetRef(_ context.Context, appID id.AppID, envID id.EnvironmentID, userID id.UserID, ...) (*ContactRef, error)

+ func (s *MemoryStore) ListDead(_ context.Context, appID id.AppID, limit int) ([]*Job, error)

+ func (s *MemoryStore) ListRefsForUser(_ context.Context, userID id.UserID) ([]*ContactRef, error)

+ func (s *MemoryStore) MarkDead(_ context.Context, jobID id.RetentionJobID, lastErr string) error

+ func (s *MemoryStore) MarkDeferred(_ context.Context, jobID id.RetentionJobID, next time.Time, reason string) error

+ func (s *MemoryStore) MarkDone(_ context.Context, jobID id.RetentionJobID, _ time.Time) error

+ func (s *MemoryStore) MarkRetry(_ context.Context, jobID id.RetentionJobID, next time.Time, lastErr string) error

+ func (s *MemoryStore) MarkSuppressed(_ context.Context, jobID id.RetentionJobID, reason string) error

+ func (s *MemoryStore) PurgeTerminal(_ context.Context, doneBefore, auditBefore time.Time) (int, error)

+ func (s *MemoryStore) PutRef(_ context.Context, r *ContactRef) error

+ type MongoStore struct

+ func NewMongoStore(db *grove.DB) *MongoStore

+ func (s *MongoStore) ClaimDue(ctx context.Context, limit int, lease time.Duration, now time.Time) ([]*Job, error)

+ func (s *MongoStore) DeleteRef(ctx context.Context, appID id.AppID, envID id.EnvironmentID, userID id.UserID, ...) error

+ func (s *MongoStore) Enqueue(ctx context.Context, j *Job) error

+ func (s *MongoStore) GetJob(ctx context.Context, jobID id.RetentionJobID) (*Job, error)

+ func (s *MongoStore) GetRef(ctx context.Context, appID id.AppID, envID id.EnvironmentID, userID id.UserID, ...) (*ContactRef, error)

+ func (s *MongoStore) ListDead(ctx context.Context, appID id.AppID, limit int) ([]*Job, error)

+ func (s *MongoStore) ListRefsForUser(ctx context.Context, userID id.UserID) ([]*ContactRef, error)

+ func (s *MongoStore) MarkDead(ctx context.Context, jobID id.RetentionJobID, lastErr string) error

+ func (s *MongoStore) MarkDeferred(ctx context.Context, jobID id.RetentionJobID, nextAttemptAt time.Time, ...) error

+ func (s *MongoStore) MarkDone(ctx context.Context, jobID id.RetentionJobID, _ time.Time) error

+ func (s *MongoStore) MarkRetry(ctx context.Context, jobID id.RetentionJobID, nextAttemptAt time.Time, ...) error

+ func (s *MongoStore) MarkSuppressed(ctx context.Context, jobID id.RetentionJobID, reason string) error

+ func (s *MongoStore) PurgeTerminal(ctx context.Context, doneBefore, auditBefore time.Time) (int, error)

+ func (s *MongoStore) PutRef(ctx context.Context, r *ContactRef) error

+ func (s *MongoStore) SetLogger(l log.Logger)

+ type Plugin struct

+ func New(cfg ...Config) *Plugin

+ func (p *Plugin) DeclareSettings(m *settings.Manager) error

+ func (p *Plugin) ExportUserData(ctx context.Context, userID id.UserID) (category string, data any, err error)

+ func (p *Plugin) MigrationGroups(driverName string) []*migrate.Group

+ func (p *Plugin) Name() string

+ func (p *Plugin) OnAfterSignIn(ctx context.Context, u *user.User, s *session.Session) error

+ func (p *Plugin) OnAfterSignUp(ctx context.Context, u *user.User, s *session.Session) error

+ func (p *Plugin) OnAfterUserUpdate(ctx context.Context, u *user.User) error

+ func (p *Plugin) OnInit(_ context.Context, engine plugin.Engine) error

+ func (p *Plugin) OnShutdown(_ context.Context) error

+ func (p *Plugin) RegisterProvider(pr Provider)

+ func (p *Plugin) SetStore(s Store)

+ type PostgresStore struct

+ func NewPostgresStore(db *grove.DB) *PostgresStore

+ func (s *PostgresStore) ClaimDue(ctx context.Context, limit int, lease time.Duration, now time.Time) ([]*Job, error)

+ func (s *PostgresStore) DeleteRef(ctx context.Context, appID id.AppID, envID id.EnvironmentID, userID id.UserID, ...) error

+ func (s *PostgresStore) Enqueue(ctx context.Context, j *Job) error

+ func (s *PostgresStore) GetJob(ctx context.Context, jobID id.RetentionJobID) (*Job, error)

+ func (s *PostgresStore) GetRef(ctx context.Context, appID id.AppID, envID id.EnvironmentID, userID id.UserID, ...) (*ContactRef, error)

+ func (s *PostgresStore) ListDead(ctx context.Context, appID id.AppID, limit int) ([]*Job, error)

+ func (s *PostgresStore) ListRefsForUser(ctx context.Context, userID id.UserID) ([]*ContactRef, error)

+ func (s *PostgresStore) MarkDead(ctx context.Context, jobID id.RetentionJobID, lastErr string) error

+ func (s *PostgresStore) MarkDeferred(ctx context.Context, jobID id.RetentionJobID, nextAttemptAt time.Time, ...) error

+ func (s *PostgresStore) MarkDone(ctx context.Context, jobID id.RetentionJobID, _ time.Time) error

+ func (s *PostgresStore) MarkRetry(ctx context.Context, jobID id.RetentionJobID, nextAttemptAt time.Time, ...) error

+ func (s *PostgresStore) MarkSuppressed(ctx context.Context, jobID id.RetentionJobID, reason string) error

+ func (s *PostgresStore) PurgeTerminal(ctx context.Context, doneBefore, auditBefore time.Time) (int, error)

+ func (s *PostgresStore) PutRef(ctx context.Context, r *ContactRef) error

+ func (s *PostgresStore) SetLogger(l log.Logger)

+ type Provider interface

+ Capabilities func() Capability

+ LogActivity func(ctx context.Context, ref RemoteRef, a *Activity) error

+ Name func() string

+ UpsertContact func(ctx context.Context, c *Contact) (RemoteRef, error)

+ type ProviderConfig struct

+ ActivityURL string

+ AuthHeader string

+ AuthType string

+ BaseURL string

+ ContactURL string

+ FieldMap map[string]string

+ Name string

+ Token string

+ Type string

+ type ProviderError struct

+ DropRef bool

+ Err error

+ RetryAfter time.Duration

+ Retryable bool

+ Status int

+ func (e *ProviderError) Error() string

+ func (e *ProviderError) Unwrap() error

+ type RemoteRef struct

+ ID string

+ ObjectType string

+ Provider string

+ func (r RemoteRef) IsZero() bool

+ type SqliteStore struct

+ func NewSqliteStore(db *grove.DB) *SqliteStore

+ func (s *SqliteStore) ClaimDue(ctx context.Context, limit int, lease time.Duration, now time.Time) ([]*Job, error)

+ func (s *SqliteStore) DeleteRef(ctx context.Context, appID id.AppID, envID id.EnvironmentID, userID id.UserID, ...) error

+ func (s *SqliteStore) Enqueue(ctx context.Context, j *Job) error

+ func (s *SqliteStore) GetJob(ctx context.Context, jobID id.RetentionJobID) (*Job, error)

+ func (s *SqliteStore) GetRef(ctx context.Context, appID id.AppID, envID id.EnvironmentID, userID id.UserID, ...) (*ContactRef, error)

+ func (s *SqliteStore) ListDead(ctx context.Context, appID id.AppID, limit int) ([]*Job, error)

+ func (s *SqliteStore) ListRefsForUser(ctx context.Context, userID id.UserID) ([]*ContactRef, error)

+ func (s *SqliteStore) MarkDead(ctx context.Context, jobID id.RetentionJobID, lastErr string) error

+ func (s *SqliteStore) MarkDeferred(ctx context.Context, jobID id.RetentionJobID, nextAttemptAt time.Time, ...) error

+ func (s *SqliteStore) MarkDone(ctx context.Context, jobID id.RetentionJobID, _ time.Time) error

+ func (s *SqliteStore) MarkRetry(ctx context.Context, jobID id.RetentionJobID, nextAttemptAt time.Time, ...) error

+ func (s *SqliteStore) MarkSuppressed(ctx context.Context, jobID id.RetentionJobID, reason string) error

+ func (s *SqliteStore) PurgeTerminal(ctx context.Context, doneBefore, auditBefore time.Time) (int, error)

+ func (s *SqliteStore) PutRef(ctx context.Context, r *ContactRef) error

+ func (s *SqliteStore) SetLogger(l log.Logger)

+ type Store interface

+ ClaimDue func(ctx context.Context, limit int, lease time.Duration, now time.Time) ([]*Job, error)

+ DeleteRef func(ctx context.Context, appID id.AppID, envID id.EnvironmentID, userID id.UserID, ...) error

+ Enqueue func(ctx context.Context, j *Job) error

+ GetJob func(ctx context.Context, jobID id.RetentionJobID) (*Job, error)

+ GetRef func(ctx context.Context, appID id.AppID, envID id.EnvironmentID, userID id.UserID, ...) (*ContactRef, error)

+ ListDead func(ctx context.Context, appID id.AppID, limit int) ([]*Job, error)

+ ListRefsForUser func(ctx context.Context, userID id.UserID) ([]*ContactRef, error)

+ MarkDead func(ctx context.Context, jobID id.RetentionJobID, lastErr string) error

+ MarkDeferred func(ctx context.Context, jobID id.RetentionJobID, nextAttemptAt time.Time, ...) error

+ MarkDone func(ctx context.Context, jobID id.RetentionJobID, now time.Time) error

+ MarkRetry func(ctx context.Context, jobID id.RetentionJobID, nextAttemptAt time.Time, ...) error

+ MarkSuppressed func(ctx context.Context, jobID id.RetentionJobID, reason string) error

+ PurgeTerminal func(ctx context.Context, doneBefore, auditBefore time.Time) (int, error)

+ PutRef func(ctx context.Context, r *ContactRef) error

v1.8.3

Oct 20, 2026

v1.8.2

Oct 20, 2026

v1.8.1

Oct 18, 2026

v1.8.0

Oct 18, 2026