|
1 | 1 | # PowerSync core module |
2 | 2 |
|
3 | | -The PowerSync core module provides the core functionality for the PowerSync Kotlin Multiplatform SDK. |
| 3 | +The PowerSync core module provides the core functionality for the PowerSync Kotlin Multiplatform |
| 4 | +SDK. |
4 | 5 |
|
5 | 6 | ## Structure |
6 | 7 |
|
7 | | -This is a Kotlin Multiplatform project targeting Android, iOS platforms, with the following structure: |
| 8 | +This is a Kotlin Multiplatform project targeting Android, iOS platforms, with the following |
| 9 | +structure: |
8 | 10 |
|
9 | | -- `commonMain` - Shared code for all targets, which includes the `PowerSyncBackendConnector` interface and `PowerSyncBuilder` for building a `PowerSync` instance. It also defines |
| 11 | +- `commonMain` - Shared code for all targets, which includes the `PowerSyncBackendConnector` |
| 12 | + interface and `PowerSyncBuilder` for building a `PowerSync` instance. It also defines |
10 | 13 | the `DatabaseDriverFactory` class to be implemented in each platform. |
11 | | -- `commonJDBC` - A Java SQLite driver using the [Xerial JDBC Driver](https://github.com/xerial/sqlite-jdbc). This is used by both the Android and JVM drivers. |
12 | | -- `androidMain` - Android specific code, which includes an implementation of `DatabaseDriverFactory`. |
| 14 | +- `commonJava` - Common Java code including a Java SQLite driver using |
| 15 | + the [Xerial JDBC Driver](https://github.com/xerial/sqlite-jdbc). This is used by both the Android |
| 16 | + and JVM drivers. |
| 17 | +- `androidMain` - Android specific code, which includes an implementation of |
| 18 | + `DatabaseDriverFactory`. |
13 | 19 | - `jvmMain` - JVM specific code which includes an implementation of `DatabaseDriverFactory`. |
14 | | -- `iosMain` - iOS specific code, which includes am implementation of `DatabaseDriverFactory` class that creates an instance of `app.cash.sqldelight.driver.native.NativeSqliteDriver` and also sets up native SQLite bindings for iOS. |
| 20 | +- `iosMain` - iOS specific code, which includes am implementation of `DatabaseDriverFactory` class |
| 21 | + that creates an instance of `app.cash.sqldelight.driver.native.NativeSqliteDriver` and also sets |
| 22 | + up native SQLite bindings for iOS. |
15 | 23 |
|
16 | 24 | ## Note on SQLDelight |
17 | 25 |
|
18 | | -The PowerSync core module, internally makes use of [SQLDelight](https://cashapp.github.io/sqldelight) for it database API and typesafe database query generation. |
| 26 | +The PowerSync core module, internally makes use |
| 27 | +of [SQLDelight](https://cashapp.github.io/sqldelight) for it database API and typesafe database |
| 28 | +query generation. |
19 | 29 |
|
20 | | -The PowerSync core module does not currently support integrating with SQLDelight from client applications. |
| 30 | +The PowerSync core module does not currently support integrating with SQLDelight from client |
| 31 | +applications. |
0 commit comments