Throw DbFullException for error code OBX_ERROR_DB_FULL (#31)

Author: greenrobot-team

objectbox/CHANGELOG.md

@@ -11,6 +11,8 @@
 * Generator not longer warns that it can not find the package source root if the output directory is
   the package root directory.
 * Add `StorageException` which is a `ObjectBoxException` with an `errorCode` (a `OBX_ERROR` code).
+* Throw `DbFullException` instead of `ObjectBoxException` with message `10101 Could not put` (error 
+  code `OBX_ERROR_DB_FULL`).
 
 ## 1.6.2 (2022-08-24)
 

objectbox/lib/src/common.dart

@@ -1,3 +1,5 @@
+import '../objectbox.dart';
+
 /// Wrapper for a semantic version information.
 class Version {
   /// Major version number.
@@ -40,6 +42,13 @@ class StorageException extends ObjectBoxException {
   String toString() => 'StorageException: $message (OBX_ERROR code $errorCode)';
 }
 
+/// Thrown when applying a transaction (e.g. putting an object) would exceed the
+/// `maxDBSizeInKB` configured when calling [Store.new].
+class DbFullException extends StorageException {
+  /// See [DbFullException].
+  DbFullException(String message, int errorCode) : super(message, errorCode);
+}
+
 /// A unique constraint would have been violated by this database operation.
 class UniqueViolationException extends ObjectBoxException {
   /// Create a new exception.

objectbox/lib/src/native/bindings/helpers.dart

@@ -78,6 +78,8 @@ class ObjectBoxNativeError {
         throw RangeError(messageWithErrorCode);
       case OBX_ERROR_UNIQUE_VIOLATED:
         throw UniqueViolationException(messageWithContext);
+      case OBX_ERROR_DB_FULL:
+        throw DbFullException(messageWithContext, code);
       default:
         if (code == 0) {
           throw ObjectBoxException(messageWithContext);

objectbox/lib/src/native/store.dart

@@ -98,13 +98,16 @@ class Store {
   /// ## Maximum database size
   ///
   /// [maxDBSizeInKB] sets the maximum size the database file can grow to.
-  /// By default this is 1 GB, which should be sufficient for most applications.
-  /// The store will throw when trying to insert more data if the maximum size
-  /// is reached.
+  /// When applying a transaction (e.g. putting an object) would exceed it a
+  /// [DbFullException] is thrown.
   ///
+  /// By default, this is 1 GB, which should be sufficient for most applications.
   /// In general, a maximum size prevents the database from growing indefinitely
   /// when something goes wrong (for example data is put in an infinite loop).
   ///
+  /// This value can be changed, so increased or also decreased, each time when
+  /// opening a store.
+  ///
   /// ## File mode
   ///
   /// Specify [unix-style file permissions](https://en.wikipedia.org/wiki/File_system_permissions#Numeric_notation)

objectbox/test/store_test.dart

@@ -248,7 +248,7 @@ void main() {
     expect(
         () => box.put(testEntity2),
         throwsA(predicate((e) =>
-            e is StorageException &&
+            e is DbFullException &&
             e.errorCode == OBX_ERROR_DB_FULL &&
             e.message == 'object put failed: Could not put')));