persistence

type FetchParams struct {
	// History, when set to true, includes the transition history of the job in the fetched data.
	History bool
}

type FilterParams struct {
	// ClientID allows filtering jobs that belong to a specific client.
	// Only jobs with a matching client ID will be returned.
	ClientID *string
	// Group allows filtering jobs that belong to one of the specified groups.
	// The filter is an OR filter, meaning jobs that belong to any of the provided groups will be returned.
	Group []string
	// State allows filtering jobs based on their current state value.
	// Only jobs with a matching state will be returned.
	State *string
	// Workflow allows filtering jobs that are created from a specific workflow.
	// Only jobs with a matching workflow name will be returned.
	Workflow *string
	// Tags allows filtering jobs that contain one or more of the specified tags.
	// The filter is an OR filter, meaning jobs that contain any of the provided tags will be returned.
	Tags []string
}

type JobUpdate struct {
	// Status is the new job status. If provided, it replaces the existing status of the job.
	Status *api.JobStatus
	// Definition is the new job definition. If provided, it replaces the existing job definition.
	Definition *map[string]any
	// AddTags is a list of tags to be added to the job. If provided, these tags will be added to the existing tags.
	AddTags *[]string
	// DelTags is a list of tags to be removed from the job. If provided, these tags will be
	// removed from the job's existing tags. If a tag specified here does not exist in the
	// job's tags, it will be ignored.
	DelTags *[]string
}

type PaginationParams struct {
	// Offset is the number of items to skip before starting to collect results.
	Offset int64
	// Limit is the maximum number of items to return in the response.
	Limit int32
}

type SortParams struct {
	// Desc, when set to true, sorts the jobs in descending order based on their creation time.
	// When set to false, the jobs are sorted in ascending order.
	Desc bool
}

type Storage interface {
	// Initialize sets up the storage using the provided options string.
	Initialize(options string) error

	// Shutdown gracefully closes the storage connection.
	Shutdown()

	// CheckHealth examines the status of the storage, returning an error if the storage is not available.
	CheckHealth(ctx context.Context) error

	// CreateJob adds a new job to the storage.
	CreateJob(ctx context.Context, job *api.Job) (*api.Job, error)

	// GetJob retrieves an existing job identified by jobID from the storage.
	// If an issue occurs during the fetch operation, the method returns an error.
	GetJob(ctx context.Context, jobID string, fetchParams FetchParams) (*api.Job, error)

	// UpdateJob modifies an existing job in the storage based on the provided JobUpdate request.
	UpdateJob(ctx context.Context, job *api.Job, request JobUpdate) (*api.Job, error)

	// DeleteJob removes an existing job identified by jobID from the storage.
	DeleteJob(ctx context.Context, jobID string) error

	// QueryJobs retrieves jobs that satisfy the filterParams, sortParams, and paginationParams.
	QueryJobs(ctx context.Context, filterParams FilterParams, sortParams SortParams, paginationParams PaginationParams) (*api.PaginatedJobList, error)

	// CreateWorkflow adds a new workflow to the storage.
	CreateWorkflow(ctx context.Context, workflow *api.Workflow) (*api.Workflow, error)

	// GetWorkflow retrieves an existing workflow identified by name from the storage.
	// If an issue occurs during the fetch operation, the method returns an error.
	GetWorkflow(ctx context.Context, name string) (*api.Workflow, error)

	// DeleteWorkflow removes an existing workflow identified by name from the storage.
	DeleteWorkflow(ctx context.Context, name string) error

	// QueryWorkflows retrieves all workflows from the storage respecting the paginationParams.
	QueryWorkflows(ctx context.Context, sortParams SortParams, paginationParams PaginationParams) (*api.PaginatedWorkflowList, error)
}