From 4a8456b7c66b0ed33b832a176452f0d1a0fce84b Mon Sep 17 00:00:00 2001 From: Vitus Date: Sun, 27 Dec 2020 00:59:27 +0100 Subject: [PATCH] Add isolates section to README (#466) --- README.md | 6 ++++++ floor/README.md | 6 ++++++ 2 files changed, 12 insertions(+) diff --git a/README.md b/README.md index 7ded3da7..37496b23 100644 --- a/README.md +++ b/README.md @@ -42,6 +42,7 @@ Refer to [GitHub Discussions](https://github.com/vitusortner/floor/discussions) 1. [In-Memory Database](#in-memory-database) 1. [Initialization Callback](#initialization-callback) 1. [Platform Support](#platform-support) +1. [Isolates](#isolates) 1. [Testing](#testing) 1. [Examples](#examples) 1. [Naming](#naming) @@ -712,6 +713,11 @@ The SQLite database access on iOS and Android is provided by [sqflite](https://g **There currently is no support for Flutter for web.** +## Isolates +As floor is based on sqflite, Android and iOS apps access the SQLite database on a native background thread. +On Linux, macOS, and Windows, a separate isolate is used. +You can do some further reading on sqflite's background work mechanisms [here](https://github.com/tekartik/sqflite/blob/master/sqflite/doc/usage_recommendations.md). + ## Testing Simply instantiate an in-memory database and run the database tests on your local development machine as shown in the following snippet. For more test references, check out the [project's tests](https://github.com/vitusortner/floor/tree/develop/floor/test/integration). diff --git a/floor/README.md b/floor/README.md index 7ded3da7..37496b23 100644 --- a/floor/README.md +++ b/floor/README.md @@ -42,6 +42,7 @@ Refer to [GitHub Discussions](https://github.com/vitusortner/floor/discussions) 1. [In-Memory Database](#in-memory-database) 1. [Initialization Callback](#initialization-callback) 1. [Platform Support](#platform-support) +1. [Isolates](#isolates) 1. [Testing](#testing) 1. [Examples](#examples) 1. [Naming](#naming) @@ -712,6 +713,11 @@ The SQLite database access on iOS and Android is provided by [sqflite](https://g **There currently is no support for Flutter for web.** +## Isolates +As floor is based on sqflite, Android and iOS apps access the SQLite database on a native background thread. +On Linux, macOS, and Windows, a separate isolate is used. +You can do some further reading on sqflite's background work mechanisms [here](https://github.com/tekartik/sqflite/blob/master/sqflite/doc/usage_recommendations.md). + ## Testing Simply instantiate an in-memory database and run the database tests on your local development machine as shown in the following snippet. For more test references, check out the [project's tests](https://github.com/vitusortner/floor/tree/develop/floor/test/integration).