Skip to content

Add TableAlias docs for selection decoding #241

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
stephencelis wants to merge 2 commits into
base: main
Choose a base branch
from
+15 −0
Open

Add TableAlias docs for selection decoding #241

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b50aa79
Add `TableAlias` docs for selection decoding
stephencelis Dec 9, 2025
51a5619
Update TableAlias.swift
stephencelis Dec 10, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions Sources/StructuredQueriesCore/TableAlias.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,21 @@ extension Table {
/// // ON "users"."referrerID" = "referrers"."id"
/// ```
///
/// Table aliases are representable in selections by providing the type to the `@Columns` macro:
///
/// ```swift
/// @Selection
/// struct UserWithReferrer {
/// let user: User
/// @Columns(as: TableAlias<User, Referrer>.self)
/// let referrer: User
/// }
///
/// let usersWithReferrers = User
/// .join(User.as(Referrer.self).all) { $0.referrerID == $1.id }
/// .select { UserWithReferrer.Columns(user: $0, referrer: $1) }
/// ```
///
/// - Parameter aliasName: An alias name for this table.
/// - Returns: A table alias of this table type.
public static func `as`<Name: AliasName>(_ aliasName: Name.Type) -> TableAlias<Self, Name>.Type {
Expand Down
Loading