Skip to content

Add as parameter to @Columns #214

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

Merged
stephencelis merged 3 commits into from
Oct 21, 2025
Merged

Add as parameter to @Columns #214

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d51d98b
Add `as` parameter to `@Columns`
stephencelis Oct 21, 2025
fce6cff
optional fix
stephencelis Oct 21, 2025
1ba9c59
wip
stephencelis Oct 21, 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
2 changes: 1 addition & 1 deletion Sources/StructuredQueries/Macros.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -114,7 +114,7 @@ public macro Column(
/// - Parameters primaryKey: These columns are the table's composite primary key.
@attached(peer)
public macro Columns(
// as representableType: (any QueryRepresentable.Type)? = nil,
as representableType: (any QueryRepresentable.Type)? = nil,
primaryKey: Bool = false
) =
#externalMacro(
Expand Down
20 changes: 10 additions & 10 deletions Sources/StructuredQueriesCore/ColumnGroup.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,16 +4,16 @@
/// to generate values of this type.
@dynamicMemberLookup
public struct ColumnGroup<Root: Table, Values: Table>: _TableColumnExpression
where Values.QueryOutput == Values {
where Values.QueryOutput: Table {
public typealias Value = Values

public var _names: [String] { Values.TableColumns.allColumns.map(\.name) }

public typealias QueryValue = Values

public let keyPath: KeyPath<Root, Values>
public let keyPath: KeyPath<Root, Values.QueryOutput>

public init(keyPath: KeyPath<Root, Values>) {
public init(keyPath: KeyPath<Root, Values.QueryOutput>) {
self.keyPath = keyPath
}

Expand All @@ -22,7 +22,7 @@ where Values.QueryOutput == Values {
}

public subscript<Member>(
dynamicMember keyPath: KeyPath<Values.TableColumns, TableColumn<Values, Member>>
dynamicMember keyPath: KeyPath<Values.TableColumns, TableColumn<Values.QueryOutput, Member>>
) -> TableColumn<Root, Member> {
let column = Values.columns[keyPath: keyPath]
return TableColumn<Root, Member>(
Expand All @@ -33,7 +33,7 @@ where Values.QueryOutput == Values {
}

public subscript<Member>(
dynamicMember keyPath: KeyPath<Values.TableColumns, GeneratedColumn<Values, Member>>
dynamicMember keyPath: KeyPath<Values.TableColumns, GeneratedColumn<Values.QueryOutput, Member>>
) -> GeneratedColumn<Root, Member> {
let column = Values.columns[keyPath: keyPath]
return GeneratedColumn<Root, Member>(
Expand All @@ -44,7 +44,7 @@ where Values.QueryOutput == Values {
}

public subscript<Member>(
dynamicMember keyPath: KeyPath<Values.TableColumns, ColumnGroup<Values, Member>>
dynamicMember keyPath: KeyPath<Values.TableColumns, ColumnGroup<Values.QueryOutput, Member>>
) -> ColumnGroup<Root, Member> {
let column = Values.columns[keyPath: keyPath]
return ColumnGroup<Root, Member>(
Expand All @@ -53,12 +53,12 @@ where Values.QueryOutput == Values {
}

public var _allColumns: [any TableColumnExpression] {
Values.TableColumns.allColumns.map { column in
Values.QueryOutput.TableColumns.allColumns.map { column in
func open<R, V>(
_ column: some TableColumnExpression<R, V>
) -> any TableColumnExpression {
let keyPath = keyPath.appending(
path: unsafeDowncast(column.keyPath, to: KeyPath<Values, V.QueryOutput>.self)
path: unsafeDowncast(column.keyPath, to: KeyPath<Values.QueryOutput, V.QueryOutput>.self)
)
return TableColumn<Root, V>(
column.name,
Expand All @@ -71,12 +71,12 @@ where Values.QueryOutput == Values {
}

public var _writableColumns: [any WritableTableColumnExpression] {
Values.TableColumns.writableColumns.map { column in
Values.QueryOutput.TableColumns.writableColumns.map { column in
func open<R, V>(
_ column: some WritableTableColumnExpression<R, V>
) -> any WritableTableColumnExpression {
let keyPath = keyPath.appending(
path: unsafeDowncast(column.keyPath, to: KeyPath<Values, V.QueryOutput>.self)
path: unsafeDowncast(column.keyPath, to: KeyPath<Values.QueryOutput, V.QueryOutput>.self)
)
return TableColumn<Root, V>(
column.name,
Expand Down
2 changes: 1 addition & 1 deletion Sources/StructuredQueriesCore/TableAlias.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -252,7 +252,7 @@ where Base.TableColumns.PrimaryColumn: WritableTableColumnExpression {
}

extension TableAlias: QueryExpression where Base: QueryExpression {
public typealias QueryValue = Base.QueryValue
public typealias QueryValue = Self

public var queryFragment: QueryFragment {
base.queryFragment
Expand Down
6 changes: 3 additions & 3 deletions Sources/StructuredQueriesMacros/TableMacro.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -868,9 +868,9 @@ extension TableMacro: ExtensionMacro {
public typealias From = Swift.Never
""",
])
let columnWidth: ExprSyntax = """
let columnWidth = """
var columnWidth = 0
columnWidth += \(columnWidths, separator: "\ncolumnWidth += ")
columnWidth += \(columnWidths.map(\.description).joined(separator: "\ncolumnWidth += "))
return columnWidth
"""

Expand All @@ -881,7 +881,7 @@ extension TableMacro: ExtensionMacro {
\(conformances.isEmpty ? "" : ": \(conformances, separator: ", ")") {\
\(statics, separator: "\n")
public \(nonisolated)static var columns: TableColumns { TableColumns() }
public \(nonisolated)static var _columnWidth: Int { \(columnWidth) }
public \(nonisolated)static var _columnWidth: Int { \(raw: columnWidth) }
public \(nonisolated)static var tableName: String { \(tableName) }\
\(letSchemaName)\(initDecoder)\(initFromOther)
}
Expand Down
84 changes: 84 additions & 0 deletions Tests/StructuredQueriesMacrosTests/TableMacroTests.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2414,6 +2414,90 @@ extension SnapshotTests {
}
}

@Test func columnsRepresentation() {
assertMacro {
"""
@Selection
struct RemindersListAliasAndReminderCount {
@Columns(as: TableAlias<RemindersList, RL>.self)
let remindersList: RemindersList
let remindersCount: Int
}
"""
} expansion: {
#"""
struct RemindersListAliasAndReminderCount {
let remindersList: RemindersList
let remindersCount: Int

public nonisolated struct TableColumns: StructuredQueriesCore.TableDefinition {
public typealias QueryValue = RemindersListAliasAndReminderCount
public let remindersList = StructuredQueriesCore.ColumnGroup<QueryValue, TableAlias<RemindersList, RL>>(keyPath: \QueryValue.remindersList)
public let remindersCount = StructuredQueriesCore._TableColumn<QueryValue, Int>.for("remindersCount", keyPath: \QueryValue.remindersCount)
public static var allColumns: [any StructuredQueriesCore.TableColumnExpression] {
var allColumns: [any StructuredQueriesCore.TableColumnExpression] = []
allColumns.append(contentsOf: QueryValue.columns.remindersList._allColumns)
allColumns.append(contentsOf: QueryValue.columns.remindersCount._allColumns)
return allColumns
}
public static var writableColumns: [any StructuredQueriesCore.WritableTableColumnExpression] {
var writableColumns: [any StructuredQueriesCore.WritableTableColumnExpression] = []
writableColumns.append(contentsOf: QueryValue.columns.remindersList._writableColumns)
writableColumns.append(contentsOf: QueryValue.columns.remindersCount._writableColumns)
return writableColumns
}
public var queryFragment: QueryFragment {
"\(self.remindersList), \(self.remindersCount)"
}
}

public nonisolated struct Selection: StructuredQueriesCore.TableExpression {
public typealias QueryValue = RemindersListAliasAndReminderCount
public let allColumns: [any StructuredQueriesCore.QueryExpression]
public init(
remindersList: some StructuredQueriesCore.QueryExpression<TableAlias<RemindersList, RL>>,
remindersCount: some StructuredQueriesCore.QueryExpression<Int>
) {
var allColumns: [any StructuredQueriesCore.QueryExpression] = []
allColumns.append(contentsOf: remindersList._allColumns)
allColumns.append(contentsOf: remindersCount._allColumns)
self.allColumns = allColumns
}
}
}

nonisolated extension RemindersListAliasAndReminderCount: StructuredQueriesCore.Table, StructuredQueriesCore._Selection, StructuredQueriesCore.PartialSelectStatement {
public typealias QueryValue = Self
public typealias From = Swift.Never
public nonisolated static var columns: TableColumns {
TableColumns()
}
public nonisolated static var _columnWidth: Int {
var columnWidth = 0
columnWidth += TableAlias<RemindersList, RL>._columnWidth
columnWidth += Int._columnWidth
return columnWidth
}
public nonisolated static var tableName: String {
"remindersListAliasAndReminderCounts"
}
public nonisolated init(decoder: inout some StructuredQueriesCore.QueryDecoder) throws {
let remindersList = try decoder.decode(TableAlias<RemindersList, RL>.self)
let remindersCount = try decoder.decode(Int.self)
guard let remindersList else {
throw StructuredQueriesCore.QueryDecodingError.missingRequiredColumn
}
guard let remindersCount else {
throw StructuredQueriesCore.QueryDecodingError.missingRequiredColumn
}
self.remindersList = remindersList
self.remindersCount = remindersCount
}
}
"""#
}
}

#if StructuredQueriesCasePaths
@Test func enumBasics() {
assertMacro {
Expand Down
102 changes: 102 additions & 0 deletions Tests/StructuredQueriesTests/SelectionTests.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -234,6 +234,92 @@ extension SnapshotTests {
"""
}
}

@Test func alias() {
let baseQuery =
RemindersList.as(RL.self).all
.group(by: \.id)
.limit(2)
.join(Reminder.all) { $0.id.eq($1.remindersListID) }

assertQuery(
baseQuery
.select {
RemindersListAliasAndReminderCount.Columns(
remindersList: $0,
remindersCount: $1.id.count()
)
}
) {
"""
SELECT "rLs"."id" AS "id", "rLs"."color" AS "color", "rLs"."title" AS "title", "rLs"."position" AS "position", count("reminders"."id") AS "remindersCount"
FROM "remindersLists" AS "rLs"
JOIN "reminders" ON ("rLs"."id") = ("reminders"."remindersListID")
GROUP BY "rLs"."id"
LIMIT 2
"""
} results: {
"""
┌─────────────────────────────────────┐
│ RemindersListAliasAndReminderCount( │
│ remindersList: RemindersList( │
│ id: 1, │
│ color: 4889071, │
│ title: "Personal", │
│ position: 0 │
│ ), │
│ remindersCount: 5 │
│ ) │
├─────────────────────────────────────┤
│ RemindersListAliasAndReminderCount( │
│ remindersList: RemindersList( │
│ id: 2, │
│ color: 15567157, │
│ title: "Family", │
│ position: 0 │
│ ), │
│ remindersCount: 3 │
│ ) │
└─────────────────────────────────────┘
"""
}
}

@Test func optionalAlias() {
let baseQuery =
Reminder
.leftJoin(RemindersList.as(RL.self).all) { $0.remindersListID.eq($1.id) }

assertQuery(
baseQuery
.select {
OptionalRemindersListAliasAndReminderCount.Columns(
remindersList: $1,
remindersCount: $0.id.count()
)
}
) {
"""
SELECT "rLs"."id" AS "id", "rLs"."color" AS "color", "rLs"."title" AS "title", "rLs"."position" AS "position", count("reminders"."id") AS "remindersCount"
FROM "reminders"
LEFT JOIN "remindersLists" AS "rLs" ON ("reminders"."remindersListID") = ("rLs"."id")
"""
} results: {
"""
┌─────────────────────────────────────────────┐
│ OptionalRemindersListAliasAndReminderCount( │
│ remindersList: RemindersList( │
│ id: 1, │
│ color: 4889071, │
│ title: "Personal", │
│ position: 0 │
│ ), │
│ remindersCount: 10 │
│ ) │
└─────────────────────────────────────────────┘
"""
}
}
}
}

Expand All @@ -254,6 +340,22 @@ struct RemindersListAndReminderCount {
let remindersCount: Int
}

enum RL: AliasName {}

@Selection
struct RemindersListAliasAndReminderCount {
@Columns(as: TableAlias<RemindersList, RL>.self)
let remindersList: RemindersList
let remindersCount: Int
}

@Selection
struct OptionalRemindersListAliasAndReminderCount {
@Columns(as: TableAlias<RemindersList, RL>?.self)
let remindersList: RemindersList?
let remindersCount: Int
}

@Selection
struct Stats {
let completedCount: Int
Expand Down