Flutter数据库交互插件faunadb_http的使用

Flutter数据库交互插件faunadb_http的使用

简介

faunadb_http 是一个纯 Dart 实现的 FaunaDB 客户端库。该库提供了与 FQL（Fauna Query Language）函数非常相似的查询类，使得在 Flutter 项目中与 FaunaDB 进行交互变得简单。

使用方法

基本示例

以下是一个简单的示例，展示了如何使用 faunadb_http 插件与 FaunaDB 进行交互。我们将创建一个客户端，执行一个查询，并打印结果。

import 'package:faunadb_http/faunadb_http.dart';
import 'package:faunadb_http/query.dart';

void main() async {
  // 构建 FaunaDB 配置
  final config = FaunaConfig.build(
    secret: '<your_secret_here>',  // 替换为你的 FaunaDB 秘钥
  );

  // 创建 FaunaDB 客户端
  final client = FaunaClient(config);

  // 构建查询：获取所有客户的数据
  final query = Paginate(Match(Index('all_customers')));

  // 执行查询并获取结果
  final result = await client.query(query);
  print(result);

  // 关闭客户端连接
  client.close();
}

编写查询

导入查询类后，你可以编写类似于 FQL 的查询。以下是几个常见的查询示例：

创建集合、文档、索引和函数

// 创建集合
final createCollection = CreateCollection(Obj({'name': 'users'}));

// 创建文档
final createDocument = Create(
  Collection('users'),
  Obj({
    'data': {'name': 'Gavan Singh'}
  }),
);

// 创建索引
final createIndex = CreateIndex(Obj({
  'name': 'user-by-name',
  'source': Collection('users'),
  'terms': [
    {
      'field': ['data', 'name']
    }
  ]
}));

// 创建函数
final createFunction = CreateFunction(Obj({
  'name': 'double',
  'body': Query(Lambda('x', Add([Var('x'), Var('x')])))
}));

读取数据

// 调用函数
final callDoubleFunction = Call(Function_('double'), arguments: 2);

// 分页查询用户
final paginateUsers = Paginate(
  Match(Index('user-by-name'), terms: ['Gavan Singh']),
);

// 获取单个用户
final readUser = Get(Ref(Collection('users'), '281080202238362125'));

// 获取所有用户
final readAllUsers = Map_(
  Paginate(Match(Index('all_Users'))),
  Lambda(
    'userRef',
    Let(
      {
        'userDoc': Get(Var('userRef')),
      },
      Obj(
        {
          'id': Select(['ref', 'id'], Var('userDoc')),
          'name': Select(['data', 'name'], Var('userDoc')),
        },
      ),
    ),
  ),
);

// 获取所有集合
final paginateCollections = Paginate(Collections());

更新和删除数据

// 更新用户
final updateUser = Update(
  Ref(Collection('users'), '281080202238362125'),
  Obj({
    'data': {'isCool': true}
  }),
);

// 删除用户
final deleteUser = Delete(Ref(Collection('users'), '281080202238362125'));

查询差异

在某些情况下，Dart 中的查询与纯 FQL 稍有不同。以下是几种常见的情况：

• 可选参数：FQL 中的可选参数在 Dart 中作为命名参数传递。

  Repeat('x', number: 10)
  Paginate(Collections(), size: 2)
  

• 变长参数：接受多个参数的 FQL 函数（如 Sum、GT 等）在 Dart 中接受一个列表。

  Add([1, Var('x')])
  

• 保留关键字：一些 FQL 函数和参数是 Dart 中的保留关键字，因此需要在末尾添加下划线。

  Map_  // 代替 Map
  Function_  // 代替 Function
  default_  // 代替 default
  

构建

json_serializable 包提供了查询类的 JSON 序列化功能。你可以运行以下命令来生成序列化代码：

pub run build_runner build

如果你正在尝试不同的查询，可以使用以下命令实时生成代码：

pub run build_runner watch

示例项目

以下是一个完整的示例项目，展示了如何在 Flutter 中使用 faunadb_http 插件与 FaunaDB 进行交互。

import 'package:faunadb_http/faunadb_http.dart';
import 'package:faunadb_http/query.dart';

/*
* FaunaDB secret 应该作为第一个参数传递
* `dart ./main.dart <your_secret_here>`
* */
void main(List<String> arguments) async {
  // 构建 FaunaDB 配置
  final config = FaunaConfig.build(
    secret: arguments[0],  // 替换为你的 FaunaDB 秘钥
  );

  // 或者直接在代码中指定秘钥
  // final config = FaunaConfig.build(secret: '<your_secret_here>');

  // 创建 FaunaDB 客户端
  final client = FaunaClient(config);

  // 构建查询：获取所有集合
  final query = Paginate(Collections());
  print('query=>\n$query');

  // 执行查询并获取响应
  final response = await client.query(query);
  if (response.hasErrors) {
    print('error=>\n${response.errors}');
  } else {
    print('response=>\n${response.resource}');
  }

  // 关闭客户端连接
  client.close();
}