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

store

package

Go to main page

Versions in this module

v0

v0.1.4

Feb 19, 2026

v0.1.3

Jan 12, 2026

v0.1.2

Jan 12, 2026

v0.1.1

Jan 9, 2026

v0.1.0

Jan 9, 2026

Changes in this version

+ type AuditAction string

+ const AuditActionConfigReload

+ const AuditActionJobCancelled

+ const AuditActionJobCompleted

+ const AuditActionJobCreated

+ const AuditActionJobFailed

+ const AuditActionJobReordered

+ const AuditActionJobTriggered

+ const AuditActionUserLogin

+ const AuditActionUserLogout

+ type AuditEntityType string

+ const AuditEntityGroup

+ const AuditEntityJob

+ const AuditEntityRunner

+ const AuditEntitySession

+ const AuditEntitySystem

+ const AuditEntityUser

+ type AuditEntry struct

+ Action AuditAction

+ Actor string

+ CreatedAt time.Time

+ Details string

+ EntityID string

+ EntityType AuditEntityType

+ ID string

+ type AuditQueryOpts struct

+ Action *AuditAction

+ Actor *string

+ EntityID *string

+ EntityType *AuditEntityType

+ Limit int

+ Offset int

+ Since *time.Time

+ Until *time.Time

+ type AuthCode struct

+ Code string

+ CreatedAt time.Time

+ ExpiresAt time.Time

+ UserID string

+ type AuthProvider string

+ const AuthProviderBasic

+ const AuthProviderGitHub

+ type Group struct

+ CreatedAt time.Time

+ Description string

+ Enabled bool

+ ID string

+ Name string

+ Paused bool

+ RunnerLabels []string

+ UpdatedAt time.Time

+ type HistoryQueryOpts struct

+ Before *time.Time

+ GroupID string

+ Labels map[string]string

+ Limit int

+ Statuses []JobStatus

+ type HistoryResult struct

+ HasMore bool

+ Jobs []*Job

+ NextCursor *time.Time

+ TotalCount int

+ type HistoryStatsBucket struct

+ Cancelled int

+ Completed int

+ Failed int

+ Timestamp time.Time

+ type HistoryStatsOpts struct

+ Buckets int

+ End time.Time

+ GroupID string

+ Start time.Time

+ type HistoryStatsRange struct

+ BucketDuration time.Duration

+ End time.Time

+ Start time.Time

+ type HistoryStatsResult struct

+ Buckets []*HistoryStatsBucket

+ Range HistoryStatsRange

+ Totals HistoryStatsTotals

+ type HistoryStatsTotals struct

+ Cancelled int

+ Completed int

+ Failed int

+ type Job struct

+ AutoRequeue bool

+ CompletedAt *time.Time

+ CreatedAt time.Time

+ CreatedBy string

+ ErrorMessage string

+ GroupID string

+ ID string

+ Inputs map[string]string

+ Labels map[string]string

+ Name *string

+ Owner *string

+ Paused bool

+ Position int

+ Priority int

+ Ref *string

+ Repo *string

+ RequeueCount int

+ RequeueLimit *int

+ RunID *int64

+ RunURL string

+ RunnerID *int64

+ RunnerName string

+ Status JobStatus

+ TemplateID string

+ TriggeredAt *time.Time

+ UpdatedAt time.Time

+ WorkflowID *string

+ type JobStatus string

+ const JobStatusCancelled

+ const JobStatusCompleted

+ const JobStatusFailed

+ const JobStatusPending

+ const JobStatusRunning

+ const JobStatusTriggered

+ type JobTemplate struct

+ CreatedAt time.Time

+ DefaultInputs map[string]string

+ GroupID string

+ ID string

+ InConfig bool

+ Labels map[string]string

+ Name string

+ Owner string

+ Ref string

+ Repo string

+ SourcePath string

+ SourceType string

+ UpdatedAt time.Time

+ WorkflowID string

+ type OAuthState struct

+ CreatedAt time.Time

+ ExpiresAt time.Time

+ State string

+ type PostgresStore struct

+ func (s *PostgresStore) CreateAuditEntry(ctx context.Context, entry *AuditEntry) error

+ func (s *PostgresStore) CreateAuthCode(ctx context.Context, code *AuthCode) error

+ func (s *PostgresStore) CreateGroup(ctx context.Context, group *Group) error

+ func (s *PostgresStore) CreateJob(ctx context.Context, job *Job) error

+ func (s *PostgresStore) CreateJobTemplate(ctx context.Context, template *JobTemplate) error

+ func (s *PostgresStore) CreateOAuthState(ctx context.Context, state *OAuthState) error

+ func (s *PostgresStore) CreateSession(ctx context.Context, session *Session) error

+ func (s *PostgresStore) CreateUser(ctx context.Context, user *User) error

+ func (s *PostgresStore) DeleteAuthCode(ctx context.Context, code string) error

+ func (s *PostgresStore) DeleteExpiredAuthCodes(ctx context.Context) error

+ func (s *PostgresStore) DeleteExpiredOAuthStates(ctx context.Context) error

+ func (s *PostgresStore) DeleteExpiredSessions(ctx context.Context) error

+ func (s *PostgresStore) DeleteGroup(ctx context.Context, id string) error

+ func (s *PostgresStore) DeleteJob(ctx context.Context, id string) error

+ func (s *PostgresStore) DeleteJobTemplate(ctx context.Context, id string) error

+ func (s *PostgresStore) DeleteJobTemplatesByGroup(ctx context.Context, groupID string) error

+ func (s *PostgresStore) DeleteOAuthState(ctx context.Context, state string) error

+ func (s *PostgresStore) DeleteOldJobs(ctx context.Context, olderThan time.Time) (int64, error)

+ func (s *PostgresStore) DeleteRunner(ctx context.Context, id int64) error

+ func (s *PostgresStore) DeleteSession(ctx context.Context, id string) error

+ func (s *PostgresStore) DeleteStaleRunners(ctx context.Context, olderThan time.Time) error

+ func (s *PostgresStore) DeleteUser(ctx context.Context, id string) error

+ func (s *PostgresStore) DeleteUserSessions(ctx context.Context, userID string) error

+ func (s *PostgresStore) GetAuthCode(ctx context.Context, code string) (*AuthCode, error)

+ func (s *PostgresStore) GetGroup(ctx context.Context, id string) (*Group, error)

+ func (s *PostgresStore) GetHistoryStats(ctx context.Context, opts HistoryStatsOpts) (*HistoryStatsResult, error)

+ func (s *PostgresStore) GetHistoryTimeBounds(ctx context.Context, groupID string) (oldest, newest *time.Time, err error)

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

+ func (s *PostgresStore) GetJobTemplate(ctx context.Context, id string) (*JobTemplate, error)

+ func (s *PostgresStore) GetMaxPosition(ctx context.Context, groupID string) (int, error)

+ func (s *PostgresStore) GetNextPendingJob(ctx context.Context, groupID string) (*Job, error)

+ func (s *PostgresStore) GetOAuthState(ctx context.Context, state string) (*OAuthState, error)

+ func (s *PostgresStore) GetRunner(ctx context.Context, id int64) (*Runner, error)

+ func (s *PostgresStore) GetRunnerByName(ctx context.Context, name string) (*Runner, error)

+ func (s *PostgresStore) GetSession(ctx context.Context, id string) (*Session, error)

+ func (s *PostgresStore) GetSessionByToken(ctx context.Context, tokenHash string) (*Session, error)

+ func (s *PostgresStore) GetUser(ctx context.Context, id string) (*User, error)

+ func (s *PostgresStore) GetUserByGitHubID(ctx context.Context, githubID string) (*User, error)

+ func (s *PostgresStore) GetUserByUsername(ctx context.Context, username string) (*User, error)

+ func (s *PostgresStore) HasAnyJobs(ctx context.Context, templateID string) (bool, error)

+ func (s *PostgresStore) ListAuditEntries(ctx context.Context, opts AuditQueryOpts) ([]*AuditEntry, int, error)

+ func (s *PostgresStore) ListGroups(ctx context.Context) ([]*Group, error)

+ func (s *PostgresStore) ListJobHistory(ctx context.Context, opts HistoryQueryOpts) (*HistoryResult, error)

+ func (s *PostgresStore) ListJobTemplatesByGroup(ctx context.Context, groupID string) ([]*JobTemplate, error)

+ func (s *PostgresStore) ListJobsByGroup(ctx context.Context, groupID string, statuses ...JobStatus) ([]*Job, error)

+ func (s *PostgresStore) ListJobsByStatus(ctx context.Context, statuses ...JobStatus) ([]*Job, error)

+ func (s *PostgresStore) ListRunners(ctx context.Context) ([]*Runner, error)

+ func (s *PostgresStore) ListRunnersByLabels(ctx context.Context, labels []string) ([]*Runner, error)

+ func (s *PostgresStore) Migrate(ctx context.Context) error

+ func (s *PostgresStore) Ping(ctx context.Context) error

+ func (s *PostgresStore) ReorderJobs(ctx context.Context, groupID string, jobIDs []string) error

+ func (s *PostgresStore) Start(ctx context.Context) error

+ func (s *PostgresStore) Stop() error

+ func (s *PostgresStore) UpdateGroup(ctx context.Context, group *Group) error

+ func (s *PostgresStore) UpdateJob(ctx context.Context, job *Job) error

+ func (s *PostgresStore) UpdateJobTemplate(ctx context.Context, template *JobTemplate) error

+ func (s *PostgresStore) UpdateTemplateInConfig(ctx context.Context, id string, inConfig bool) error

+ func (s *PostgresStore) UpdateUser(ctx context.Context, user *User) error

+ func (s *PostgresStore) UpsertRunner(ctx context.Context, runner *Runner) error

+ type Role string

+ const RoleAdmin

+ const RoleReadOnly

+ type Runner struct

+ Busy bool

+ CreatedAt time.Time

+ ID int64

+ Labels []string

+ LastSeenAt time.Time

+ Name string

+ OS string

+ Status RunnerStatus

+ UpdatedAt time.Time

+ type RunnerStatus string

+ const RunnerStatusOffline

+ const RunnerStatusOnline

+ type SQLiteStore struct

+ func (s *SQLiteStore) CreateAuditEntry(ctx context.Context, entry *AuditEntry) error

+ func (s *SQLiteStore) CreateAuthCode(ctx context.Context, code *AuthCode) error

+ func (s *SQLiteStore) CreateGroup(ctx context.Context, group *Group) error

+ func (s *SQLiteStore) CreateJob(ctx context.Context, job *Job) error

+ func (s *SQLiteStore) CreateJobTemplate(ctx context.Context, template *JobTemplate) error

+ func (s *SQLiteStore) CreateOAuthState(ctx context.Context, state *OAuthState) error

+ func (s *SQLiteStore) CreateSession(ctx context.Context, session *Session) error

+ func (s *SQLiteStore) CreateUser(ctx context.Context, user *User) error

+ func (s *SQLiteStore) DeleteAuthCode(ctx context.Context, code string) error

+ func (s *SQLiteStore) DeleteExpiredAuthCodes(ctx context.Context) error

+ func (s *SQLiteStore) DeleteExpiredOAuthStates(ctx context.Context) error

+ func (s *SQLiteStore) DeleteExpiredSessions(ctx context.Context) error

+ func (s *SQLiteStore) DeleteGroup(ctx context.Context, id string) error

+ func (s *SQLiteStore) DeleteJob(ctx context.Context, id string) error

+ func (s *SQLiteStore) DeleteJobTemplate(ctx context.Context, id string) error

+ func (s *SQLiteStore) DeleteJobTemplatesByGroup(ctx context.Context, groupID string) error

+ func (s *SQLiteStore) DeleteOAuthState(ctx context.Context, state string) error

+ func (s *SQLiteStore) DeleteOldJobs(ctx context.Context, olderThan time.Time) (int64, error)

+ func (s *SQLiteStore) DeleteRunner(ctx context.Context, id int64) error

+ func (s *SQLiteStore) DeleteSession(ctx context.Context, id string) error

+ func (s *SQLiteStore) DeleteStaleRunners(ctx context.Context, olderThan time.Time) error

+ func (s *SQLiteStore) DeleteUser(ctx context.Context, id string) error

+ func (s *SQLiteStore) DeleteUserSessions(ctx context.Context, userID string) error

+ func (s *SQLiteStore) GetAuthCode(ctx context.Context, code string) (*AuthCode, error)

+ func (s *SQLiteStore) GetGroup(ctx context.Context, id string) (*Group, error)

+ func (s *SQLiteStore) GetHistoryStats(ctx context.Context, opts HistoryStatsOpts) (*HistoryStatsResult, error)

+ func (s *SQLiteStore) GetHistoryTimeBounds(ctx context.Context, groupID string) (oldest, newest *time.Time, err error)

+ func (s *SQLiteStore) GetJob(ctx context.Context, id string) (*Job, error)

+ func (s *SQLiteStore) GetJobTemplate(ctx context.Context, id string) (*JobTemplate, error)

+ func (s *SQLiteStore) GetMaxPosition(ctx context.Context, groupID string) (int, error)

+ func (s *SQLiteStore) GetNextPendingJob(ctx context.Context, groupID string) (*Job, error)

+ func (s *SQLiteStore) GetOAuthState(ctx context.Context, state string) (*OAuthState, error)

+ func (s *SQLiteStore) GetRunner(ctx context.Context, id int64) (*Runner, error)

+ func (s *SQLiteStore) GetRunnerByName(ctx context.Context, name string) (*Runner, error)

+ func (s *SQLiteStore) GetSession(ctx context.Context, id string) (*Session, error)

+ func (s *SQLiteStore) GetSessionByToken(ctx context.Context, tokenHash string) (*Session, error)

+ func (s *SQLiteStore) GetUser(ctx context.Context, id string) (*User, error)

+ func (s *SQLiteStore) GetUserByGitHubID(ctx context.Context, githubID string) (*User, error)

+ func (s *SQLiteStore) GetUserByUsername(ctx context.Context, username string) (*User, error)

+ func (s *SQLiteStore) HasAnyJobs(ctx context.Context, templateID string) (bool, error)

+ func (s *SQLiteStore) ListAuditEntries(ctx context.Context, opts AuditQueryOpts) ([]*AuditEntry, int, error)

+ func (s *SQLiteStore) ListGroups(ctx context.Context) ([]*Group, error)

+ func (s *SQLiteStore) ListJobHistory(ctx context.Context, opts HistoryQueryOpts) (*HistoryResult, error)

+ func (s *SQLiteStore) ListJobTemplatesByGroup(ctx context.Context, groupID string) ([]*JobTemplate, error)

+ func (s *SQLiteStore) ListJobsByGroup(ctx context.Context, groupID string, statuses ...JobStatus) ([]*Job, error)

+ func (s *SQLiteStore) ListJobsByStatus(ctx context.Context, statuses ...JobStatus) ([]*Job, error)

+ func (s *SQLiteStore) ListRunners(ctx context.Context) ([]*Runner, error)

+ func (s *SQLiteStore) ListRunnersByLabels(ctx context.Context, labels []string) ([]*Runner, error)

+ func (s *SQLiteStore) Migrate(ctx context.Context) error

+ func (s *SQLiteStore) Ping(ctx context.Context) error

+ func (s *SQLiteStore) ReorderJobs(ctx context.Context, groupID string, jobIDs []string) error

+ func (s *SQLiteStore) Start(ctx context.Context) error

+ func (s *SQLiteStore) Stop() error

+ func (s *SQLiteStore) UpdateGroup(ctx context.Context, group *Group) error

+ func (s *SQLiteStore) UpdateJob(ctx context.Context, job *Job) error

+ func (s *SQLiteStore) UpdateJobTemplate(ctx context.Context, template *JobTemplate) error

+ func (s *SQLiteStore) UpdateTemplateInConfig(ctx context.Context, id string, inConfig bool) error

+ func (s *SQLiteStore) UpdateUser(ctx context.Context, user *User) error

+ func (s *SQLiteStore) UpsertRunner(ctx context.Context, runner *Runner) error

+ type Session struct

+ CreatedAt time.Time

+ ExpiresAt time.Time

+ ID string

+ TokenHash string

+ UserID string

+ type Store interface

+ CreateAuditEntry func(ctx context.Context, entry *AuditEntry) error

+ CreateAuthCode func(ctx context.Context, code *AuthCode) error

+ CreateGroup func(ctx context.Context, group *Group) error

+ CreateJob func(ctx context.Context, job *Job) error

+ CreateJobTemplate func(ctx context.Context, template *JobTemplate) error

+ CreateOAuthState func(ctx context.Context, state *OAuthState) error

+ CreateSession func(ctx context.Context, session *Session) error

+ CreateUser func(ctx context.Context, user *User) error

+ DeleteAuthCode func(ctx context.Context, code string) error

+ DeleteExpiredAuthCodes func(ctx context.Context) error

+ DeleteExpiredOAuthStates func(ctx context.Context) error

+ DeleteExpiredSessions func(ctx context.Context) error

+ DeleteGroup func(ctx context.Context, id string) error

+ DeleteJob func(ctx context.Context, id string) error

+ DeleteJobTemplate func(ctx context.Context, id string) error

+ DeleteJobTemplatesByGroup func(ctx context.Context, groupID string) error

+ DeleteOAuthState func(ctx context.Context, state string) error

+ DeleteOldJobs func(ctx context.Context, olderThan time.Time) (int64, error)

+ DeleteRunner func(ctx context.Context, id int64) error

+ DeleteSession func(ctx context.Context, id string) error

+ DeleteStaleRunners func(ctx context.Context, olderThan time.Time) error

+ DeleteUser func(ctx context.Context, id string) error

+ DeleteUserSessions func(ctx context.Context, userID string) error

+ GetAuthCode func(ctx context.Context, code string) (*AuthCode, error)

+ GetGroup func(ctx context.Context, id string) (*Group, error)

+ GetHistoryStats func(ctx context.Context, opts HistoryStatsOpts) (*HistoryStatsResult, error)

+ GetHistoryTimeBounds func(ctx context.Context, groupID string) (oldest, newest *time.Time, err error)

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

+ GetJobTemplate func(ctx context.Context, id string) (*JobTemplate, error)

+ GetMaxPosition func(ctx context.Context, groupID string) (int, error)

+ GetNextPendingJob func(ctx context.Context, groupID string) (*Job, error)

+ GetOAuthState func(ctx context.Context, state string) (*OAuthState, error)

+ GetRunner func(ctx context.Context, id int64) (*Runner, error)

+ GetRunnerByName func(ctx context.Context, name string) (*Runner, error)

+ GetSession func(ctx context.Context, id string) (*Session, error)

+ GetSessionByToken func(ctx context.Context, tokenHash string) (*Session, error)

+ GetUser func(ctx context.Context, id string) (*User, error)

+ GetUserByGitHubID func(ctx context.Context, githubID string) (*User, error)

+ GetUserByUsername func(ctx context.Context, username string) (*User, error)

+ HasAnyJobs func(ctx context.Context, templateID string) (bool, error)

+ ListAuditEntries func(ctx context.Context, opts AuditQueryOpts) ([]*AuditEntry, int, error)

+ ListGroups func(ctx context.Context) ([]*Group, error)

+ ListJobHistory func(ctx context.Context, opts HistoryQueryOpts) (*HistoryResult, error)

+ ListJobTemplatesByGroup func(ctx context.Context, groupID string) ([]*JobTemplate, error)

+ ListJobsByGroup func(ctx context.Context, groupID string, statuses ...JobStatus) ([]*Job, error)

+ ListJobsByStatus func(ctx context.Context, statuses ...JobStatus) ([]*Job, error)

+ ListRunners func(ctx context.Context) ([]*Runner, error)

+ ListRunnersByLabels func(ctx context.Context, labels []string) ([]*Runner, error)

+ Migrate func(ctx context.Context) error

+ Ping func(ctx context.Context) error

+ ReorderJobs func(ctx context.Context, groupID string, jobIDs []string) error

+ Start func(ctx context.Context) error

+ Stop func() error

+ UpdateGroup func(ctx context.Context, group *Group) error

+ UpdateJob func(ctx context.Context, job *Job) error

+ UpdateJobTemplate func(ctx context.Context, template *JobTemplate) error

+ UpdateTemplateInConfig func(ctx context.Context, id string, inConfig bool) error

+ UpdateUser func(ctx context.Context, user *User) error

+ UpsertRunner func(ctx context.Context, runner *Runner) error

+ func NewPostgresStore(log logrus.FieldLogger, dsn string) Store

+ func NewSQLiteStore(log logrus.FieldLogger, path string) Store

+ type User struct

+ AuthProvider AuthProvider

+ CreatedAt time.Time

+ GitHubID string

+ ID string

+ PasswordHash string

+ Role Role

+ UpdatedAt time.Time

+ Username string