mirror of
https://github.com/immich-app/sqlite-libs.git
synced 2026-09-30 13:22:53 +08:00
feat: set up repo (#1)
* initial commit * add gha * add readme * move installation steps * use 3.51.1 * checksum verification * fix compatibility with android <29 * missing source file * security fixes * fix credential persistence * use commit instead of version * rearrange * add vtab * carray * generate_series * fully renovated * autoinit * default busy timeout and fk * remove ci * bump deps
This commit is contained in:
@@ -0,0 +1,55 @@
|
||||
# SQLite Libraries
|
||||
|
||||
This repository bundles a custom SQLite build for use as a dependency in iOS and Android apps via SPM, JitPack, pub and CocoaPods. Included are:
|
||||
|
||||
- SQLite amalgamation, built with optimized settings and the following official extensions:
|
||||
- snapshot
|
||||
- fts5
|
||||
- rtree
|
||||
- math
|
||||
- percentile
|
||||
- geopoly
|
||||
- carray
|
||||
- series
|
||||
- USearch vector extension (SIMD vector search and various distance metrics)
|
||||
- SQLean's uuid extension (native UUID support, including UUIDv7)
|
||||
- SQLean's text extension (QoL helpers that exist in PostgreSQL)
|
||||
- GRDB (Swift SQLite driver, statically linked to custom SQLite)
|
||||
- SQLiteData (Swift query builder, built on GRDB)
|
||||
|
||||
The dependencies are prepared via `scripts/setup.sh`, which downloads and organizes the relevant source code and adds a few shims.
|
||||
|
||||
## Installation
|
||||
|
||||
### Flutter (Drift)
|
||||
```yaml
|
||||
dependency_overrides:
|
||||
sqlite3_flutter_libs:
|
||||
git:
|
||||
url: https://github.com/immich-app/sqlite-libs
|
||||
path: flutter
|
||||
ref: <version>
|
||||
```
|
||||
|
||||
### Android (Room/Gradle)
|
||||
```groovy
|
||||
repositories {
|
||||
maven { url 'https://jitpack.io' }
|
||||
}
|
||||
dependencies {
|
||||
implementation 'com.github.immich-app.sqlite-libs:sqlite-android:<version>'
|
||||
}
|
||||
```
|
||||
|
||||
To use with Room:
|
||||
```kotlin
|
||||
Room.databaseBuilder(context, AppDatabase::class.java, "db")
|
||||
.openHelperFactory(RequerySQLiteOpenHelperFactory())
|
||||
.build()
|
||||
```
|
||||
|
||||
### iOS (Swift Package Manager)
|
||||
Add to your `Package.swift` or Xcode project:
|
||||
```
|
||||
https://github.com/immich-app/sqlite-libs @ <version>
|
||||
```
|
||||
Reference in New Issue
Block a user