パッケージ、リポジトリ、アプリカテゴリを検索

パッケージ詳細v0.0.6+6

quds_db

データベースとテーブルの作成、CRUD操作、モデル化されたクエリを簡素化するsqflite拡張パッケージ

AndroidiOSmacOSWindowsLinux
30日間ダウンロード
16
いいね数
33
Pub ポイント
140

パッケージをインストール

flutter pub add quds_db

パッケージ概要

公開情報に基づく選定ガイドです。参考としてご利用ください。

quds_db は、sqflite を拡張してデータベース管理を簡素化する Flutter/Dart パッケージです。データベースとテーブルの作成をスムーズにし、CRUD 操作をサポートし、モデルベースのクエリを可能にします。複雑な SQL ロジックを抽象化することで、開発者が Dart モデルを使って構造化されたデータを扱い、ボイラープレートコードを削減できます。このパッケージは、複数のプラットフォームでローカルの SQLite データベースに対して効率的かつ型安全な操作を行うように設計されています。

用途

  • モバイルアプリにおけるローカルデータの永続化
  • モデルを使用したCRUD操作の簡素化
  • オフライン優先のアプリケーションの構築
  • 構造化されたアプリデータの管理
  • データベースのセットアップとマイグレーションを最適化する

主な機能

  • モデル駆動型のデータベース操作
  • 組み込みの CRUD メソッド
  • モデルからのテーブルの自動作成
  • モデルマッピングを伴う複雑なクエリのサポート
  • クロスプラットフォームSQLite統合

適している対象

  • sqfliteの簡素化を求める開発者
  • ローカルデータベースストレージを必要とするプロジェクト
  • オフライン機能を必要とするアプリ
  • コードの読みやすさを最優先とするチーム
  • 構造化データを備えたFlutterアプリが必要です

注意事項

  • sqflite の基礎を理解している必要があります
  • SQLiteデータベースバックエンドに限定
  • 高度なクエリのためには追加のセットアップが必要になる場合があります
  • 正しいモデルクラス定義に依存しています
  • クラウドベースまたはリアルタイムデータには適していません

元の README

関連するソースリポジトリの README 原文のスナップショットです。最新の内容はリポジトリをご覧ください。

Quds Db

Is an automated version of sqflite!

How to use

1. To create a model

Model classes should extend DbModel class. Define the schema of your model, Supported field type:

Integers Strings DateTimes Others
IdField StringField DateTimeField (saved as num) BlobField
IntField DateTimeStringField (Saved as string) BoolField
NumField JsonField
ListField
DoubleField ColorField
EnumField
class Note extends DbModel {
  var title = StringField(columnName: 'title');
  var content = StringField(columnName: 'content');
  var isImportant = BoolField(columnName: 'isImportant');
  var color = ColorField(columnName: 'color');

  @override
  List<FieldWithValue>? getFields() => [title, content, isImportant, color];
}

Note that: Every model has default fields:

  • id (Auto incremental integer field)
  • creationTime (automatically set once when created)
  • modificationTime (automatically set when created, and with every update operation)

2. To create a table manager
class NotesProvider extends DbTableProvider<Note> {
  NotesProvider() : super(() => Note());

  @override
  String get tableName => 'Notes';
}

As shown, to set the name of the table:

  @override
  String get tableName => 'Notes';

Note that: In provider class constructor, you should provide it with model object creation function.

  NotesProvider() : super(() => Note());

To create a provider instance,

NotesProvider notesProvider = NotesProvider();
3. Crud operations:
Creation: (Insertion)

single:

    Note n = Note();
    n.title.value = 'New note';
    n.content.value = 'Note content, describe your self';
    n.isImportant.value = ([true, false]..shuffle()).first;
    n.color.value = ([Colors.red, Colors.blue, Colors.yellow, Colors.orange]
          ..shuffle())
        .first;

    await notesProvider.insertEntry(n);

multiple:

    await notesProvider.insertCollection([n1,n2,n3,...]);
Reading (Query):
var allNotes = await notesProvider.select();
var importantNotes = await notesProvider.select(where:(n)=>n.isImportant.isTrue);
var imortantRed = await notesProvider.select(where:(n)=>n.isImportant.isTrue & n.color.equals(Color(0xffff0000)));
Updating:
n.title = 'new title';
await notesProvider.updateEntry(n);
Deletion:
await notesProvider.deleteEntry(n);

Monitoring changes:

To handle the changes in some table:

  notesProvider.addEntryChangeListner((changeType, entry) {
      switch (changeType) {
        case EntryChangeType.Insertion:
          //New Note added (entry)
          break;
        case EntryChangeType.Deletion:
          //(entry) has been deleted
          break;
        case EntryChangeType.Modification:
          //(entry) has been modified
          break;
      }
    });

Database location:

Where are the data being stored? By default, your data will be saved in app data folder / 'data.db', and to change it:

  DbHelper.mainDbPath = 'your db path';

And if you want to save a table in other file:

class NotesProvider extends DbTableProvider<Note> {
  NotesProvider()
      : super(() => Note(), specialDbFile: 'your specified file path');

  @override
  String get tableName => 'Notes';
}

カテゴリー

依存関係

依存関係一覧 7 件

ソースリポジトリ

このパッケージを使用しているプロジェクト

データはまだありません。