Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/TigerEyeLabs/duckdb-dart
DuckDB Dart bindings.
https://github.com/TigerEyeLabs/duckdb-dart
Last synced: 11 days ago
JSON representation
DuckDB Dart bindings.
- Host: GitHub
- URL: https://github.com/TigerEyeLabs/duckdb-dart
- Owner: TigerEyeLabs
- License: mit
- Created: 2024-06-11T22:50:25.000Z (5 months ago)
- Default Branch: main
- Last Pushed: 2024-08-22T12:40:07.000Z (3 months ago)
- Last Synced: 2024-09-22T01:38:50.555Z (about 2 months ago)
- Language: Dart
- Size: 371 KB
- Stars: 27
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- awesome-duckdb - Dart
README
# DuckDB.Dart
**DuckDB.Dart** is the native Dart API for [DuckDB](https://duckdb.org/), enabling developers to harness the power of DuckDB in Dart-based applications across Apple, iOS, Android, Linux, and Windows platforms.
## DuckDB Overview
DuckDB is a high-performance analytical database system known for its speed, reliability, and ease of use. It supports a comprehensive SQL dialect, offering features such as:
- Arbitrary and nested correlated subqueries
- Window functions
- Collations
- Complex types (arrays, structs)
For more information on DuckDB's goals and capabilities, visit the [Why DuckDB page](https://duckdb.org/why_duckdb).
## Usage Examples
Here are some common use cases for DuckDB.Dart:
### Querying a Database
```dart
import 'package:dart_duckdb/dart_duckdb.dart';
void main() {
final db = duckdb.open(":memory:");
final connection = db.connect();
connection.execute('''
CREATE TABLE users (id INTEGER, name VARCHAR, age INTEGER);
INSERT INTO users VALUES (1, 'Alice', 30), (2, 'Bob', 25);
''');
final result = connection.query("SELECT * FROM users WHERE age > 28").fetchAll();
for (final row in result) {
print(row);
}
connection.close();
db.close();
}
```
### Queries on background Isolates
```dart
import 'package:dart_duckdb/dart_duckdb.dart';
void main() {
final db = duckdb.open(":memory:");
final connection = db.connect();
await Isolate.spawn(backgroundTask, db.transferrable);
connection.close();
db.close();
}
void backgroundTask(TransferableDatabase transferableDb) {
final connection = duckdb.connectWithTransferred(transferableDb);
// Access database ...
// fetch is needed to send the data back to the main isolate
}
```
## Contributing
We welcome contributions to DuckDB.Dart! If you have suggestions for improvements or bug fixes, please follow these steps:
1. Fork the repository.
2. Create a new branch for your feature or bug fix.
3. Make your changes and commit them with descriptive messages.
4. Push your changes to your fork.
5. Create a pull request with a detailed description of your changes.
## Support and Contact
If you encounter any issues or have questions, please check our [issue tracker](https://github.com/TigerEyeLabs/duckdb-dart/issues)
---
## Building DuckDB.Dart from Source
### Install Dependencies
Install fvm, [Getting Started](https://fvm.app/documentation/getting-started/installation)
Install any platform dependencies for DuckDB. Here are the [DuckDB Building Instructions](https://duckdb.org/docs/dev/building/build_instructions.html). Also, the github workflows are the best examples to learn from.
### Build DuckDB
Run make from this project to build/patch duckdb.
#### MacOS Universal
To build for MacOS:
```sh
make macos
```
#### iOS (Requires iOS SDK)
To build for an iOS device:
```sh
make ios_device
```
To build for an iOS simulator:
```sh
make ios_simulator
```
#### Android (Requires Android NDK)
To build for Android:
```sh
make android
```
#### Windows (Requires MINGW64)
```sh
cd windows && ./getduck.ps1
```
#### Linux
To build for Linux:
```sh
make linux
```
### Build DuckDB.Dart
```sh
make build
```
## Maintaining DuckDB.Dart
### Upgrading DuckDB Versions e.g. 0.9.1 to 0.9.2
To upgrade DuckDB to a newer version, follow these steps:
1. **Clone the DuckDB repository**:
```sh
git clone https://github.com/duckdb/duckdb && cd duckdb
```
2. **Fetch the latest tags**:
```sh
git fetch --tags
```
3. **Checkout the old tag** (e.g., v0.9.1):
```sh
git checkout tags/v0.9.1
```
4. **Apply your previous changes**:
```sh
git apply ../changes.patch
git add . && git commit -m 'Apply previous changes'
```
5. **Rebase to the new tag** (e.g., v0.9.2):
```sh
git rebase tags/v0.9.2
```
6. **Create an updated patch file**:
```sh
git diff tags/v0.9.2 > ../changes.patch
```