hook

Documentation

Index

• Constants
• func New(opts ...EngineOpt) (*engine, error)
• type EngineOpt
  • func WithClient(client *gorm.DB) EngineOpt
  • func WithLogger(logger *logrus.Entry) EngineOpt
  • func WithSkipCreation(skipCreation bool) EngineOpt
• type HookService

Constants

const (
	// CreatePostgresTable represents a query to create the Postgres hooks table.
	CreatePostgresTable = `` /* 438-byte string literal not displayed */

	// CreateSqliteTable represents a query to create the Sqlite hooks table.
	CreateSqliteTable = `` /* 390-byte string literal not displayed */

)

const (
	// CreateRepoIDIndex represents a query to create an
	// index on the hooks table for the repo_id column.
	CreateRepoIDIndex = `
CREATE INDEX
IF NOT EXISTS
hooks_repo_id
ON hooks (repo_id);
`
)

Functions

func New

func New(opts ...EngineOpt) (*engine, error)

New creates and returns a Vela service for integrating with hooks in the database.

Types

type EngineOpt

type EngineOpt func(*engine) error

EngineOpt represents a configuration option to initialize the database engine for Hooks.

func WithClient

func WithClient(client *gorm.DB) EngineOpt

WithClient sets the gorm.io/gorm client in the database engine for Hooks.

func WithLogger

func WithLogger(logger *logrus.Entry) EngineOpt

WithLogger sets the github.com/sirupsen/logrus logger in the database engine for Hooks.

func WithSkipCreation

func WithSkipCreation(skipCreation bool) EngineOpt

WithSkipCreation sets the skip creation logic in the database engine for Hooks.

type HookService

type HookService interface {

	// CreateHookIndexes defines a function that creates the indexes for the hooks table.
	CreateHookIndexes() error
	// CreateHookTable defines a function that creates the hooks table.
	CreateHookTable(string) error

	// CountHooks defines a function that gets the count of all hooks.
	CountHooks() (int64, error)
	// CountHooksForRepo defines a function that gets the count of hooks by repo ID.
	CountHooksForRepo(*library.Repo) (int64, error)
	// CreateHook defines a function that creates a new hook.
	CreateHook(*library.Hook) error
	// DeleteHook defines a function that deletes an existing hook.
	DeleteHook(*library.Hook) error
	// GetHook defines a function that gets a hook by ID.
	GetHook(int64) (*library.Hook, error)
	// GetHookForRepo defines a function that gets a hook by repo ID and number.
	GetHookForRepo(*library.Repo, int) (*library.Hook, error)
	// LastHookForRepo defines a function that gets the last hook by repo ID.
	LastHookForRepo(*library.Repo) (*library.Hook, error)
	// ListHooks defines a function that gets a list of all hooks.
	ListHooks() ([]*library.Hook, error)
	// ListHooksForRepo defines a function that gets a list of hooks by repo ID.
	ListHooksForRepo(*library.Repo, int, int) ([]*library.Hook, int64, error)
	// UpdateHook defines a function that updates an existing hook.
	UpdateHook(*library.Hook) error
}

HookService represents the Vela interface for hook functions with the supported Database backends.