Documentation
¶
Index ¶
- type Mongo
- func (m *Mongo) Checker(ctx context.Context, state *healthcheck.CheckState) error
- func (m *Mongo) ClaimJob(ctx context.Context, pendingState, activeState domain.State) (*domain.Job, error)
- func (m *Mongo) ClaimTask(ctx context.Context, pendingState, activeState domain.State) (*domain.Task, error)
- func (m *Mongo) Close(ctx context.Context) error
- func (m *Mongo) CountEventsByJobNumber(ctx context.Context, jobNumber int) (int, error)
- func (m *Mongo) CountTasksByJobNumber(ctx context.Context, jobNumber int) (int, error)
- func (m *Mongo) CreateEvent(ctx context.Context, event *domain.Event) error
- func (m *Mongo) CreateJob(ctx context.Context, job *domain.Job) error
- func (m *Mongo) CreateTask(ctx context.Context, task *domain.Task) error
- func (m *Mongo) GetJob(ctx context.Context, jobNumber int) (*domain.Job, error)
- func (m *Mongo) GetJobEvents(ctx context.Context, jobNumber, limit, offset int) ([]*domain.Event, int, error)
- func (m *Mongo) GetJobTasks(ctx context.Context, stateFilter []domain.State, jobNumber, limit, offset int) ([]*domain.Task, int, error)
- func (m *Mongo) GetJobs(ctx context.Context, field sort.SortParameterField, ...) ([]*domain.Job, int, error)
- func (m *Mongo) GetJobsByConfig(ctx context.Context, jc *domain.JobConfig, limit, offset int) ([]*domain.Job, error)
- func (m *Mongo) GetJobsByConfigAndState(ctx context.Context, jc *domain.JobConfig, stateFilter []domain.State, ...) ([]*domain.Job, error)
- func (m *Mongo) GetJobsByState(ctx context.Context, states []domain.State, limit, offset int) ([]*domain.Job, int, error)
- func (m *Mongo) GetNextJobNumberCounter(ctx context.Context) (*domain.Counter, error)
- func (m *Mongo) GetTask(ctx context.Context, taskID string) (*domain.Task, error)
- func (m *Mongo) Init(ctx context.Context) (err error)
- func (m *Mongo) UpdateJob(ctx context.Context, job *domain.Job) error
- func (m *Mongo) UpdateJobState(ctx context.Context, jobID string, newState domain.State, ...) error
- func (m *Mongo) UpdateTask(ctx context.Context, task *domain.Task) error
- func (m *Mongo) UpdateTaskState(ctx context.Context, taskID string, newState domain.State, ...) error
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Mongo ¶
type Mongo struct {
config.MongoConfig
Connection *mongodriver.MongoConnection
// contains filtered or unexported fields
}
Mongo represents a mongo connection and health client
func (*Mongo) Checker ¶
func (m *Mongo) Checker(ctx context.Context, state *healthcheck.CheckState) error
Checker is called by the healthcheck library to check the health state of this mongoDB instance
func (*Mongo) ClaimJob ¶ added in v0.15.0
func (m *Mongo) ClaimJob(ctx context.Context, pendingState, activeState domain.State) (*domain.Job, error)
ClaimJob claims a pending job for processing.
func (*Mongo) ClaimTask ¶ added in v0.15.0
func (m *Mongo) ClaimTask(ctx context.Context, pendingState, activeState domain.State) (*domain.Task, error)
ClaimTask claims a pending task for processing.
func (*Mongo) CountEventsByJobNumber ¶ added in v0.19.0
CountEventsByJobNumber returns the total count of events for a job.
func (*Mongo) CountTasksByJobNumber ¶ added in v0.19.0
CountTasksByJobNumber returns the total count of tasks for a job.
func (*Mongo) CreateEvent ¶
CreateEvent creates a new event in the database.
func (*Mongo) CreateTask ¶ added in v0.12.0
CreateTask creates a new migration task.
func (*Mongo) GetJobEvents ¶ added in v0.12.0
func (m *Mongo) GetJobEvents(ctx context.Context, jobNumber, limit, offset int) ([]*domain.Event, int, error)
GetJobEvents retrieves a list of migration events for a job with pagination.
func (*Mongo) GetJobTasks ¶ added in v0.11.0
func (m *Mongo) GetJobTasks(ctx context.Context, stateFilter []domain.State, jobNumber, limit, offset int) ([]*domain.Task, int, error)
GetJobTasks retrieves a list of migration tasks for a job with pagination.
func (*Mongo) GetJobs ¶ added in v0.10.0
func (m *Mongo) GetJobs(ctx context.Context, field sort.SortParameterField, direction sort.SortParameterDirection, stateFilter []domain.State, limit, offset int) ([]*domain.Job, int, error)
GetJobs retrieves a list of migration jobs with pagination.
func (*Mongo) GetJobsByConfig ¶ added in v0.7.0
func (m *Mongo) GetJobsByConfig(ctx context.Context, jc *domain.JobConfig, limit, offset int) ([]*domain.Job, error)
GetJobsByConfig retrieves jobs based on the provided job configuration.
func (*Mongo) GetJobsByConfigAndState ¶ added in v0.7.0
func (m *Mongo) GetJobsByConfigAndState(ctx context.Context, jc *domain.JobConfig, stateFilter []domain.State, limit, offset int) ([]*domain.Job, error)
GetJobsByConfigAndState retrieves jobs based on the provided job configuration and states.
func (*Mongo) GetJobsByState ¶ added in v0.15.0
func (m *Mongo) GetJobsByState(ctx context.Context, states []domain.State, limit, offset int) ([]*domain.Job, int, error)
GetJobsByState retrieves a list of migration jobs filtered by their states.
func (*Mongo) GetNextJobNumberCounter ¶ added in v0.19.0
GetNextJobNumberCounter increments the job number counter, in mongoDB, and then returns it
func (*Mongo) Init ¶
Init returns an initialised Mongo object encapsulating a connection to the mongo server/cluster with the given configuration, and a health client to check the health of the mongo server/cluster
func (*Mongo) UpdateJobState ¶ added in v0.20.0
func (m *Mongo) UpdateJobState(ctx context.Context, jobID string, newState domain.State, lastUpdated time.Time) error
UpdateJobState updates the state of a job and returns the updated job.
func (*Mongo) UpdateTask ¶ added in v0.15.0
UpdateTask updates an existing migration task.
Source Files