database

Documentation

Index

• type ComputeService
• type DBService
  • func NewDBService(uri string) (DBService, error)
• type DatasetService
• type DesignService
• type JobService
• type TaskService

Types

type ComputeService

type ComputeService interface {
	// RegisterCompute registers a compute given a openapi.ComputeSpec
	RegisterCompute(openapi.ComputeSpec) (openapi.ComputeStatus, error)

	// GetComputeIdsByRegion gets all the compute Ids associated with a region
	GetComputeIdsByRegion(string) ([]string, error)

	// GetComputeById gets the compute info given the compute Id
	GetComputeById(string) (openapi.ComputeSpec, error)

	// UpdateDeploymentStatus updates the deployment status given the compute Id, job Id and agentStatuses map
	UpdateDeploymentStatus(computeId string, jobId string, agentStatuses map[string]openapi.AgentState) error
}

ComputeService is an interface that defines a collection of APIs related to computes

type DBService

type DBService interface {
	DatasetService
	DesignService
	JobService
	TaskService
	ComputeService
}

DBService defines a total set of collections for the application

func NewDBService

func NewDBService(uri string) (DBService, error)

type DatasetService

type DatasetService interface {
	// CreateDataset creates a new dataset in the db
	CreateDataset(userId string, info openapi.DatasetInfo) (string, error)

	// GetDatasets returns a list of datasets associated with a user
	GetDatasets(userId string, limit int32) ([]openapi.DatasetInfo, error)

	// GetDatasetById returns the details of a particular dataset
	GetDatasetById(string) (openapi.DatasetInfo, error)
}

DatasetService is an interface that defines a collection of APIs related to dataset

type DesignService

type DesignService interface {
	// CreateDesign adds a design to the db
	CreateDesign(userId string, info openapi.Design) error

	// GetDesign returns a design associated with the given user and design ids
	GetDesign(userId string, designId string) (openapi.Design, error)

	// DeleteDesign deletes the design from the db
	DeleteDesign(userId string, designId string) error

	// GetDesigns returns a list of designs associated with a user
	GetDesigns(userId string, limit int32) ([]openapi.DesignInfo, error)

	// CreateDesignSchema adds a schema for a design to the db
	CreateDesignSchema(userId string, designId string, info openapi.DesignSchema) error

	// GetDesignSchema returns the schema of a design from the db
	GetDesignSchema(userId string, designId string) (openapi.DesignSchema, error)

	// UpdateDesignSchema updates a schema for a design in the db
	UpdateDesignSchema(userId string, designId string, info openapi.DesignSchema) error

	// DeleteDesignSchema deletes the schema of a design from the db
	DeleteDesignSchema(userId string, designId string) error

	// CreateDesignCode adds the code of a design to the db
	CreateDesignCode(userId string, designId string, fileName string, fileData *os.File) error

	// GetDesignCode retrieves the code of a design from the db
	GetDesignCode(userId string, designId string) ([]byte, error)

	// DeleteDesignCode deletes the code of a design from the db
	DeleteDesignCode(userId string, designId string) error

	GetDesignCodeRevision(userId string, designId string) (openapi.CodeApiResponse, error)
}

DesignService is an interface that defines a collection of APIs related to design

type JobService

type JobService interface {
	// CreateJob creates a new job
	CreateJob(userId string, spec openapi.JobSpec) (openapi.JobStatus, error)

	// DeleteJob deletes a given job
	DeleteJob(userId string, jobId string) error

	// GetJob gets the job associated with the provided jobId
	GetJob(userId string, jobId string) (openapi.JobSpec, error)

	// GetJobById gets the job associated with the provided jobId
	GetJobById(jobId string) (openapi.JobSpec, error)

	// GetJobStatus get the status of a job
	GetJobStatus(userId string, jobId string) (openapi.JobStatus, error)

	// GetJobs returns the list of jobs associated with a user
	GetJobs(userId string, limit int32) ([]openapi.JobStatus, error)

	// GetJobsByCompute returns the list of jobs for a given computeId that have not been finished yet
	GetJobsByCompute(computeId string) ([]openapi.JobStatus, error)

	// UpdateJob updates the job with the given jobId
	UpdateJob(userId string, jobId string, spec openapi.JobSpec) error

	// UpdateJobStatus updates the status of a job given the user Id, job Id and the openapi.JobStatus
	UpdateJobStatus(userId string, jobId string, status openapi.JobStatus) error

	// GetTaskInfo gets the information of a task given the user Id, job Id and task Id
	GetTaskInfo(string, string, string) (openapi.TaskInfo, error)

	// GetTasksInfo gets the information of tasks given the user Id, job Id and a limit
	GetTasksInfo(string, string, int32, bool) ([]openapi.TaskInfo, error)

	// GetTasksInfoGeneric gets the information of tasks given the user Id, job Id, limit and an option to include completed tasks
	GetTasksInfoGeneric(string, string, int32, bool, bool) ([]openapi.TaskInfo, error)
}

JobService is an interface that defines a collection of APIs related to job

type TaskService

type TaskService interface {
	// CreateTasks creates tasks given a set of objects.Task and a flag
	CreateTasks([]objects.Task, bool) error

	// DeleteTasks deletes tasks given the job Id and a flag
	DeleteTasks(string, bool) error

	// GetTask gets the task given the user Id, job Id and task Id
	GetTask(string, string, string) (map[string][]byte, error)

	// IsOneTaskInState evaluates if one of the task is in a certain state given the job Id
	IsOneTaskInState(string, openapi.JobState) bool

	// IsOneTaskInStateWithRole evaluates if one of the tasks is in a certain state and with a specific role given the job Id
	IsOneTaskInStateWithRole(string, openapi.JobState, string) bool

	// MonitorTasks monitors the tasks and returns a TaskInfo channel
	MonitorTasks(string) (chan openapi.TaskInfo, chan error, context.CancelFunc, error)

	// SetTaskDirtyFlag sets the dirty flag for tasks given the job Id and a flag
	SetTaskDirtyFlag(jobId string, dirty bool) error

	// UpdateTaskStateByFilter updates the state of the task using a filter
	UpdateTaskStateByFilter(jobId string, newState openapi.JobState, userFilter map[string]interface{}) error

	// UpdateTaskStatus updates the status of a task given the user Id, job Id, and openapi.TaskStatus
	UpdateTaskStatus(jobId string, taskId string, taskStatus openapi.TaskStatus) error
}

TaskService is an interface that defines a collection of APIs related to task