Add the missing SQLDatabase.alter(table: any SQLExpression) method (#188)

* Bump Swift minimum to 5.10 and update README accordingly.

* Fix a number of minor API docs issues found by the latest DocC

* Add the missing `SQLDatabase.alter(table: any SQLExpression)` method

* Update CI

Author: gwynne

.github/workflows/test.yml

@@ -13,11 +13,13 @@ jobs:
   unit-tests:
     uses: vapor/ci/.github/workflows/run-unit-tests.yml@main
     secrets: inherit
+    with:
+      with_android: true
 
   pure-fluent-integration-test:
     if: ${{ !(github.event.pull_request.draft || false) }}
     runs-on: ubuntu-latest
-    container: swift:5.10-jammy
+    container: swift:6.1-noble
     steps:
       - name: Check out sql-kit
         uses: actions/checkout@v4
@@ -48,7 +50,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        swift-image: ['swift:5.10-jammy']
+        swift-image: ['swift:6.1-noble']
         driver:
           - { sqlkit: 'sqlite-kit',   fluent: 'fluent-sqlite-driver' }
           - { sqlkit: 'mysql-kit',    fluent: 'fluent-mysql-driver' }

Package.swift

@@ -1,4 +1,4 @@
-// swift-tools-version:5.8
+// swift-tools-version:5.10
 import PackageDescription
 
 let package = Package(
@@ -14,18 +14,18 @@ let package = Package(
         .library(name: "SQLKitBenchmark", targets: ["SQLKitBenchmark"]),
     ],
     dependencies: [
-        .package(url: "https://github.com/apple/swift-nio.git", from: "2.65.0"),
-        .package(url: "https://github.com/apple/swift-log.git", from: "1.5.4"),
         .package(url: "https://github.com/apple/swift-collections.git", from: "1.1.0"),
+        .package(url: "https://github.com/apple/swift-log.git", from: "1.5.4"),
+        .package(url: "https://github.com/apple/swift-nio.git", from: "2.65.0"),
     ],
     targets: [
         .target(
             name: "SQLKit",
             dependencies: [
+                .product(name: "Collections", package: "swift-collections"),
                 .product(name: "Logging", package: "swift-log"),
                 .product(name: "NIO", package: "swift-nio"),
                 .product(name: "NIOCore", package: "swift-nio"),
-                .product(name: "Collections", package: "swift-collections"),
             ],
             swiftSettings: swiftSettings
         ),
@@ -48,6 +48,9 @@ let package = Package(
 )
 
 var swiftSettings: [SwiftSetting] { [
+    .enableUpcomingFeature("ExistentialAny"),
     .enableUpcomingFeature("ConciseMagicFile"),
     .enableUpcomingFeature("ForwardTrailingClosures"),
+    .enableUpcomingFeature("DisableOutwardActorInference"),
+    .enableExperimentalFeature("StrictConcurrency=complete"),
 ] }

Package@swift-5.9.swift

@@ -1,17 +1,13 @@
 <p align="center">
-<picture>
-  <source media="(prefers-color-scheme: dark)" srcset="https://github.com/vapor/sql-kit/assets/1130717/b5828634-c1a1-4d91-b25d-20e033b77269">
-  <source media="(prefers-color-scheme: light)" srcset="https://github.com/vapor/sql-kit/assets/1130717/f45e4b01-0579-4011-8b06-0f159e0d386f">
-  <img src="https://github.com/vapor/sql-kit/assets/1130717/f45e4b01-0579-4011-8b06-0f159e0d386f" height="96" alt="SQLKit">
-</picture> 
+<img src="https://design.vapor.codes/images/vapor-sqlkit.svg" height="96" alt="SQLKit">
 <br>
 <br>
 <a href="https://docs.vapor.codes/4.0/"><img src="https://design.vapor.codes/images/readthedocs.svg" alt="Documentation"></a>
 <a href="https://discord.gg/vapor"><img src="https://design.vapor.codes/images/discordchat.svg" alt="Team Chat"></a>
 <a href="LICENSE"><img src="https://design.vapor.codes/images/mitlicense.svg" alt="MIT License"></a>
 <a href="https://github.com/vapor/sql-kit/actions/workflows/test.yml"><img src="https://img.shields.io/github/actions/workflow/status/vapor/sql-kit/test.yml?event=push&style=plastic&logo=github&label=tests&logoColor=%23ccc" alt="Continuous Integration"></a>
 <a href="https://codecov.io/github/vapor/sql-kit"><img src="https://img.shields.io/codecov/c/github/vapor/sql-kit?style=plastic&logo=codecov&label=codecov"></a>
-<a href="https://swift.org"><img src="https://design.vapor.codes/images/swift58up.svg" alt="Swift 5.8+"></a>
+<a href="https://swift.org"><img src="https://design.vapor.codes/images/swift510up.svg" alt="Swift 5.10+"></a>
 </p>
 
 <br>

README.md

@@ -120,14 +120,14 @@ public final class SQLAlterTableBuilder: SQLQueryBuilder {
         return self
     }
 
-    /// Drop an existing column from the table
+    /// Drop an existing column from the table.
     @inlinable
     @discardableResult
     public func dropColumn(_ column: String) -> Self {
         self.dropColumn(SQLIdentifier(column))
     }
 
-    /// Drop an existing column from the table
+    /// Drop an existing column from the table.
     @inlinable
     @discardableResult
     public func dropColumn(_ column: any SQLExpression) -> Self {
@@ -146,6 +146,12 @@ extension SQLDatabase {
     /// Create a new ``SQLAlterTableBuilder``.
     @inlinable
     public func alter(table: SQLIdentifier) -> SQLAlterTableBuilder {
-         .init(.init(name: table), on: self)
+         self.alter(table: table as any SQLExpression)
+    }
+
+    /// Create a new ``SQLAlterTableBuilder``.
+    @inlinable
+    public func alter(table: any SQLExpression) -> SQLAlterTableBuilder {
+        .init(.init(name: table), on: self)
     }
 }

Sources/SQLKit/Builders/Implementations/SQLAlterTableBuilder.swift

@@ -186,7 +186,7 @@ public final class SQLInsertBuilder: SQLQueryBuilder, SQLReturningBuilder/*, SQL
     /// - Parameters:
     ///   - models: Array of values of a given type to insert. The given type may be any encodable type which
     ///     represents an aggregate value.
-    ///   - encodder: A preconfigured ``SQLQueryEncoder`` to use for encoding.
+    ///   - encoder: A preconfigured ``SQLQueryEncoder`` to use for encoding.
     @discardableResult
     public func models(
         _ models: [some Encodable],

Sources/SQLKit/Builders/Implementations/SQLInsertBuilder.swift

@@ -284,7 +284,7 @@ extension SQLCommonTableExpressionBuilder {
     /// This is the common "funnel" method invoked by all other methods provided by
     /// ``SQLCommonTableExpressionBuilder``. Most users will not need to call this method directly.
     ///
-    /// See ``with(_:columns:as)`` and ``with(recursive:_:columns:as:)`` for usage examples.
+    /// See ``with(_:columns:as:)-28k4r`` and ``with(recursive:columns:as:)-6yef`` for usage examples.
     ///
     /// > Warning: As with ``SQLCommonTableExpression``, ``SQLCommonTableExpressionBuilder`` does _NOT_ validate
     /// > that a recursive CTE's query takes the proper form, nor that a non-recursive CTE's query is not

Sources/SQLKit/Builders/Prototypes/SQLCommonTableExpressionBuilder.swift

@@ -89,7 +89,7 @@ extension SQLCommonUnionBuilder {
         try self.union(all: predicate(SQLSubqueryBuilder()).select)
     }
 
-    /// Alias ``union(distinct:)-1ert0`` so it acts as the "default".
+    /// Alias ``union(distinct:)-921p6`` so it acts as the "default".
     @inlinable
     public func union(_ predicate: (any SQLSubqueryClauseBuilder) throws -> any SQLSubqueryClauseBuilder) rethrows -> Self {
         try self.union(distinct: predicate)
@@ -107,7 +107,7 @@ extension SQLCommonUnionBuilder {
         try self.intersect(all: predicate(SQLSubqueryBuilder()).select)
     }
 
-    /// Alias ``intersect(distinct:)-47w8a`` so it acts as the "default".
+    /// Alias ``intersect(distinct:)-8f71m`` so it acts as the "default".
     @inlinable
     public func intersect(_ predicate: (any SQLSubqueryClauseBuilder) throws -> any SQLSubqueryClauseBuilder) rethrows -> Self {
         try self.intersect(distinct: predicate)
@@ -125,7 +125,7 @@ extension SQLCommonUnionBuilder {
         try self.except(all: predicate(SQLSubqueryBuilder()).select)
     }
 
-    /// Alias ``except(distinct:)-6vhbz`` so it acts as the "default".
+    /// Alias ``except(distinct:)-62w7q`` so it acts as the "default".
     @inlinable
     public func except(_ predicate: (any SQLSubqueryClauseBuilder) throws -> any SQLSubqueryClauseBuilder) rethrows -> Self {
         try self.except(distinct: predicate)

Sources/SQLKit/Builders/Prototypes/SQLCommonUnionBuilder.swift

@@ -26,7 +26,7 @@ extension SQLPartialResultBuilder {
 
     /// Adds a `OFFSET` clause to the query. If called more than once, the last call wins.
     ///
-    /// - Parameter max: Optional offset. If `nil`, any existing offset is removed. The value may not be negative.
+    /// - Parameter n: Optional offset. If `nil`, any existing offset is removed. The value may not be negative.
     /// - Returns: `self` for chaining.
     @inlinable
     @discardableResult

Sources/SQLKit/Builders/Prototypes/SQLPartialResultBuilder.swift

@@ -46,7 +46,7 @@ SELECT "id", "name" FROM "planets" WHERE "name" = ?1
 SELECT `id`, `name` FROM `planets` WHERE `name` = ?
 ```  
 
-## Databases, Expressions, and Builders
+### Databases, Expressions, and Builders
 
 Instances of ``SQLDatabase`` are capable of executing arbitrary ``SQLExpression``s:
 
@@ -108,7 +108,7 @@ WHERE "column1" = $1 AND "column2" IS NULL
 
 Of course, this is an _awful_ lot of code to achieve such a relatively straightforward result, which is why SQLKit provides query builders.
 
-### Rows
+#### Rows
 
 For query builders that support returning results (e.g. any builder conforming to the ``SQLQueryFetcher`` protocol), there are additional methods for handling the database output:
 
@@ -124,7 +124,7 @@ let name = try row.decode(column: "name", as: String.self)
 print(name) // String
 ```
 
-### Codable
+#### Codable
 
 ``SQLRow`` also supports decoding `Codable` models directly:
 
@@ -144,7 +144,7 @@ let planets: [Planet] = try await db.select()
     .all(decoding: Planet.self)
 ```
 
-## Select
+### Select
 
 The ``SQLDatabase/select()`` method creates a `SELECT` query builder:
 
@@ -204,7 +204,7 @@ This code generates the following SQL when used with the SQLite driver:
 WHERE "name" <> NULL AND ("name" = ?1 OR "name" = ?2) -- bindings: ["Milky Way", "Andromeda"]
 ```
 
-## Insert
+### Insert
 
 The ``SQLDatabase/insert(into:)-67oqt`` and ``SQLDatabase/insert(into:)-5n3gh`` methods create an `INSERT` query builder:
 
@@ -234,7 +234,7 @@ try builder.model(Galaxy(name: "Milky Way"))
 
 This code generates the same SQL as would `builder.columns("name").values("Milky Way")`.
 
-## Update
+### Update
 
 The ``SQLDatabase/update(_:)-2tf1c`` and ``SQLDatabase/update(_:)-80964`` methods create an `UPDATE` query builder:
 
@@ -253,7 +253,7 @@ UPDATE `planets` SET `name` = ? WHERE `name` = ? -- bindings: ["Jupiter", "Jupit
 
 The update builder supports the same `where()` and `orWhere()` methods as the select builder, via the ``SQLPredicateBuilder`` protocol.
 
-## Delete
+### Delete
 
 The ``SQLDatabase/delete(from:)-3tx4f`` and ``SQLDatabase/delete(from:)-4bqlu`` methods create a `DELETE` query builder:
 
@@ -271,7 +271,7 @@ DELETE FROM "planets" WHERE "name" = ?1 -- bindings: ["Jupiter"]
 
 The delete builder also conforms to ``SQLPredicateBuilder``.
 
-## Raw
+### Raw
 
 The ``SQLDatabase/raw(_:)`` method allows passing custom SQL query strings, with support for parameterized bindings and correctly-quoted identifiers: