Flutter数据库查询插件cli_sql_query的使用

Flutter数据库查询插件cli_sql_query的使用

在Flutter项目中，如果需要与SQLite数据库进行交互，可以使用cli_sql_query插件。以下是使用该插件的基本步骤及完整示例。

使用步骤

  1. 激活插件 首先，需要全局激活cli_sql_query插件。

    flutter pub global activate cli_sql_query

  2. 生成模型文件 使用以下命令生成数据库相关的模型文件，并将其保存到database/generate.json中。

    flutter pub global run cli_sql_query build

  3. 重新生成模型（可选） 如果需要更新或重新生成模型，可以再次运行上述命令。

    flutter pub global run cli_sql_query build

完整示例Demo

以下是一个完整的示例，展示如何使用cli_sql_query插件来查询数据库。

1. 添加依赖

首先，在pubspec.yaml文件中添加cli_sql_query依赖：

dependencies:
  cli_sql_query: ^1.0.0

然后运行以下命令安装依赖：

flutter pub get
2. 创建数据库模型

创建一个名为database.g.dart的文件，并在其中定义数据库表结构。例如：

// database.g.dart
import 'package:cli_sql_query/cli_sql_query.dart';

@Query(
  tableName: 'users',
  fields: [
    Field(name: 'id', type: FieldType.int, isPrimaryKey: true),
    Field(name: 'name', type: FieldType.text),
    Field(name: 'age', type: FieldType.int),
  ],
)
class User {}
3. 初始化数据库

在应用程序中初始化数据库并执行查询操作：

// main.dart
import 'package:flutter/material.dart';
import 'package:cli_sql_query/cli_sql_query.dart';
import 'database.g.dart';

void main() {
  runApp(MyApp());
}

class MyApp extends StatelessWidget {
  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        appBar: AppBar(title: Text('cli_sql_query 示例')),
        body: Center(
          child: ElevatedButton(
            onPressed: () async {
              // 初始化数据库
              final db = await DatabaseHelper().openDatabase();

              // 查询所有用户
              final users = await db.query(User);

              // 打印查询结果
              print(users);
            },
            child: Text('查询用户'),
          ),
        ),
      ),
    );
  }
}

class DatabaseHelper {
  Future<Database> openDatabase() async {
    return DatabaseHelper().openDatabase();
  }
}

更多关于Flutter数据库查询插件cli_sql_query的使用的实战教程也可以访问 https://www.itying.com/category-92-b0.html

1 回复

更多关于Flutter数据库查询插件cli_sql_query的使用的实战系列教程也可以访问 https://www.itying.com/category-92-b0.html


cli_sql_query 是一个用于在 Flutter 应用中执行 SQL 查询的插件。它提供了一个简单的 API，允许开发者直接在 Flutter 应用中执行 SQL 查询并获取结果。以下是如何使用 cli_sql_query 插件的基本步骤：

1. 添加依赖

首先，你需要在 pubspec.yaml 文件中添加 cli_sql_query 插件的依赖：

dependencies:
  flutter:
    sdk: flutter
  cli_sql_query: ^0.0.1  # 请确保使用最新版本

然后运行 flutter pub get 来获取依赖。

2. 导入插件

在需要使用 cli_sql_query 的 Dart 文件中导入插件：

import 'package:cli_sql_query/cli_sql_query.dart';

3. 初始化数据库连接

在使用插件之前，你需要初始化数据库连接。你可以通过 SQLConnection 类来实现：

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

  // 初始化数据库连接
  SQLConnection connection = SQLConnection();
  await connection.connect(
    host: 'your_database_host',
    port: 5432, // 默认 PostgreSQL 端口
    database: 'your_database_name',
    username: 'your_username',
    password: 'your_password',
  );

  runApp(MyApp(connection: connection));
}

4. 执行 SQL 查询

你可以使用 SQLConnection 实例来执行 SQL 查询。例如，执行一个简单的 SELECT 查询：

class MyApp extends StatelessWidget {
  final SQLConnection connection;

  MyApp({required this.connection});

  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        appBar: AppBar(
          title: Text('SQL Query Example'),
        ),
        body: FutureBuilder<List<Map<String, dynamic>>>(
          future: connection.query('SELECT * FROM your_table'),
          builder: (context, snapshot) {
            if (snapshot.connectionState == ConnectionState.waiting) {
              return Center(child: CircularProgressIndicator());
            } else if (snapshot.hasError) {
              return Center(child: Text('Error: ${snapshot.error}'));
            } else if (!snapshot.hasData || snapshot.data!.isEmpty) {
              return Center(child: Text('No data found'));
            } else {
              return ListView.builder(
                itemCount: snapshot.data!.length,
                itemBuilder: (context, index) {
                  var row = snapshot.data![index];
                  return ListTile(
                    title: Text(row['column_name']),
                    subtitle: Text(row['another_column_name']),
                  );
                },
              );
            }
          },
        ),
      ),
    );
  }
}

5. 关闭数据库连接

在应用退出或不再需要数据库连接时，确保关闭连接以释放资源：

void dispose() async {
  await connection.disconnect();
}

6. 处理错误

在实际应用中，你可能会遇到各种错误，如连接失败、查询错误等。确保在你的代码中适当地处理这些错误。

7. 其他操作

cli_sql_query 插件还支持其他操作，如插入、更新、删除等。你可以使用 connection.execute() 方法来执行这些操作。

await connection.execute('INSERT INTO your_table (column1, column2) VALUES (?, ?)', ['value1', 'value2']);
回到顶部