SMDB class

Available extensions

Constructors

SMDB()

Properties

coverRecod → CoverRecord?
Get CoverRecord
no setter
deletedCount → int
no setter
deletedSize → int
no setter
eventBus → EventBus
final
hashCode → int
The hash code for this object.
no setterinherited
no setter
isOpened → bool
Database Is Opened
no setter
lastIndex → int
Database Binary Last Index
no setter
path ↔ String
getter/setter pair
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

addFile(String path, {Map<String, dynamic> extraInfo = const {}, bool isCancelled()?, void onProgress(double progress)?}) → Future<(FileRecord, bool)>

Available on SMDB, provided by the SmFileRecordExtensions extension

Add Any File
addFiles(List<String> pathList, {Map<String, dynamic> extraInfo = const {}, bool isCancelledFile()?, void onProgressFile(double progress)?}) → Future<List<(FileRecord, bool)>>

Available on SMDB, provided by the SmFileRecordExtensions extension

Add Any Files
addRecord(DatabaseRecord record, {bool isCancelledFile()?, void onProgressFile(double progress)?}) → Future<(DatabaseRecord, bool)>
Add Database Record
clearAllAdapter() → void
All Registered Adapter Clear
close() → Future<void>
Close Database
compact({bool isCancelled()?, void onProgress(double progress)?}) → Future<void>
Reduce Removed Record List
deleteAllFiles() → Future<void>
Delete All File
deleteAllJsonRecords() → Future<void>
Delete All Json Records
deleteCover() → Future<bool>
Delete Cover
exportCoverFile(String path) → Future<bool>
Export Cover File
extractAllFiles({required Directory outDir, bool isCancelled()?, void onProgress(double progress)?}) → Future<void>
Extract All File
extractFile(FileRecord fileRecord, {required String savePath, bool isCancelled()?, void onProgress(double progress)?}) → Future<void>
Extract File
getAdapter<T>() → JsonDBAdapter<T>
Get Adapter<T>
getBox<T>() → JsonDBBox<T>
Get Box<T>
getById(int id) → Future<DatabaseRecord?>
Get By Id
getCoverData() → Future<Uint8List?>
CoverRecord [Uint8List] data
mabyCompact() → Future<void>
When Database Remove `Auto Compact`;
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
open(String dbPath, {SMDBConfig? config}) → Future<void>
Database Open
readAll() → Future<List<DatabaseRecord>>
Read All Active Records
readAllFiles() → Future<List<FileRecord>>
Read All Active File Records
readAllJson() → Future<List<JsonRecord>>
Read All Active Json Records
registerAdapterNotExists<T>(JsonDBAdapter<T> adapter) → void
Set Adapter<T>
removeMultiRecord(List<DatabaseRecord> records) → Future<bool>
Remove Multi Database Record
removeRecord(DatabaseRecord record, {bool isCallMabyCompact = true}) → Future<bool>
Remove Database Record
removeRecordById(int id) → Future<bool>
Remove Record By Id
setCoverFormPath(String path) → Future<bool>
SetCover From Path
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Methods

getInstance() → SMDB
readHeaderFromPath(String dbPath, {required String type, required int version}) → Future<(String, int)>
Read Rader From Database Files