Flutter未知功能插件wazeloquent的使用（由于介绍为undefined，故功能需实际查询后确定，此句仅为符合SEO要求的格式示例）

Flutter WazEloquent 插件的使用

WazEloquent 是一个专门为 Flutter 设计的数据库操作插件，它基于 Sqflite 并且模仿了 Laravel 的 Eloquent 模型。通过使用 WazEloquent，开发者可以轻松地处理数据库操作而无需编写复杂的 SQL 查询。

特性

• 不需要创建自己的数据库类。只需使用 DB 类的方法，如 onCreate, onOpen, onConfigure, onUpgrade, onDowngrade。
• 轻松处理表数据，无需编写原始查询。
• 提供类似于 Laravel Eloquent 的方法。
• 支持关系管理。

开始使用

安装包

首先，将 WazEloquent 添加到你的 pubspec.yaml 文件中：

$ flutter pub add wazeloquent

扩展 Eloquent 并配置必需的方法

创建一个继承自 Eloquent 的类，并实现必要的方法：

class UserEloquent extends Eloquent {
  @override
  // 定义表的列
  List<String> get columns => ['id','name','password','createdAt','updatedAt'];

  @override
  // 定义主键列
  String get getPrimaryColumn => 'id';

  @override
  // 定义表名
  String get tableName => 'users';
}

创建表前使用 Eloquent

在使用 Eloquent 之前，你需要先创建表。可以通过注册 onCreate 和 onOpen 方法来实现：

void main() async {
  WidgetsFlutterBinding.ensureInitialized();

  var db = DB.instance;

  db.setDbVersion(1); // 可选：设置数据库版本，默认为 1
  db.setFileName('example.db'); // 可选：设置文件名，默认为 sqflite.db

  db.onCreate([
    UserEloquent.onCreate,
    CarEloquent.onCreate,
    StudentEloquent.onCreate,
    ClassEloquent.onCreate
  ]);

  db.onOpen([
    UserEloquent.onOpen,
    CarEloquent.onOpen,
    StudentEloquent.onOpen,
    ClassEloquent.onOpen
  ]);

  db.onConfigure([
    Future(() {
      return (Database db) async {
        await db.execute('PRAGMA foreign_keys = ON');
      };
    })
  ]);

  runApp(const MyApp());
}

使用现有数据库

如果要使用现有的数据库，你可以指定文件路径和文件名：

import 'package:path_provider/path_provider.dart';

var path = await getApplicationDocumentsDirectory();
var dir = path.absolute.path + '/test';
db.setFilePath(dir, shouldForceCreatePath: true); // 设置文件路径并创建文件夹
db.setFileName('example.db');

使用示例

where 条件查询

var userEloquent = UserEloquent();

// 获取名字为 "john" 的用户
userEloquent.where('name', 'john').get();

whereIn 查询

var userEloquent = UserEloquent();

// 获取 ID 为 1, 2, 或 4 的用户
userEloquent.whereIn('id', [1, 2, 4]).get();

orderBy 排序

var userEloquent = UserEloquent();

// 按 "name" 列升序排序
userEloquent.orderBy('name').get();

// 按 "name" 列降序排序
userEloquent.orderBy('name', sort: Sort.descending).get();

create 创建新记录

var userEloquent = UserEloquent();

// 创建一个新用户
userEloquent.create({'name': 'John', 'password': 'pass'});

update 更新记录

var userEloquent = UserEloquent();

// 更新所有用户的 "name" 字段
userEloquent.update({'name': 'john'});

// 更新 ID 为 1 的用户的 "name" 字段
userEloquent.where('id', 1).update({'name': 'john'});

delete 删除记录

var userEloquent = UserEloquent();

// 删除所有用户
userEloquent.delete();

// 删除名字包含 "j" 的用户
userEloquent.where('name', '%j%', operator: Operator.like).delete();

模型

模型不必继承自 Model 类，但这样做可以提供更多与表交互的方法。例如：

class User extends Model {
  Eloquent get eloquent => UserEloquent();

  dynamic get primaryValue => id;

  Map<String, Object?> get toJson => {
    'name': name,
    'createdAt': createdAt?.toIso8601String(),
    'updatedAt': updatedAt?.toIso8601String()
  };

  setPrimaryValue(value) {
    id = value;
  }
}