From d22592b88c317fd25c129c980ddd6903fb63806e Mon Sep 17 00:00:00 2001
From: Simon Binder <oss@simonbinder.eu>
Date: Mon, 20 Jan 2020 17:06:33 +0100
Subject: [PATCH] Explain how moor_ffi can work with existing databases

---
 docs/content/en/docs/Other engines/vm.md | 30 ++++++++++++++++++++----
 1 file changed, 26 insertions(+), 4 deletions(-)

diff --git a/docs/content/en/docs/Other engines/vm.md b/docs/content/en/docs/Other engines/vm.md
index 9c94ba45..fde84735 100644
--- a/docs/content/en/docs/Other engines/vm.md	
+++ b/docs/content/en/docs/Other engines/vm.md	
@@ -1,5 +1,5 @@
 ---
-title: Dart VM (Desktop support)
+title: moor_ffi (Desktop support)
 description: Run moor on both mobile and desktop
 ---
 
@@ -66,9 +66,9 @@ import 'package:sqflite/sqflite.dart' show getDatabasesPath;
 import 'package:path/path.dart' as p;
 
 LazyDatabase(() async {
-   final dbFolder = await getDatabasesPath();
-   final file = File(j.join(dbFolder, 'db.sqlite'));
-   return VmDatabase(file);
+  final dbFolder = await getDatabasesPath();
+  final file = File(j.join(dbFolder, 'db.sqlite'));
+  return VmDatabase(file);
 })
 ```
 
@@ -78,6 +78,28 @@ Please be aware that `FlutterQueryExecutor.inDatabaseFolder` might yield a diffe
 `path_provider` on Android. This can cause data loss if you've already shipped a version using
 `moor_flutter`. In that case, using `getDatabasePath` from sqflite is the suggested solution.
 
+## Using moor_ffi with an existing database
+
+If your existing sqlite database is stored as a file, you can just use `VmDatabase(thatFile)` - no further
+changes are required.
+
+If you want to load databases from assets or any other source, you can use a `LazyDatabase`.
+It allows you to perform some async work before opening the database:
+
+```dart
+// before
+VmDatabase(File('...'));
+
+// after
+LazyDatabase(() async {
+  final file = File('...');
+  if (!await file.exists()) {
+    // copy the file from an asset, or network, or any other source
+  }
+  return VmDatabase(file);
+});
+```
+
 ## Used compile options on Android
 
 Note: Android is the only platform where moor_ffi will compile sqlite. The sqlite3 library from the system