intercept

Documentation

Index

• type Func
  • func (f Func) Intercept(next entities.Querier) entities.Querier
• type OrderFunc
  • func (f OrderFunc) Query(ctx context.Context, q entities.Query) (entities.Value, error)
• type OutboxFunc
  • func (f OutboxFunc) Query(ctx context.Context, q entities.Query) (entities.Value, error)
• type Query
  • func NewQuery(q entities.Query) (Query, error)
• type TraverseFunc
  • func (f TraverseFunc) Intercept(next entities.Querier) entities.Querier
  • func (f TraverseFunc) Traverse(ctx context.Context, q entities.Query) error
• type TraverseOrder
  • func (f TraverseOrder) Intercept(next entities.Querier) entities.Querier
  • func (f TraverseOrder) Traverse(ctx context.Context, q entities.Query) error
• type TraverseOutbox
  • func (f TraverseOutbox) Intercept(next entities.Querier) entities.Querier
  • func (f TraverseOutbox) Traverse(ctx context.Context, q entities.Query) error

Types

type Func

type Func func(context.Context, Query) error

The Func type is an adapter that allows ordinary functions to be used as interceptors. Unlike traversal functions, interceptors are skipped during graph traversals. Note that the implementation of Func is different from the one defined in entgo.io/ent.InterceptFunc.

func (Func) Intercept

func (f Func) Intercept(next entities.Querier) entities.Querier

Intercept calls f(ctx, q) and then applied the next Querier.

type OrderFunc

type OrderFunc func(context.Context, *entities.OrderQuery) (entities.Value, error)

The OrderFunc type is an adapter to allow the use of ordinary function as a Querier.

func (OrderFunc) Query

func (f OrderFunc) Query(ctx context.Context, q entities.Query) (entities.Value, error)

Query calls f(ctx, q).

type OutboxFunc

type OutboxFunc func(context.Context, *entities.OutboxQuery) (entities.Value, error)

The OutboxFunc type is an adapter to allow the use of ordinary function as a Querier.

func (OutboxFunc) Query

func (f OutboxFunc) Query(ctx context.Context, q entities.Query) (entities.Value, error)

Query calls f(ctx, q).

type Query

type Query interface {
	// Type returns the string representation of the query type.
	Type() string
	// Limit the number of records to be returned by this query.
	Limit(int)
	// Offset to start from.
	Offset(int)
	// Unique configures the query builder to filter duplicate records.
	Unique(bool)
	// Order specifies how the records should be ordered.
	Order(...entities.OrderFunc)
	// WhereP appends storage-level predicates to the query builder. Using this method, users
	// can use type-assertion to append predicates that do not depend on any generated package.
	WhereP(...func(*sql.Selector))
}

The Query interface represents an operation that queries a graph. By using this interface, users can write generic code that manipulates query builders of different types.

func NewQuery

func NewQuery(q entities.Query) (Query, error)

NewQuery returns the generic Query interface for the given typed query.

type TraverseFunc

type TraverseFunc func(context.Context, Query) error

The TraverseFunc type is an adapter to allow the use of ordinary function as Traverser. If f is a function with the appropriate signature, TraverseFunc(f) is a Traverser that calls f.

func (TraverseFunc) Intercept

func (f TraverseFunc) Intercept(next entities.Querier) entities.Querier

Intercept is a dummy implementation of Intercept that returns the next Querier in the pipeline.

func (TraverseFunc) Traverse

func (f TraverseFunc) Traverse(ctx context.Context, q entities.Query) error

Traverse calls f(ctx, q).

type TraverseOrder

type TraverseOrder func(context.Context, *entities.OrderQuery) error

The TraverseOrder type is an adapter to allow the use of ordinary function as Traverser.

func (TraverseOrder) Intercept

func (f TraverseOrder) Intercept(next entities.Querier) entities.Querier

Intercept is a dummy implementation of Intercept that returns the next Querier in the pipeline.

func (TraverseOrder) Traverse

func (f TraverseOrder) Traverse(ctx context.Context, q entities.Query) error

Traverse calls f(ctx, q).

type TraverseOutbox

type TraverseOutbox func(context.Context, *entities.OutboxQuery) error

The TraverseOutbox type is an adapter to allow the use of ordinary function as Traverser.

func (TraverseOutbox) Intercept

func (f TraverseOutbox) Intercept(next entities.Querier) entities.Querier

Intercept is a dummy implementation of Intercept that returns the next Querier in the pipeline.

func (TraverseOutbox) Traverse

func (f TraverseOutbox) Traverse(ctx context.Context, q entities.Query) error

Traverse calls f(ctx, q).