example/README.md

Examples #

한국어

Two of them. Start with JPetStore.

Fastest path #

cd petstore
dart pub get
dart run

No emulator, no browser, no Android Studio. It is a plain Dart console app against an in-memory SQLite database. The Flutter SDK does have to be installed — flutter_mybatis depends on it for asset loading — so use the dart that ships with Flutter.

To see the SQL as it runs:

dart run bin/petstore.dart --sql

Flutter app example #

cd flutter_app
flutter pub get
dart run build_runner build
flutter run

Why the console example is plain Dart #

The flutter_mybatis core does not depend on Flutter. There are two entry points:

// Pure Dart — console, server-side, tests
import 'package:flutter_mybatis/flutter_mybatis_core.dart';

// Flutter — the core plus asset loading (loadMapper / loadMappers)
import 'package:flutter_mybatis/flutter_mybatis.dart';

The core takes a Database from sqflite_common, so any driver works:

Only XML loading differs:

// Flutter: from assets
await factory.loadMapper('assets/petstore_mapper.xml');

// Console / server: from a file
factory.loadMapperFromString(File('assets/petstore_mapper.xml').readAsStringSync());