Flutter PostgreSQL ORM插件needle_orm_postgres的使用

Flutter PostgreSQL ORM插件needle_orm_postgres的使用

needle_orm_postgres 是一个用于在 Flutter 应用中与 PostgreSQL 数据库交互的 ORM 插件。它基于 needle_orm 并提供了对 PostgreSQL 数据库的支持。

重要事项

当使用 IN 语句时，参数名称后面必须跟一个空格！以下是一个错误示例：

'SELECT * FROM books where id in @idList'

正确的写法应该是：

'SELECT * FROM books where id in @idList '

完整示例

以下是使用 needle_orm_postgres 的完整示例代码。

初始化数据库连接

首先，我们需要初始化与 PostgreSQL 数据库的连接。这可以通过 initPostgreSQL 函数完成。

import 'package:mysql1/mysql1.dart';
import 'package:needle_orm/needle_orm.dart';
import 'package:needle_orm_postgres/needle_orm_postgres.dart';

// 初始化 PostgreSQL 数据库连接
Future<Database> initPostgreSQL() async {
  return PostgreSqlPoolDatabase(PgPool(
    PgEndpoint(
      host: 'localhost',
      port: 5432,
      database: 'needle',
      username: 'postgres',
      password: 'postgres',
    ),
    settings: PgPoolSettings()
      ..maxConnectionAge = Duration(hours: 1) // 设置最大连接年龄为1小时
      ..concurrency = 5, // 设置并发数为5
  ));
}

定义模型

接下来，我们定义一个简单的模型类 Book。

class Book {
  int? id;
  String title;
  String author;

  Book({this.id, required this.title, required this.author});
}

创建表

使用 needle_orm 和 needle_orm_postgres 提供的功能创建表。

import 'package:needle_orm/needle_orm.dart';
import 'package:needle_orm_postgres/needle_orm_postgres.dart';

class BookModel extends Model<Book> {
  final int? id;
  final String title;
  final String author;

  BookModel({this.id, required this.title, required this.author});

  static const tableName = 'books';

  static final columns = [
    Column('id', isPrimaryKey: true),
    Column('title'),
    Column('author'),
  ];

  factory BookModel.fromMap(Map<String, dynamic> map) {
    return BookModel(
      id: map['id'],
      title: map['title'],
      author: map['author'],
    );
  }

  Map<String, dynamic> toMap() {
    return {
      'id': id,
      'title': title,
      'author': author,
    };
  }
}

插入数据

插入一条新的书籍记录到数据库。

void main() async {
  // 初始化数据库连接
  Database db = await initPostgreSQL();

  // 创建表
  await db.createTable(BookModel);

  // 插入数据
  await db.insert(BookModel(
    title: 'Dart编程实战',
    author: '张三',
  ));

  print('数据插入成功');
}

查询数据

查询数据库中的所有书籍记录。

void main() async {
  // 初始化数据库连接
  Database db = await initPostgreSQL();

  // 查询所有书籍
  List<Book> books = await db.select(BookModel);

  // 打印查询结果
  books.forEach((book) {
    print('ID: ${book.id}, Title: ${book.title}, Author: ${book.author}');
  });
}

更新数据

更新数据库中某本书的作者信息。

void main() async {
  // 初始化数据库连接
  Database db = await initPostgreSQL();

  // 更新书籍的作者
  await db.update(
    BookModel(id: 1, author: '李四'),
    where: 'id = [@id](/user/id) ',
    params: {'id': 1},
  );

  print('数据更新成功');
}

删除数据

删除数据库中某本书的记录。

void main() async {
  // 初始化数据库连接
  Database db = await initPostgreSQL();

  // 删除书籍
  await db.delete(BookModel, where: 'id = [@id](/user/id) ', params: {'id': 1});

  print('数据删除成功');
}