Flutter数据库连接插件dart_odbc的使用

Flutter数据库连接插件dart_odbc的使用

dart_odbc 是一个用于与ODBC数据库交互的Dart包。它允许你在Dart应用程序中连接到ODBC数据源并直接执行SQL查询。

这个包受到由 Juan Mellado 开发的已弃用包 odbc 的启发。

使用方法

实例化ODBC类

通过提供ODBC驱动程序在主机上的路径来实例化ODBC类：

final odbc = DartOdbc(
  dsn: '<your_dsn>',
  pathToDriver: '<path_to_odbc_driver>',
);

DSN（可选）

DSN（数据源名称）是你在设置驱动程序管理器时给出的名称。更多信息可以查看 MySQL 文档。 如果没有提供DSN，只能通过连接字符串进行连接。

通过DSN连接到数据库

await odbc.connect(
  username: 'db_username',
  password: 'db_password',
);

通过连接字符串连接到数据库

await odbc.connectWithConnectionString(
  "DRIVER={Microsoft Excel Driver (*.xls, *.xlsx, *.xlsm, *.xlsb)};DBQ=C:\\Users\\Computer\\AppData\\Local\\Temp\\test.xlsx;",
);

执行SQL查询

final result = await odbc.execute("SELECT 10");

执行预编译语句

预编译语句可以防止SQL注入。

final List<Map<String, dynamic>> result = await odbc.execute(
  'SELECT * FROM USERS WHERE UID = ?',
  params: [1],
);

提供结果集列配置

抽象层DartOdbc应该能够处理大多数查询的输出。但是，对于列大小非常长或数据类型不常见的查询，由于默认内存分配问题，可能会导致输出被破坏。可以通过在execute方法的columnConfig参数中提供ColumnType来处理这些问题。

result = await odbc.execute(
  'SELECT * FROM USERS WHERE UID = ?',
  params: [1],

  /// The column config can be provided as this.
  /// But for most cases this config is not necessary
  /// This is only needed when the data fetching is not working as expected
  /// Only the columns with issues need to be provided
  columnConfig: {
    'NAME': ColumnType(size: 150),
    'DESCRIPTION': ColumnType(type: SQL_C_WCHAR, size: 500),
  },
);

结果将是一个包含Map对象的Future<List<Map<String, dynamic>>>，每个Map代表一行。如果出现问题，将抛出ODBCException异常。

获取表

final List<Map<String, String>> tables = await odbc.getTables();

断开数据库连接

最后，别忘了断开数据库连接并释放资源。

await odbc.disconnect();

直接访问ODBC驱动绑定

可以通过LibOdbc类执行原生ODBC方法。

测试环境

该包已在以下数据库服务器上进行了测试：

• Microsoft SQL Server
• Oracle

支持其他数据库服务器

虽然未经过测试，但该插件应该适用于任何提供ODBC驱动程序的数据库。有关支持的数据库服务器的详细列表，请参阅官方 unixodbc 网站的“驱动程序”部分。

支持项目

大家好！我在兼顾学习和其他责任的同时积极维护这个项目。如果你觉得我的工作有用，并且希望帮助我继续改进这个项目，请考虑支持我！你的贡献将帮助我支付费用、买更多咖啡☕，并投入更多时间进行开发。🙏

每一点帮助都非常重要，我非常感谢你的支持。谢谢你们帮助我保持这个项目的运行！💛

示例代码

以下是完整的示例代码：

import 'package:dart_odbc/dart_odbc.dart';
import 'package:dotenv/dotenv.dart';

void main(List<String> args) {
  run(args);
}

Future<void> run(List<String> args) async {
  // 加载环境变量
  final DotEnv env = DotEnv()..load(['.env']);

  // 数据库用户名
  final username = env['USERNAME'];
  // 数据库密码
  final password = env['PASSWORD'];

  final dsn = env['DSN'];

  // 可选选择数据库
  final db = env['DATABASE'];

  final odbc = DartOdbc(dsn: dsn);
  await odbc.connect(username: username!, password: password!);

  if (db != null) {
    await odbc.execute('USE $db');
  }

  List<Map<String, dynamic>> result = await odbc.execute(
    args[0], // SQL 查询
    params: args.sublist(1), // SQL 查询参数
    columnConfig: {
      "COL1": ColumnType(size: 100),
    },
  );

  print(result);

  // 断开数据库连接
  await odbc.disconnect();
}