hook

package
v0.27.2 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 17, 2025 License: Apache-2.0 Imports: 8 Imported by: 0

Documentation

Index

Constants

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

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

)
View Source
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);
`
)

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 hook functionality that implements the HookInterface interface.

func New

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

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

func (*Engine) CountHooks added in v0.27.0

func (e *Engine) CountHooks(ctx context.Context) (int64, error)

CountHooks gets the count of all hooks from the database.

func (*Engine) CountHooksForRepo added in v0.27.0

func (e *Engine) CountHooksForRepo(ctx context.Context, r *api.Repo) (int64, error)

CountHooksForRepo gets the count of hooks by repo ID from the database.

func (*Engine) CreateHook added in v0.27.0

func (e *Engine) CreateHook(ctx context.Context, h *api.Hook) (*api.Hook, error)

CreateHook creates a new hook in the database.

func (*Engine) CreateHookIndexes added in v0.27.0

func (e *Engine) CreateHookIndexes(ctx context.Context) error

CreateHookIndexes creates the indexes for the hooks table in the database.

func (*Engine) CreateHookTable added in v0.27.0

func (e *Engine) CreateHookTable(ctx context.Context, driver string) error

CreateHookTable creates the hooks table in the database.

func (*Engine) DeleteHook added in v0.27.0

func (e *Engine) DeleteHook(ctx context.Context, h *api.Hook) error

DeleteHook deletes an existing hook from the database.

func (*Engine) GetHook added in v0.27.0

func (e *Engine) GetHook(ctx context.Context, id int64) (*api.Hook, error)

GetHook gets a hook by ID from the database.

func (*Engine) GetHookByWebhookID added in v0.27.0

func (e *Engine) GetHookByWebhookID(ctx context.Context, webhookID int64) (*api.Hook, error)

GetHookByWebhookID gets a single hook with a matching webhook id in the database.

func (*Engine) GetHookForRepo added in v0.27.0

func (e *Engine) GetHookForRepo(ctx context.Context, r *api.Repo, number int64) (*api.Hook, error)

GetHookForRepo gets a hook by repo ID and number from the database.

func (*Engine) LastHookForRepo added in v0.27.0

func (e *Engine) LastHookForRepo(ctx context.Context, r *api.Repo) (*api.Hook, error)

LastHookForRepo gets the last hook by repo ID from the database.

func (*Engine) ListHooks added in v0.27.0

func (e *Engine) ListHooks(ctx context.Context) ([]*api.Hook, error)

ListHooks gets a list of all hooks from the database.

func (*Engine) ListHooksForRepo added in v0.27.0

func (e *Engine) ListHooksForRepo(ctx context.Context, r *api.Repo, page, perPage int) ([]*api.Hook, error)

ListHooksForRepo gets a list of hooks by repo ID from the database.

func (*Engine) UpdateHook added in v0.27.0

func (e *Engine) UpdateHook(ctx context.Context, h *api.Hook) (*api.Hook, error)

UpdateHook updates an existing hook in the database.

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 WithContext added in v0.21.0

func WithContext(ctx context.Context) EngineOpt

WithContext sets the context in the database engine for Repos.

func WithEncryptionKey added in v0.25.0

func WithEncryptionKey(key string) EngineOpt

WithEncryptionKey sets the encryption key in the database engine for Builds.

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 HookInterface added in v0.20.0

type HookInterface interface {

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

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

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL