README.md

Feather Database Postgres

Postgres driver implementation for the abstract Feather Database Swift API package.

Features

• Postgres driver for Feather Database
• Automatic query parameter escaping via Swift string interpolation.
• Async sequence query results with Decodable row support.
• Designed for modern Swift concurrency
• DocC-based API Documentation
• Unit tests and code coverage

Requirements

• Swift 6.1+

• Platforms:

  • Linux
  • macOS 15+
  • iOS 18+
  • tvOS 18+
  • watchOS 11+
  • visionOS 2+

Installation

Add the dependency to your Package.swift:

.package(url: "https://github.com/feather-framework/feather-database-postgres", exact: "1.0.0-beta.6"),

Then add FeatherDatabasePostgres to your target dependencies:

.product(name: "FeatherDatabasePostgres", package: "feather-database-postgres"),

Usage

API documentation is available at the link below:

Here is a brief example:

import Logging
import NIOSSL
import PostgresNIO
import FeatherDatabase
import FeatherDatabasePostgres

var logger = Logger(label: "example")
logger.logLevel = .info

let finalCertPath = URL(fileURLWithPath: "/path/to/ca.pem")
var tlsConfig = TLSConfiguration.makeClientConfiguration()
let rootCert = try NIOSSLCertificate.fromPEMFile(finalCertPath)
tlsConfig.trustRoots = .certificates(rootCert)
tlsConfig.certificateVerification = .fullVerification

let client = PostgresClient(
    configuration: .init(
        host: "127.0.0.1",
        port: 5432,
        username: "postgres",
        password: "postgres",
        database: "postgres",
        tls: .require(tlsConfig)
    ),
    backgroundLogger: logger
)

let database = DatabaseClientPostgres(
    client: client,
    logger: logger
)

try await withThrowingTaskGroup(of: Void.self) { group in
    // run the client as a service
    group.addTask {
        await client.run()
    }
    // execute some query
    group.addTask {
        let result = try await database.withConnection { connection in
            try await connection.run(
                query: #"""
                    SELECT
                        version() AS "version"
                    WHERE
                        1=\#(1);
                    """#
            )
        }

        for try await item in result {
            let version = try item.decode(column: "version", as: String.self)
            print(version)
        }
    }
    try await group.next()
    group.cancelAll()
}

Warning

This repository is a work in progress, things can break until it reaches v1.0.0.

Other database drivers

The following database driver implementations are available for use:

• SQLite
• MySQL

Development

• Build: swift build
• Test:
  • local: swift test
  • using Docker: make docker-test
• Format: make format
• Check: make check

Contributing

Pull requests are welcome. Please keep changes focused and include tests for new logic.