Model

extension Model where IDValue: LosslessStringConvertible
Show on GitHub

Available where IDValue: LosslessStringConvertible

  • Returns a Model that will match the ID given in a named request parameter. For a route that has a parameter named userIDParam.paramString, User.findFromParameter(userIDParam, req) will get the value of the parameter and use that to fetch the user with that ID from the User table. Returns a failed future with an Abort error if: the parameter doesn’t exist, the parameter’s value can’t be made into an IDValue for the Model type, or no Model type with that ID was found in the database.

    Declaration

    Swift

    static func findFromParameter(
	_ param: PathComponent,
	on req: Request,
	inTransaction transaction: (any Database)? = nil,
	builder: ((QueryBuilder<Self>) -> Void)? = nil
) async throws -> Self

    Parameters

    param

    A PathComponent describing a path component of type .parameter
    req

    The incoming request Container, which provides the EventLoop on which the query must be run.
    transaction

    The transaction to query the database in. If unset, uses req.db and doesn’t run the query in a transaction.

    Return Value

    [UUID] containing all the user’s associated IDs.

    Show on GitHub

  • Returns a Model that will match the ID given in a named request parameter. For a route that has a “:userid” parameter, User.findFromParameter("userid", req) will return that user from the User table. Returns a failed future with an Abort error if: the parameter doesn’t exist, the parameter’s value can’t be made into an IDValue for the Model type, or no Model type with that ID was found in the database.

    Declaration

    Swift

    static func findFromParameter(_ param: String, on req: Request, inTransaction transaction: (any Database)? = nil, builder: ((QueryBuilder<Self>) -> Void)? = nil)
	async throws -> Self

    Parameters

    param

    The name of a request parameter e.g. “user_id”
    req

    The incoming request Container, which provides the EventLoop on which the query must be run.
    transaction

    The transaction to query the database in. If unset, uses req.db and doesn’t run the query in a transaction.
    builder

    A block that runs during query construction; mostly lets callers add .with() clauses to the query.

    Return Value

    [UUID] containing all the user’s associated IDs.

    Show on GitHub