Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
34 changes: 26 additions & 8 deletions Package.resolved

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

16 changes: 15 additions & 1 deletion Package.swift
Original file line number Diff line number Diff line change
Expand Up @@ -34,10 +34,19 @@ let package = Package(
products: [
.library(name: "FeatherSQLiteDatabase", targets: ["FeatherSQLiteDatabase"]),
],
traits: [
"ServiceLifecycleSupport",
.default(
enabledTraits: [
"ServiceLifecycleSupport",
]
),
],
dependencies: [
.package(url: "https://github.com/apple/swift-log", from: "1.6.0"),
.package(url: "https://github.com/vapor/sqlite-nio", from: "1.12.0"),
.package(url: "https://github.com/feather-framework/feather-database", exact: "1.0.0-beta.3"),
.package(url: "https://github.com/swift-server/swift-service-lifecycle", from: "2.8.0"),
// [docc-plugin-placeholder]
],
targets: [
Expand All @@ -52,8 +61,13 @@ let package = Package(
.target(
name: "FeatherSQLiteDatabase",
dependencies: [
.product(name: "FeatherDatabase", package: "feather-database"),
.target(name: "SQLiteNIOExtras"),
.product(name: "FeatherDatabase", package: "feather-database"),
.product(
name: "ServiceLifecycle",
package: "swift-service-lifecycle",
condition: .when(traits: ["ServiceLifecycleSupport"])
),
],
swiftSettings: defaultSwiftSettings
),
Expand Down
24 changes: 24 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,30 @@ Then add `FeatherSQLiteDatabase` to your target dependencies:
.product(name: "FeatherSQLiteDatabase", package: "feather-sqlite-database"),
```

<<<<<<< HEAD
### Package traits

This package offers additional integrations you can enable using [package traits](https://docs.swift.org/swiftpm/documentation/packagemanagerdocs/addingdependencies#Packages-with-Traits).
To enable an additional trait on the package, update the package dependency:

```diff
.package(
url: "https://github.com/feather-framework/feather-sqlite-database",
exact: "1.0.0-beta.3",
+ traits: [
+ .defaults,
+ "ServiceLifecycleSupport",
+ ]
)
```

Available traits:

- `ServiceLifecycleSupport` (default): Adds support for `SQLiteClientService`, a `ServiceLifecycle.Service` implementation for managing SQLite clients.


=======
>>>>>>> main
## Usage

API documentation is available at the link below:
Expand Down
41 changes: 41 additions & 0 deletions Sources/FeatherSQLiteDatabase/SQLiteDatabaseService.swift
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
//
// SQLiteDatabaseService.swift
// feather-sqlite-database
//
// Created by Tibor Bödecs on 2026. 01. 29..
//

#if ServiceLifecycleSupport

import SQLiteNIOExtras
import ServiceLifecycle

/// A `Service` wrapper around an `SQLiteClient`.
public struct SQLiteDatabaseService: Service {

/// The underlying SQLite client instance.
public var client: SQLiteClient

/// Creates a new SQLite client service.
///
/// - Parameter client: The SQLite client to manage for the service lifecycle.
public init(
_ client: SQLiteClient
) {
self.client = client
}

/// Runs the SQLite client service.
///
/// This method starts the SQLite client, waits for a graceful shutdown
/// signal, and then shuts down the client in an orderly manner.
///
/// - Throws: Rethrows any error produced while starting the SQLite client.
public func run() async throws {
try await client.run()
try? await gracefulShutdown()
await client.shutdown()
}

}
#endif
8 changes: 6 additions & 2 deletions Sources/SQLiteNIOExtras/SQLiteConnectionPool.swift
Original file line number Diff line number Diff line change
Expand Up @@ -208,7 +208,9 @@ actor SQLiteConnectionPool {
catch {
configuration.logger.warning(
"Failed to close SQLite connection after setup error",
metadata: ["error": "\(error)"]
metadata: [
"error": "\(error)"
]
)
}
throw error
Expand All @@ -225,7 +227,9 @@ actor SQLiteConnectionPool {
catch {
configuration.logger.warning(
"Failed to close SQLite connection",
metadata: ["error": "\(error)"]
metadata: [
"error": "\(error)"
]
)
}
}
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
//
// SQLiteDatabaseTestSuite.swift
// FeatherSQLiteDatabaseTestSuite.swift
// feather-sqlite-database
//
// Created by Tibor Bödecs on 2026. 01. 10..
Expand All @@ -14,7 +14,7 @@ import Testing
@testable import FeatherSQLiteDatabase

@Suite
struct SQLiteDatabaseTestSuite {
struct FeatherSQLiteDatabaseTestSuite {

private func runUsingTestDatabaseClient(
_ closure: ((SQLiteDatabaseClient) async throws -> Void)
Expand Down Expand Up @@ -775,3 +775,62 @@ struct SQLiteDatabaseTestSuite {
}
}
}

#if ServiceLifecycleSupport
import ServiceLifecycle

extension FeatherSQLiteDatabaseTestSuite {

@Test
func serviceLifecycleSupport() async throws {
var logger = Logger(label: "test")
logger.logLevel = .info

let configuration = SQLiteClient.Configuration(
storage: .memory,
logger: logger,
)
let client = SQLiteClient(configuration: configuration)
let database = SQLiteDatabaseClient(client: client, logger: logger)
let service = SQLiteDatabaseService(client)

let serviceGroup = ServiceGroup(
services: [service],
logger: logger
)

try await withThrowingTaskGroup(of: Void.self) { group in
group.addTask {
try await serviceGroup.run()
}
group.addTask {
let result = try await database.withConnection { connection in
try await connection.run(
query: #"""
SELECT
sqlite_version() AS "version"
WHERE
1=\#(1);
"""#
)
}

let resultArray = try await result.collect()
#expect(resultArray.count == 1)

let item = resultArray[0]
let version = try item.decode(
column: "version",
as: String.self
)
#expect(version.split(separator: ".").count == 3)
}
try await group.next()

try await Task.sleep(for: .milliseconds(100))

await serviceGroup.triggerGracefulShutdown()
}
}
}
#endif