Search packages, repositories and app categories

Package detailsv0.0.6+6

quds_db

A sqflite expansion package that simplifies creating databases and tables, crud operations, queries with modelization

AndroidiOSmacOSWindowsLinux
30-day downloads
16
Likes
33
Pub points
140

Install package

flutter pub add quds_db

Package Overview

Package selection guidance compiled from public package information, community data, and project usage.

quds_db is a Flutter/Dart package that extends sqflite to simplify database management. It streamlines the creation of databases and tables, supports CRUD operations, and enables model-based queries. By abstracting complex SQL logic, it allows developers to work with structured data using Dart models, reducing boilerplate code. The package is designed for efficient, type-safe interactions with local SQLite databases across multiple platforms.

Use cases

  • Local data persistence in mobile apps
  • Simplifying CRUD operations with models
  • Building offline-first applications
  • Managing structured app data
  • Streamlining database setup and migrations

Key features

  • Model-driven database operations
  • Built-in CRUD methods
  • Automatic table creation from models
  • Support for complex queries with model mapping
  • Cross-platform SQLite integration

Suitable for

  • Developers seeking sqflite simplification
  • Projects requiring local database storage
  • Apps needing offline functionality
  • Teams prioritizing code readability
  • Flutter apps with structured data needs

Considerations

  • Requires understanding of sqflite fundamentals
  • Limited to SQLite database backend
  • May need additional setup for advanced queries
  • Depends on proper model class definitions
  • Not suitable for cloud-based or real-time data

Original README

Original README snapshot from the linked source repository. Visit the repository for the latest content.

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';
}

Categories

Dependencies

Dependency list 7 items

Source repository

Projects using this package

No data available yet.