dataoperation

Documentation

Index

• type OperationInterface
• type OperationType
• type ReconcileRequestContext

Types

type OperationInterface

type OperationInterface interface {
	// GetTargetDataset get the target dataset of the data operation
	GetTargetDataset(object client.Object) (*datav1alpha1.Dataset, error)

	// GetReleaseNameSpacedName get the installed helm chart name
	GetReleaseNameSpacedName(object client.Object) types.NamespacedName

	// GetChartsDirectory get the helm charts directory of data operation
	GetChartsDirectory() string

	// GetOperationType get the data operation type and also used as a lock key for dataset
	GetOperationType() OperationType

	// UpdateOperationApiStatus update the data operation status, object is the data operation crd instance.
	UpdateOperationApiStatus(object client.Object, opStatus *datav1alpha1.OperationStatus) error

	// Validate check the data operation spec is valid or not, if not valid return error with conditions
	Validate(ctx runtime.ReconcileRequestContext, object client.Object) ([]datav1alpha1.Condition, error)

	// UpdateStatusInfoForCompleted update the status infos field for phase completed, the parameter infos is not nil
	UpdateStatusInfoForCompleted(object client.Object, infos map[string]string) error

	// UpdateStatusByHelmStatus update the operation status according to helm job status
	UpdateStatusByHelmStatus(ctx runtime.ReconcileRequestContext, object client.Object, opStatus *datav1alpha1.OperationStatus) error

	// SetTargetDatasetStatusInProgress set the dataset status for certain field when data operation executing.
	SetTargetDatasetStatusInProgress(dataset *datav1alpha1.Dataset)

	// RemoveTargetDatasetStatusInProgress remove the dataset status for certain field when data operation finished.
	RemoveTargetDatasetStatusInProgress(dataset *datav1alpha1.Dataset)
}

OperationInterface the interface of data operation crd

type OperationType

type OperationType string

const (
	DataLoad    OperationType = "DataLoad"
	DataBackup  OperationType = "DataBackup"
	DataMigrate OperationType = "DataMigrate"
)

type ReconcileRequestContext

type ReconcileRequestContext struct {
	// used for create engine
	cruntime.ReconcileRequestContext

	// object for dataset operation
	DataObject          client.Object
	OpStatus            *v1alpha1.OperationStatus
	DataOpFinalizerName string
}

ReconcileRequestContext loads or applys the configuration state of a service.