DuckDB Swift

DuckDB Swift is the native Swift API for DuckDB. It employs a modern Swift based API for clients across Apple, Linux and Windows platforms.

DuckDB

DuckDB is a high-performance analytical database system. It is designed to be fast, reliable and easy to use. DuckDB provides a rich SQL dialect, with support far beyond basic SQL. DuckDB supports arbitrary and nested correlated subqueries, window functions, collations, complex types (arrays, structs), and more. For more information on the goals of DuckDB, please refer to the Why DuckDB page on our website.

Installation

To use DuckDB in your Swift based project:

1. Add DuckDB to your Swift.package dependencies:

   .package(url: "https://github.com/duckdb/duckdb-swift", .upToNextMinor(from: .init(0, x, 0))),

2. Add DuckDB as a dependency to your target:

   .target(name: "TargetName", dependencies: [
     .product(name: "DuckDB", package: "duckdb-swift"),
   ...
   ]),

Source and file format stability

DuckDB is in early release mode and API is subject to change between minor version updates. DuckDB's file format is also subject to change and – in the short-term – it is recommended to make use of DuckDB's CSV import/export capabilities to ensure your data remains accessible between DuckDB version updates.

Documentation and Playgrounds

The DuckDB Swift API is fully documented using DocC and the documentation can be generated from within Xcode via Product > Build Documentation.

You can also explore an Xcode Playground that demonstrates getting up and running with DuckDB and visualizing data using SwiftUI. To access the playground, clone this repository, open the DuckDB.xcworkspace file, and navigate to the DuckDBPlayground from within Xcode's project explorer panel.

Contributing

Issues and Pull Requests should be submitted via the main DuckDB repository.

Development

Development is managed through the main DuckDB repository. To set-up a Swift development environment:

1. Check out the main DuckDB repository at https://github.com/duckdb/duckdb
2. Pull the latest git tags:

git fetch --all --tags

3. Generate the Unified Build files for the package:

python3 tools/swift/create-package.py tools/swift

4. Open the Xcode workspace at tools/swift/duckdb-swift/DuckDB.xcworkspace

Please also refer to our Contribution Guide.