QueryBuilder

Topics

Initializers

• convenience init(database: any Database)

Instance Properties

• let database: any Database
• var eagerLoaders: [any AnyEagerLoader]
• var query: DatabaseQuery

Instance Methods

• func aggregate(_:_:as:)
• func aggregate(_:as:)
• func all()
• func all(_:)
• func all(_:_:)
• func average(_:)
• func chunk(max:closure:)
• func copy() -> QueryBuilder<Model>
• func count()
• func count(_:)
• func create()
• func delete(force:)
• func field(_:)
• func field<Joined, Field>(Joined.Type, KeyPath<Joined, Field>) -> Self
• func fields<Joined>(for: Joined.Type) -> Self
• func filter(_:)
• func filter(_:_:)
• func filter(_:_:_:)
• func filter<Joined, Field>(Joined.Type, KeyPath<Joined, Field>, DatabaseQuery.Filter.Method, Field.Value) -> Self
• func first()
• func group(DatabaseQuery.Filter.Relation, (QueryBuilder<Model>) throws -> ()) rethrows -> Self
• func join<Foreign>(Foreign.Type, [DatabaseQuery.Filter], method: DatabaseQuery.Join.Method) -> Self
  .join(Foreign.self, filters, method: method)
• func join<Foreign, Local>(Local.Type, Foreign.Type, on: DatabaseQuery.Join) -> Self
• func join<Foreign>(Foreign.Type, on: DatabaseQuery.Join) -> Self
  .join(Foreign.self, on: databaseJoin)
• func join(_:on:method:)
• func join<To>(child: KeyPath<Model, OptionalChildProperty<Model, To>>, method: DatabaseQuery.Join.Method) -> Self
  This will join a foreign table based on a @OptionalChild relation
• func join<To>(children: KeyPath<Model, ChildrenProperty<Model, To>>, method: DatabaseQuery.Join.Method) -> Self
  This will join a foreign table based on a @Children relation
• func join<From, To>(from: From.Type, child: KeyPath<From, OptionalChildProperty<From, To>>, method: DatabaseQuery.Join.Method) -> Self
  This will join a foreign table based on a @OptionalChild relation
• func join<From, To>(from: From.Type, children: KeyPath<From, ChildrenProperty<From, To>>, method: DatabaseQuery.Join.Method) -> Self
  This will join a foreign table based on a @Children relation
• func join(from:parent:method:)
  This will join a foreign table based on a @OptionalParent relation
• func join<From, To, Through>(from: From.Type, siblings: KeyPath<From, SiblingsProperty<From, To, Through>>) -> Self
  This will join the foreign table based on a @Siblingsrelation This will result in joining two tables. The Pivot table and the wanted model table
• func join(parent:method:)
  This will join a foreign table based on a @OptionalParent relation
• func join<To, Through>(siblings: KeyPath<Model, SiblingsProperty<Model, To, Through>>) -> Self
  This will join the foreign table based on a @Siblingsrelation This will result in joining two tables. The Pivot table and the wanted model table
• func limit(Int) -> Self
• func max(_:)
• func min(_:)
• func offset(Int) -> Self
• func page(withIndex:size:)
  Returns a single Page out of the complete result set.
• func paginate(_:)
  Returns a single Page out of the complete result set according to the supplied PageRequest.
• func range(_:)
  Limits the results of this query to the specified range.
• func range(lower: Int, upper: Int?) -> Self
  Limits the results of this query to the specified range.
• func run()
• func run(_:)
• func set(_:)
• func set(_:to:)
• func sort(DatabaseQuery.Sort) -> Self
• func sort(_:_:)
• func sort(_:_:_:alias:)
• func sum(_:)
• func unique() -> Self
• func update()
• func withDeleted() -> Self

Default Implementations

• EagerLoadBuilder Implementations