Documentation
¶
Index ¶
- Constants
- type Engine
- func (e *Engine) CleanSteps(ctx context.Context, msg string, before int64) (int64, error)
- func (e *Engine) CountSteps(ctx context.Context) (int64, error)
- func (e *Engine) CountStepsForBuild(ctx context.Context, b *api.Build, filters map[string]interface{}) (int64, error)
- func (e *Engine) CreateStep(ctx context.Context, s *api.Step) (*api.Step, error)
- func (e *Engine) CreateStepTable(ctx context.Context, driver string) error
- func (e *Engine) DeleteStep(ctx context.Context, s *api.Step) error
- func (e *Engine) GetStep(ctx context.Context, id int64) (*api.Step, error)
- func (e *Engine) GetStepForBuild(ctx context.Context, b *api.Build, number int32) (*api.Step, error)
- func (e *Engine) ListStepImageCount(ctx context.Context) (map[string]float64, error)
- func (e *Engine) ListStepStatusCount(ctx context.Context) (map[string]float64, error)
- func (e *Engine) ListSteps(ctx context.Context) ([]*api.Step, error)
- func (e *Engine) ListStepsForBuild(ctx context.Context, b *api.Build, filters map[string]interface{}, page int, ...) ([]*api.Step, error)
- func (e *Engine) UpdateStep(ctx context.Context, s *api.Step) (*api.Step, error)
- type EngineOpt
- type StepInterface
Constants ¶
const ( // CreatePostgresTable represents a query to create the Postgres steps table. CreatePostgresTable = `` /* 527-byte string literal not displayed */ // CreateSqliteTable represents a query to create the Sqlite steps table. CreateSqliteTable = `` /* 472-byte string literal not displayed */ )
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Engine ¶ added in v0.27.0
type Engine struct {
// contains filtered or unexported fields
}
Engine represents the step functionality that implements the StepInterface interface.
func (*Engine) CleanSteps ¶ added in v0.27.0
CleanSteps updates steps to an error with a created timestamp prior to a defined moment.
func (*Engine) CountSteps ¶ added in v0.27.0
CountSteps gets the count of all steps from the database.
func (*Engine) CountStepsForBuild ¶ added in v0.27.0
func (e *Engine) CountStepsForBuild(ctx context.Context, b *api.Build, filters map[string]interface{}) (int64, error)
CountStepsForBuild gets the count of steps by build ID from the database.
func (*Engine) CreateStep ¶ added in v0.27.0
CreateStep creates a new step in the database.
func (*Engine) CreateStepTable ¶ added in v0.27.0
CreateStepTable creates the steps table in the database.
func (*Engine) DeleteStep ¶ added in v0.27.0
DeleteStep deletes an existing step from the database.
func (*Engine) GetStepForBuild ¶ added in v0.27.0
func (e *Engine) GetStepForBuild(ctx context.Context, b *api.Build, number int32) (*api.Step, error)
GetStepForBuild gets a step by number and build ID from the database.
func (*Engine) ListStepImageCount ¶ added in v0.27.0
ListStepImageCount gets a list of all step images and the count of their occurrence from the database.
func (*Engine) ListStepStatusCount ¶ added in v0.27.0
ListStepStatusCount gets a list of all step statuses and the count of their occurrence from the database.
type EngineOpt ¶
EngineOpt represents a configuration option to initialize the database engine for Steps.
func WithClient ¶
WithClient sets the gorm.io/gorm client in the database engine for Steps.
func WithContext ¶ added in v0.23.0
WithContext sets the context in the database engine for Steps.
func WithLogger ¶
WithLogger sets the github.com/sirupsen/logrus logger in the database engine for Steps.
func WithSkipCreation ¶
WithSkipCreation sets the skip creation logic in the database engine for Steps.
type StepInterface ¶ added in v0.20.0
type StepInterface interface {
// CreateStepTable defines a function that creates the steps table.
CreateStepTable(context.Context, string) error
// CleanSteps defines a function that sets running or pending steps to error status before a given created time.
CleanSteps(context.Context, string, int64) (int64, error)
// CountSteps defines a function that gets the count of all steps.
CountSteps(context.Context) (int64, error)
// CountStepsForBuild defines a function that gets the count of steps by build ID.
CountStepsForBuild(context.Context, *api.Build, map[string]interface{}) (int64, error)
// CreateStep defines a function that creates a new step.
CreateStep(context.Context, *api.Step) (*api.Step, error)
// DeleteStep defines a function that deletes an existing step.
DeleteStep(context.Context, *api.Step) error
// GetStep defines a function that gets a step by ID.
GetStep(context.Context, int64) (*api.Step, error)
// GetStepForBuild defines a function that gets a step by number and build ID.
GetStepForBuild(context.Context, *api.Build, int32) (*api.Step, error)
// ListSteps defines a function that gets a list of all steps.
ListSteps(ctx context.Context) ([]*api.Step, error)
// ListStepsForBuild defines a function that gets a list of steps by build ID.
ListStepsForBuild(context.Context, *api.Build, map[string]interface{}, int, int) ([]*api.Step, error)
// ListStepImageCount defines a function that gets a list of all step images and the count of their occurrence.
ListStepImageCount(context.Context) (map[string]float64, error)
// ListStepStatusCount defines a function that gets a list of all step statuses and the count of their occurrence.
ListStepStatusCount(context.Context) (map[string]float64, error)
// UpdateStep defines a function that updates an existing step.
UpdateStep(context.Context, *api.Step) (*api.Step, error)
}