Remove sqlite_common_ffi from documentation, focus on Flutter/sqflite (#37)

* Initial plan

* Remove sqlite_common_ffi references from documentation, focus on Flutter/sqflite

Co-authored-by: graknol <[email protected]>

---------

Co-authored-by: copilot-swe-agent[bot] <[email protected]>
Co-authored-by: graknol <[email protected]>

Author: Copilot

declarative_sqlite/CURRENT_STATE.md

@@ -246,16 +246,10 @@ The package provides excellent testing support with in-memory databases:
 ```dart
 import 'package:test/test.dart';
 import 'package:declarative_sqlite/declarative_sqlite.dart';
-import 'package:sqflite_common_ffi/sqflite_ffi.dart';
 
 void main() {
   late DeclarativeDatabase database;
 
-  setUpAll(() {
-    sqfliteFfiInit();
-    databaseFactory = databaseFactoryFfi;
-  });
-
   setUp(() async {
     database = DeclarativeDatabase.memory(buildTestSchema);
   });

declarative_sqlite/README.md

@@ -19,16 +19,21 @@ Add the package to your `pubspec.yaml`:
 
 ```yaml
 dependencies:
+  flutter:
+    sdk: flutter
+  # Core library
   declarative_sqlite: ^1.0.1
-  # For standalone Dart apps, you need a native library loader.
-  sqflite_common_ffi: ^2.3.3
+  # Flutter integration package
+  declarative_sqlite_flutter: ^1.0.1
+  # Standard SQLite plugin for Flutter (Android/iOS)
+  sqflite: ^2.3.3
 ```
 
-### Example Usage (Standalone Dart)
+### Example Usage (Flutter)
 
 ```dart
-import 'package:declarative_sqlite/declarative_sqlite.dart';
-import 'package:sqflite_common_ffi/sqflite_ffi.dart';
+import 'package:flutter/material.dart';
+import 'package:declarative_sqlite_flutter/declarative_sqlite_flutter.dart';
 
 // 1. Define your database schema
 void buildSchema(SchemaBuilder builder) {
@@ -40,48 +45,68 @@ void buildSchema(SchemaBuilder builder) {
   });
 }
 
-Future<void> main() async {
-  // 2. Initialize the FFI driver (for desktop apps)
-  sqfliteFfiInit();
-  
-  // 3. Create schema
-  final schemaBuilder = SchemaBuilder();
-  buildSchema(schemaBuilder);
-  final schema = schemaBuilder.build();
-
-  // 4. Open the database
-  final database = await DeclarativeDatabase.open(
-    'my_app.db',
-    schema: schema,
-    fileRepository: FilesystemFileRepository('files'),
+void main() {
+  runApp(
+    // 2. Wrap your app with DatabaseProvider
+    DatabaseProvider(
+      databaseName: 'my_app.db',
+      schema: buildSchema,
+      child: const MyApp(),
+    ),
   );
+}
 
-  // 5. Insert data
-  await database.insert('users', {
-    'id': 'a1b2c3d4',
-    'name': 'Alice',
-    'age': 30,
-  });
-
-  // 6. Query data with the query builder
-  final users = await database.query((q) => 
-    q.from('users').where('age').isGreaterThan(25)
-  );
-  print('Users older than 25: $users');
-
-  // 7. Use streaming queries for reactive UIs
-  final userStream = database.streamQuery((q) => q.from('users'));
-  final subscription = userStream.stream.listen((userList) {
-    print('Current users: ${userList.length}');
-  });
+class MyApp extends StatelessWidget {
+  const MyApp({super.key});
 
-  // Changes will automatically be pushed to the stream
-  await database.update('users', {'age': 31}, 
-    where: 'name = ?', whereArgs: ['Alice']);
+  @override
+  Widget build(BuildContext context) {
+    return MaterialApp(
+      home: const HomeScreen(),
+    );
+  }
+}
 
-  // Clean up
-  await subscription.cancel();
-  await database.close();
+class HomeScreen extends StatelessWidget {
+  const HomeScreen({super.key});
+
+  @override
+  Widget build(BuildContext context) {
+    // 3. Access the database from any descendant widget
+    final database = DatabaseProvider.of(context);
+    
+    return Scaffold(
+      appBar: AppBar(title: const Text('Declarative SQLite Demo')),
+      body: Column(
+        children: [
+          ElevatedButton(
+            onPressed: () async {
+              // 4. Insert data
+              await database.insert('users', {
+                'id': 'a1b2c3d4',
+                'name': 'Alice',
+                'age': 30,
+              });
+            },
+            child: const Text('Add User'),
+          ),
+          // 5. Use QueryListView for reactive data display
+          Expanded(
+            child: QueryListView<DbRecord>(
+              query: (q) => q.from('users').where('age').isGreaterThan(25),
+              mapper: (row, db) => DbRecord(row, 'users', db),
+              itemBuilder: (context, user) {
+                return ListTile(
+                  title: Text(user.getValue('name')!),
+                  subtitle: Text('Age: ${user.getValue('age')}'),
+                );
+              },
+            ),
+          ),
+        ],
+      ),
+    );
+  }
 }
 ```
 

docs/docs/getting-started/defining-a-schema.md

@@ -90,19 +90,22 @@ void buildAppSchema(SchemaBuilder builder) {
 
 ## Usage in Your Application
 
-Once you've defined your schema function, you'll use it when opening the database:
-
-```dart
-final schemaBuilder = SchemaBuilder();
-buildAppSchema(schemaBuilder);
-final schema = schemaBuilder.build();
-
-final database = await DeclarativeDatabase.open(
-  'app.db',
-  databaseFactory: databaseFactoryFfi,
-  schema: schema,
-  fileRepository: FilesystemFileRepository('files'),
-);
+Once you've defined your schema function, you'll use it with the `DatabaseProvider` widget:
+
+```dart title="lib/main.dart"
+import 'package:flutter/material.dart';
+import 'package:declarative_sqlite_flutter/declarative_sqlite_flutter.dart';
+import 'database/schema.dart';
+
+void main() {
+  runApp(
+    DatabaseProvider(
+      databaseName: 'app.db',
+      schema: buildAppSchema,
+      child: const MyApp(),
+    ),
+  );
+}
 ```
 
 ## Next Steps

docs/docs/getting-started/initializing-the-database.md

@@ -4,9 +4,9 @@ sidebar_position: 3
 
 # Initializing the Database
 
-Once you have defined your schema, the next step is to create and initialize a `DeclarativeDatabase` instance. This process involves connecting to the database file, analyzing the existing schema, and automatically applying any necessary migrations.
+Once you have defined your schema, the next step is to create and initialize a `DeclarativeDatabase` instance using the `DatabaseProvider` widget. This process involves connecting to the database file, analyzing the existing schema, and automatically applying any necessary migrations.
 
-## Using `DatabaseProvider` (Flutter)
+## Using `DatabaseProvider`
 
 In a Flutter application, the easiest way to manage the database lifecycle is with the `DatabaseProvider` widget. It handles initialization, closing the connection, and making the database instance available to the entire widget tree.
 
@@ -51,61 +51,12 @@ class HomeScreen extends StatelessWidget {
     final database = DatabaseProvider.of(context);
 
     return Scaffold(
-      // ...
+      // Your app UI here...
     );
   }
 }
 ```
 
-## Manual Initialization (Standalone Dart)
-
-In a standalone Dart application, you create and initialize the `DeclarativeDatabase` instance manually.
-
-You'll need to provide:
-- `path`: The path to the database file.
-- `schema`: A reference to your schema builder function.
-- `dbFactory`: The database factory from `sqflite_common_ffi`.
-
-```dart title="bin/my_app.dart"
-import 'package:declarative_sqlite/declarative_sqlite.dart';
-import 'package:sqflite_common_ffi/sqflite_ffi.dart';
-import 'path/to/your/schema.dart';
-
-Future<void> main() async {
-  // 1. Initialize the FFI driver
-  sqfliteFfiInit();
-
-  // 2. Build the schema
-  final schemaBuilder = SchemaBuilder();
-  buildAppSchema(schemaBuilder);
-  final schema = schemaBuilder.build();
-
-  // 3. Open the database
-  final database = await DeclarativeDatabase.open(
-    'my_app.db',
-    databaseFactory: databaseFactoryFfi,
-    schema: schema,
-    fileRepository: FilesystemFileRepository('files'),
-  );
-
-  print('Database opened successfully!');
-
-  // Your application logic here...
-  await database.insert('users', {
-    'id': '1',
-    'name': 'Alice',
-    'email': '[email protected]',
-  });
-
-  // Query data
-  final users = await database.queryMaps((q) => q.from('users'));
-  print('Users: $users');
-
-  // 4. Close the database when done
-  await database.close();
-}
-```
-
 ## Automatic Migrations
 
 The first time you initialize the database, `declarative_sqlite` will:
@@ -124,7 +75,6 @@ This process is fully automatic. You only need to update your schema in your Dar
 
 You can enable detailed logging for the migration process by setting the `logStatements` flag to `true`. This is useful for debugging what happens during initialization.
 
-**In Flutter:**
 ```dart
 DatabaseProvider(
   databaseName: 'app.db',
@@ -134,17 +84,6 @@ DatabaseProvider(
 )
 ```
 
-**In Dart:**
-```dart
-final database = DeclarativeDatabase(
-  path: 'my_app.db',
-  schema: appSchema,
-  dbFactory: dbFactory,
-  logStatements: true, // Enable logging
-);
-await database.init();
-```
-
 ## Next Steps
 
 With your database initialized, you are now ready to perform CRUD operations and run queries.

docs/docs/getting-started/installation.md

@@ -4,15 +4,11 @@ sidebar_position: 1
 
 # Installation
 
-Setting up `declarative_sqlite` involves adding the required packages to your `pubspec.yaml` and choosing the appropriate SQLite driver for your target platform.
+Setting up `declarative_sqlite` for Flutter involves adding the required packages to your `pubspec.yaml`. The library uses the standard `sqflite` plugin for Android and iOS compatibility.
 
-## 1. Add Dependencies
+## Add Dependencies
 
-The ecosystem is split into multiple packages. Add the ones you need for your project.
-
-### For Flutter Projects
-
-For a standard Flutter application, you'll need the core library, the Flutter integration package, and the `sqflite` driver. If you plan to use code generation (recommended), you'll also need the generator and `build_runner`.
+For a Flutter application, you'll need the core library, the Flutter integration package, and the `sqflite` driver. If you plan to use code generation (recommended), you'll also need the generator and `build_runner`.
 
 ```yaml title="pubspec.yaml"
 dependencies:
@@ -22,7 +18,7 @@ dependencies:
   declarative_sqlite: ^1.0.1
   # Flutter-specific widgets and helpers
   declarative_sqlite_flutter: ^1.0.1
-  # Standard SQLite plugin for Flutter
+  # Standard SQLite plugin for Flutter (Android/iOS)
   sqflite: ^2.3.3
 
 dev_dependencies:
@@ -32,42 +28,11 @@ dev_dependencies:
   build_runner: ^2.4.10
 ```
 
-### For Standalone Dart Projects
-
-For command-line or server-side Dart applications, you'll need the core library and the `sqflite_common_ffi` driver.
+After adding the dependencies, run `flutter pub get` to install them.
 
-```yaml title="pubspec.yaml"
-dependencies:
-  # Core library
-  declarative_sqlite: ^1.0.1
-  # FFI-based SQLite driver for Dart
-  sqflite_common_ffi: ^2.3.3
-
-dev_dependencies:
-  # Code generator for DbRecord classes
-  declarative_sqlite_generator: ^1.0.1
-  # Standard Dart build tool
-  build_runner: ^2.4.10
-```
-
-After adding the dependencies, run `flutter pub get` or `dart pub get` to install them.
-
-## 2. Initialize the Database Driver (Dart Only)
-
-For standalone Dart applications using FFI, you need to initialize the `sqflite_common_ffi` driver at the beginning of your application's entry point.
-
-```dart title="bin/my_app.dart"
-import 'package:sqflite_common_ffi/sqflite_ffi.dart';
-
-void main() {
-  // Initialize FFI
-  sqfliteFfiInit();
-
-  // Your application logic here...
-}
-```
+## Database Initialization
 
-Flutter projects using the standard `sqflite` package do **not** need this step, as initialization is handled automatically.
+Flutter projects using the `sqflite` package do **not** need any special initialization steps. The SQLite driver is automatically available on Android and iOS platforms.
 
 ## Next Steps