hook

Documentation

Index

• func FixedError(err error) db.Hook
• func If(hk db.Hook, cond Condition) db.Hook
• func On(hk db.Hook, op db.Op) db.Hook
• func Reject(op db.Op) db.Hook
• func Unless(hk db.Hook, op db.Op) db.Hook
• type BalanceSnapshotFunc
  • func (f BalanceSnapshotFunc) Mutate(ctx context.Context, m db.Mutation) (db.Value, error)
• type Chain
  • func NewChain(hooks ...db.Hook) Chain
  • func (c Chain) Append(hooks ...db.Hook) Chain
  • func (c Chain) Extend(chain Chain) Chain
  • func (c Chain) Hook() db.Hook
• type Condition
  • func And(first, second Condition, rest ...Condition) Condition
  • func HasAddedFields(field string, fields ...string) Condition
  • func HasClearedFields(field string, fields ...string) Condition
  • func HasFields(field string, fields ...string) Condition
  • func HasOp(op db.Op) Condition
  • func Not(cond Condition) Condition
  • func Or(first, second Condition, rest ...Condition) Condition
• type EntitlementFunc
  • func (f EntitlementFunc) Mutate(ctx context.Context, m db.Mutation) (db.Value, error)
• type FeatureFunc
  • func (f FeatureFunc) Mutate(ctx context.Context, m db.Mutation) (db.Value, error)
• type GrantFunc
  • func (f GrantFunc) Mutate(ctx context.Context, m db.Mutation) (db.Value, error)
• type NotificationChannelFunc
  • func (f NotificationChannelFunc) Mutate(ctx context.Context, m db.Mutation) (db.Value, error)
• type NotificationEventDeliveryStatusFunc
  • func (f NotificationEventDeliveryStatusFunc) Mutate(ctx context.Context, m db.Mutation) (db.Value, error)
• type NotificationEventFunc
  • func (f NotificationEventFunc) Mutate(ctx context.Context, m db.Mutation) (db.Value, error)
• type NotificationRuleFunc
  • func (f NotificationRuleFunc) Mutate(ctx context.Context, m db.Mutation) (db.Value, error)
• type UsageResetFunc
  • func (f UsageResetFunc) Mutate(ctx context.Context, m db.Mutation) (db.Value, error)

Functions

func FixedError

func FixedError(err error) db.Hook

FixedError is a hook returning a fixed error.

func If

func If(hk db.Hook, cond Condition) db.Hook

If executes the given hook under condition.

hook.If(ComputeAverage, And(HasFields(...), HasAddedFields(...)))

func On

func On(hk db.Hook, op db.Op) db.Hook

On executes the given hook only for the given operation.

hook.On(Log, db.Delete|db.Create)

func Reject

func Reject(op db.Op) db.Hook

Reject returns a hook that rejects all operations that match op.

func (T) Hooks() []db.Hook {
	return []db.Hook{
		Reject(db.Delete|db.Update),
	}
}

func Unless

func Unless(hk db.Hook, op db.Op) db.Hook

Unless skips the given hook only for the given operation.

hook.Unless(Log, db.Update|db.UpdateOne)

Types

type BalanceSnapshotFunc

type BalanceSnapshotFunc func(context.Context, *db.BalanceSnapshotMutation) (db.Value, error)

The BalanceSnapshotFunc type is an adapter to allow the use of ordinary function as BalanceSnapshot mutator.

func (BalanceSnapshotFunc) Mutate

func (f BalanceSnapshotFunc) Mutate(ctx context.Context, m db.Mutation) (db.Value, error)

Mutate calls f(ctx, m).

type Chain

type Chain struct {
	// contains filtered or unexported fields
}

Chain acts as a list of hooks and is effectively immutable. Once created, it will always hold the same set of hooks in the same order.

func NewChain

func NewChain(hooks ...db.Hook) Chain

NewChain creates a new chain of hooks.

func (Chain) Append

func (c Chain) Append(hooks ...db.Hook) Chain

Append extends a chain, adding the specified hook as the last ones in the mutation flow.

func (Chain) Extend

func (c Chain) Extend(chain Chain) Chain

Extend extends a chain, adding the specified chain as the last ones in the mutation flow.

func (Chain) Hook

func (c Chain) Hook() db.Hook

Hook chains the list of hooks and returns the final hook.

type Condition

type Condition func(context.Context, db.Mutation) bool

Condition is a hook condition function.

func And

func And(first, second Condition, rest ...Condition) Condition

And groups conditions with the AND operator.

func HasAddedFields

func HasAddedFields(field string, fields ...string) Condition

HasAddedFields is a condition validating `.AddedField` on fields.

func HasClearedFields

func HasClearedFields(field string, fields ...string) Condition

HasClearedFields is a condition validating `.FieldCleared` on fields.

func HasFields

func HasFields(field string, fields ...string) Condition

HasFields is a condition validating `.Field` on fields.

func HasOp

func HasOp(op db.Op) Condition

HasOp is a condition testing mutation operation.

func Not

func Not(cond Condition) Condition

Not negates a given condition.

func Or

func Or(first, second Condition, rest ...Condition) Condition

Or groups conditions with the OR operator.

type EntitlementFunc

type EntitlementFunc func(context.Context, *db.EntitlementMutation) (db.Value, error)

The EntitlementFunc type is an adapter to allow the use of ordinary function as Entitlement mutator.

func (EntitlementFunc) Mutate

func (f EntitlementFunc) Mutate(ctx context.Context, m db.Mutation) (db.Value, error)

Mutate calls f(ctx, m).

type FeatureFunc

type FeatureFunc func(context.Context, *db.FeatureMutation) (db.Value, error)

The FeatureFunc type is an adapter to allow the use of ordinary function as Feature mutator.

func (FeatureFunc) Mutate

func (f FeatureFunc) Mutate(ctx context.Context, m db.Mutation) (db.Value, error)

Mutate calls f(ctx, m).

type GrantFunc

type GrantFunc func(context.Context, *db.GrantMutation) (db.Value, error)

The GrantFunc type is an adapter to allow the use of ordinary function as Grant mutator.

func (GrantFunc) Mutate

func (f GrantFunc) Mutate(ctx context.Context, m db.Mutation) (db.Value, error)

Mutate calls f(ctx, m).

type NotificationChannelFunc

type NotificationChannelFunc func(context.Context, *db.NotificationChannelMutation) (db.Value, error)

The NotificationChannelFunc type is an adapter to allow the use of ordinary function as NotificationChannel mutator.

func (NotificationChannelFunc) Mutate

func (f NotificationChannelFunc) Mutate(ctx context.Context, m db.Mutation) (db.Value, error)

Mutate calls f(ctx, m).

type NotificationEventDeliveryStatusFunc

type NotificationEventDeliveryStatusFunc func(context.Context, *db.NotificationEventDeliveryStatusMutation) (db.Value, error)

The NotificationEventDeliveryStatusFunc type is an adapter to allow the use of ordinary function as NotificationEventDeliveryStatus mutator.

func (NotificationEventDeliveryStatusFunc) Mutate

func (f NotificationEventDeliveryStatusFunc) Mutate(ctx context.Context, m db.Mutation) (db.Value, error)

Mutate calls f(ctx, m).

type NotificationEventFunc

type NotificationEventFunc func(context.Context, *db.NotificationEventMutation) (db.Value, error)

The NotificationEventFunc type is an adapter to allow the use of ordinary function as NotificationEvent mutator.

func (NotificationEventFunc) Mutate

func (f NotificationEventFunc) Mutate(ctx context.Context, m db.Mutation) (db.Value, error)

Mutate calls f(ctx, m).

type NotificationRuleFunc

type NotificationRuleFunc func(context.Context, *db.NotificationRuleMutation) (db.Value, error)

The NotificationRuleFunc type is an adapter to allow the use of ordinary function as NotificationRule mutator.

func (NotificationRuleFunc) Mutate

func (f NotificationRuleFunc) Mutate(ctx context.Context, m db.Mutation) (db.Value, error)

Mutate calls f(ctx, m).

type UsageResetFunc

type UsageResetFunc func(context.Context, *db.UsageResetMutation) (db.Value, error)

The UsageResetFunc type is an adapter to allow the use of ordinary function as UsageReset mutator.

func (UsageResetFunc) Mutate

func (f UsageResetFunc) Mutate(ctx context.Context, m db.Mutation) (db.Value, error)

Mutate calls f(ctx, m).