store

Documentation

Index

• Variables
• type Job
  • func (j *Job) MutateMessage(mutateFn func(j *v1.Job)) error
  • func (j *Job) V1Job() (*v1.Job, error)
• type JobState
• type S
  • func New(db *gorm.DB) *S
  • func NewTest(t *testing.T) (*S, func())
  • func (s *S) AutoMigrate() error
  • func (s *S) CreateJob(job *Job) error
  • func (s *S) GetJobByJobID(jobID string) (*Job, error)
  • func (s *S) ListJobsByTenantID(tenantID string) ([]*Job, error)
  • func (s *S) ListQueuedJobs() ([]*Job, error)
  • func (s *S) ListQueuedJobsByTenantID(tenantID string) ([]*Job, error)
  • func (s *S) UpdateJobState(jobID string, currentVersion int, newState JobState) error
  • func (s *S) UpdateJobStateAndMessage(jobID string, currentVersion int, newState JobState, message []byte) error
  • func (s *S) UpdateOutputModelID(jobID string, currentVersion int, outputModelID string) error

Variables

var (
	// ErrConcurrentUpdate is returned when there is a concurrent update.
	ErrConcurrentUpdate = fmt.Errorf("store: concurrent update")
)

Types

type Job

type Job struct {
	gorm.Model

	JobID string `gorm:"uniqueIndex:idx_job_job_id"`

	// Message is the marshaled proto message of v1.Job.
	Message []byte

	// Suffix is a string that will be added to a fine-tuned model name.
	Suffix string

	State    JobState `gorm:"index:idx_job_state_tenant_id"`
	TenantID string   `gorm:"index:idx_job_state_tenant_id"`

	// OutputModelID is the ID of a generated model.
	OutputModelID string

	Version int
}

Job represents a job.

func (*Job) MutateMessage

func (j *Job) MutateMessage(mutateFn func(j *v1.Job)) error

MutateMessage mutates the message field of a job.

func (*Job) V1Job

func (j *Job) V1Job() (*v1.Job, error)

V1Job converts a job to v1.Job.

type JobState

type JobState string

JobState represents the state of a job.

const (
	// JobStateQueued represents the pending state.
	JobStateQueued JobState = "queued"
	// JobStateRunning represents the running state.
	JobStateRunning JobState = "running"
	// JobStatusFailed represents the failed state.
	JobStatusFailed JobState = "failed"
	// JobStateSucceeded represents the succeeded state.
	JobStateSucceeded JobState = "succeeded"
	// JobStateCancelled represents the cancelled state.
	JobStateCancelled JobState = "cancelled"
)

type S

type S struct {
	// contains filtered or unexported fields
}

S represents the data store.

func New

func New(db *gorm.DB) *S

New creates a new store instance.

func NewTest

func NewTest(t *testing.T) (*S, func())

NewTest returns a new test store.

func (*S) AutoMigrate

func (s *S) AutoMigrate() error

AutoMigrate sets up the auto-migration task of the database.

func (*S) CreateJob

func (s *S) CreateJob(job *Job) error

CreateJob creates a new job.

func (*S) GetJobByJobID

func (s *S) GetJobByJobID(jobID string) (*Job, error)

GetJobByJobID gets a job.

func (*S) ListJobsByTenantID

func (s *S) ListJobsByTenantID(tenantID string) ([]*Job, error)

ListJobsByTenantID finds jobs.

func (*S) ListQueuedJobs

func (s *S) ListQueuedJobs() ([]*Job, error)

ListQueuedJobs finds queued jobs.

func (*S) ListQueuedJobsByTenantID

func (s *S) ListQueuedJobsByTenantID(tenantID string) ([]*Job, error)

ListQueuedJobsByTenantID finds queued jobs.

func (*S) UpdateJobState

func (s *S) UpdateJobState(jobID string, currentVersion int, newState JobState) error

UpdateJobState updates a job.

func (*S) UpdateJobStateAndMessage

func (s *S) UpdateJobStateAndMessage(jobID string, currentVersion int, newState JobState, message []byte) error

UpdateJobStateAndMessage updates a job state and message.

func (*S) UpdateOutputModelID

func (s *S) UpdateOutputModelID(jobID string, currentVersion int, outputModelID string) error

UpdateOutputModelID updates the output model ID.