Instance Method

join(from:parent:method:)

This will join a foreign table based on a @OptionalParent relation

@discardableResult func join<From, To>(from model: From.Type, parent: KeyPath<From, OptionalParentProperty<From, To>>, method: DatabaseQuery.Join.Method = .inner) -> Self where From : Model, To : Model

Parameters

model: The Model to join from
parent: The OptionalParentProperty to join
method: The method to use. The default is an inner join

Return Value

A new QueryBuilder

Discussion

This will not decode the joined data, but can be used in order to filter.

Planet.query(on: db)
    .join(from: Planet.self, parent: \.$star)
    .filter(Star.self, \Star.$name == "Sol")