Flutter数据库管理插件sql_commander的使用

Flutter数据库管理插件sql_commander的使用

sql_commander 是一个支持多种数据库的SQL命令链处理和执行器，内置了对MySQL和PostgreSQL的支持。

动机

创建这个包的主要动机是为了在远程位置方便地执行SQL查询链。通过部署一个数据库无关的SQL链命令执行器 (sql_commander)，可以简化维护并减少远程设备上的问题。该执行器接收 DBCommand 并远程执行它们，同时适应特定的数据库方言，并解析SQL链引用和ID。

使用方法

DBCommand 示例

以下是一个使用 DBCommand 的示例：

import 'package:sql_commander/sql_commander_postgres.dart';

void main() async {
  // DBCommand SQLs链：
  var dbCommandSQLs = [
    // 提供参数 %SYS_USER% 在以下插入语句中：
    SQL(
      '%SYS_USER%',
      'user',
      SQLType.SELECT,
      where: SQLConditionValue('id', '>', 0),
      returnColumns: {'user_id': 'id'},
      orderBy: '>user_id',
      limit: 1,
    ),
    // 提供参数 %TAB_NUMBER% 在以下插入语句中：
    SQL(
      '%TAB_NUMBER%',
      'tab',
      SQLType.SELECT,
      where: SQLConditionGroup.and([
        SQLConditionValue('serie', '=', 'tabs'),
        SQLConditionGroup.or([
          SQLConditionValue('status', '=', 'free'),
          SQLConditionValue('status', '=', null),
        ])
      ]),
      returnColumns: {'num': null},
      orderBy: '>num',
      limit: 1,
    ),
    // 使用 %SYS_USER% 和 %TAB_NUMBER% 作为参数插入到表 `order` 中：
    SQL(
      // 此SQL的ID，用于命令链中的引用：`#order:1001#`
      '1001',
      'order',
      SQLType.INSERT,
      parameters: {
        'product': 123,
        'price': 10.20,
        'title': 'Water',
        'user': '%SYS_USER%',
        'tab': '%TAB_NUMBER%',
      },
      variables: {'SYS_USER': null, 'TAB_NUMBER': null},
      returnLastID: true,
    ),
    // 另一个插入语句，使用上面的插入语句：`#order:1001#`
    SQL(
      // 此SQL的ID，用于引用：
      '1',
      'order_history',
      SQLType.INSERT,
      parameters: {
        // 上面插入的订单：
        'order': '#order:1001#',
        'date': DateTime.now(),
      },
      returnLastID: true,
    ),
  ];

  // 将DBCommand作为JSON：
  var commandJSON = {
    "host": 'localhost',
    "port": 5432,
    "user": 'root',
    "pass": 'abc123',
    "db": 'dev',
    "software": 'postgres',
    "sqls": dbCommandSQLs.map((e) => e.toJson()).toList(),
  };

  // 从JSON加载DBCommand：
  var dbCommand = DBCommand.fromJson(commandJSON);

  // 注册PostgreSQL连接实现：
  DBConnectionPostgres.register();
  // 对于MySQL：
  // DBConnectionMySQL.register();

  // 执行SQL链：
  var ok = await dbCommand.execute(
    logInfo: (m) => print('[INFO] $m'),
    logError: (m, [e, s]) => print('[ERROR] $m >> $e\n$s'),
  );

  print('SQL链执行结果: $ok');
}

Procedure 示例

你也可以定义一个 Procedure，其中包含一个动态的Dart代码，可以在任何由Dart支持的平台上加载。

import 'package:sql_commander/sql_commander_postgres.dart';

void main() async {
  // 注册PostgreSQL连接实现：
  DBConnectionPostgres.register();
  // 对于MySQL：
  // DBConnectionMySQL.register();

  // DBCommand SQLs链：
  var sqls = [
    // 提供参数 %SYS_USER% 在以下插入语句中：
    SQL(
      '%SYS_USER%',
      'user',
      SQLType.SELECT,
      where: SQLConditionValue('id', '>', 0),
      returnColumns: {'user_id': 'id'},
      orderBy: '>user_id',
      limit: 1,
    ),
    // 提供参数 %TAB_NUMBER% 在以下插入语句中：
    SQL(
      '%TAB_NUMBER%',
      'tab',
      SQLType.SELECT,
      where: SQLConditionGroup.and([
        SQLConditionValue('serie', '=', 'tabs'),
        SQLConditionGroup.or([
          SQLConditionValue('status', '=', 'free'),
          SQLConditionValue('status', '=', null),
        ])
      ]),
      returnColumns: {'num': null},
      orderBy: '>num',
      limit: 1,
    ),
    // 使用 %SYS_USER% 和 %TAB_NUMBER% 作为参数插入到表 `order` 中：
    SQL(
      // 此SQL的ID，用于命令链中的引用：`#order:1001#`
      '1001',
      'order',
      SQLType.INSERT,
      parameters: {
        'product': 123,
        'price': 10.20,
        'title': 'Water',
        'user': '%SYS_USER%',
        'tab': '%TAB_NUMBER%',
      },
      variables: {'SYS_USER': null, 'TAB_NUMBER': null},
      returnLastID: true,
    ),
    // 另一个插入语句，使用上面的插入语句：`#order:1001#`
    SQL(
      // 此SQL的ID，用于引用：
      '1',
      'order_history',
      SQLType.INSERT,
      parameters: {
        // 上面插入的订单：
        'order': '#order:1001#',
        'date': DateTime.now(),
      },
      returnLastID: true,
    ),
  ];

  var dbCommand = DBCommand(
      id: 'cmd_1', 'localhost', 5432, 'root', '123456', 'postgres', '', sqls);

  var procedure = ProcedureDart(
    name: 'do',
    dbCommands: [dbCommand],
    code: r'''
  
      int do() {
        var cmdOK = executeDBCommandByID("cmd_1");
        
        if (!cmdOK) {
          print('** Error executing DBCommand!');
          return false;
        }
        
        print('DBCommand `cmd_1` executed.');
        
        var tabNumber = getSQLResult('%TAB_NUMBER%');
        print('TAB_NUMBER: $tabNumber');
        
        return tabNumber ;
      }
      
    ''',
  );

  var tabNumber = await procedure.execute();
  print("Procedure结果> tabNumber: $tabNumber");
}