hive

⚠️ THIS VERSION OF HIVE IS UNSTABLE AND NOT READY FOR PRODUCTION USE ⚠️

This is a complete rewrite of Hive. It is not compatible with older versions of Hive yet.

Hive now uses Isar internally which brings all the benefits of a native database to Hive.

Enchantments

• Much more resource efficiency
• Support for access from multiple isolates
• Support for transactions
• No more issues with concurrent access and corruption
• Vastly reduced startup time
• No more code generation

Added convenience method to start and initialize Isolates.

What's Changed

• added the notify parameter to the functions of the public API by @tomassasovsky in #1019
• feat: implement Web Worker support by @TheOneWithTheBraid in #1030
• feat: add .gitignore by @TheOneWithTheBraid in #1035
• feat: improve BinaryWriter API by @TheOneWithTheBraid in #986
• Implement fully working StorageBackendMemory by @grieshofer in #1036
• feat: store open boxes including collection by @TheOneWithTheBraid in #1038
• fix: missing TupleBoxKey for opening boxes by @TheOneWithTheBraid in #1041
• fix(hive_generator): Apply analyzer 5.0.0 or higher by @jukqaz in #1085

New Contributors

• @tomassasovsky made their first contribution in #1019
• @grieshofer made their first contribution in #1036
• @jukqaz made their first contribution in #1085

Full Changelog: v2.2.3...v3.0.0-dev

Enchantments

• Implemented in-memory storage backend
• Added notify parameter to public APIs
• Web Worker support
• Threaded AesCipher support (requires hive_flutter >=2.0.0-dev)

What's Changed

• fix: Remove print from deleteBoxFromDisk by @krillefear in #1015
• feat: made resetAdapters public by @alestiago in #1014

New Contributors

• @krillefear made their first contribution in #1015
• @alestiago made their first contribution in #1014

Full Changelog: v2.2.2...v2.2.3

Enhancements

• Exposed resetAdapters method for testing - #1014
• Removed unnecessary print statement - #1015

Fixes

• Register DateTime adapter on web - #983

What's Changed

• hive_generator: Update Analyzer version. by @ryojiro in #969
• fix: provide fallback backend manager by @TheOneWithTheBraid in #968

New Contributors

• @ryojiro made their first contribution in #969

Full Changelog: v2.2.0...v2.2.1

Fixes

• Retracted [email protected] from pub.dev
• Fixed hive web backend null value exception - #968

What's Changed

• Upstream FluffyBox patches by @TheOneWithTheBraid in #956

New Contributors

• @TheOneWithTheBraid made their first contribution in #956

Full Changelog: v2.1.0...v2.2.0

Enhancements

• Added multiple storage backends for web - #956

What's Changed

• Do not return uninitialized box by @maRci002 in #916
• Support adapter type inheritance by @saibotma in #927
• Close uninitialized boxes by @themisir in #917
• Support UTF-8 keys by @themisir in #928

New Contributors

• @saibotma made their first contribution in #927

Full Changelog: v2.0.6...v2.1.0

Fixes

• Do not return uninitialized box - #916

Enhancements

• Adapter type inheritance - #927
• UTF8 keys - #928

What's Changed

• Updated hive_generator analyzer dependency by @NatsuOnFire in #858
• Change pedantic to linter and fix warnings by @themisir in #876
• Fix: This should not happen. Please open an issue on GitHub. by @maRci002 in #914

New Contributors

• @NatsuOnFire made their first contribution in #858
• @maRci002 made their first contribution in #914

Full Changelog: v2.0.5...v2.0.6

Fixes

• Fixed issue caused database to crash when executing crash recovery - #914

Enhancements

• Get IndexedDB selectively based on window property - #802
• Added path parameter to boxExists and deleteBoxFromDisk methods - #776
• Added flush method to boxes - #852

Fixes

• Don't loose track of box objects if init crashes - #846

Enhancements

• Adds default value support to hive_generator generated class adapters

Fixes

• Fix regression where lists are no longer growable - #631

Fixes

• HiveObjectMixin not assigning box to object - #618

Fixes

• BoxEvent value is null when watching a LazyBox - #592
• Allow calling .init() multiple times, instead of throwing error Hive will print warning to console
• Hive will warn developers when registering adapters for dynamic type

Fixes

• Stable null-safety version

Fixes

• Added defaultValue property to @HiveField() annotation - #557

Fixes

• Changed meta dependency version to ^1.3.0-nullsafety to support null-safety

Breaking changes

• Migrate to null-safety - #521
• Update minimum Dart sdk constraint to 2.12.0-0.
• In order to generate null-safe code use hive_generator >= 0.9.0-nullsafety.0

Enhancements

• Timezone support for DateTime - #419

Fixes

• Edge browser support - #357

Fixes

• Browser support for BackendManager.boxExists(boxName, path) - #451

Enhancements

• Added Hive.ignoreTypeId(typeId) - #397

Fixes

• open(Lazy)Box can potentially open a box twice - #345
• Remove extra byte reservation in writeBoolLis - #398

Fixes

• Fixed dependency issues and minor improvements

Enhancements

• Minor performance improvements

Fixes

• When a database operation failed, subsequent operations would not be performed

Other

• Fixed GitHub homepage path

Other

• Added docs to all public members

Enhancements

• ~1000% encryption / decryption performance improvement
• Added option to implement custom encryption algorithm
• Added box.valuesBetween(startKey, endKey)
• Allow tree shaking to drop encryption engine if no encryption is used

Fixes

• Hive.deleteBoxFromDisk() did not work for boxes with upper-case names

More

• Deprecated encryptionKey parameter. Use Hive.openBox('name', encryptionCipher: HiveAesCipher(yourKey)).
• Dropped pointycastle dependency
• Dropped path dependency

Enhancements

• Minor performance improvements

Fixes

• Allow more versions of crypto

Use latest version of hive_generator

Breaking changes

• TypeAdapters and @HiveType() now require a typeId
• Hive.registerAdapter() does not need a typeId anymore.
• Removed BinaryReader.readAsciiString()
• Removed BinaryWriter.writeAsciiString()

Enhancements

• New documentation with tutorials and live code

Fixes

• box.clear() resets auto increment counter

More

• Not calling Hive.init() results in better exception

Breaking changes

• Removed the Hive.path getter
• Removed Hive.openBoxFromBytes() (use the bytes parameter of Hive.openBox() instead)
• LazyBox and Box now have a common parent class: BoxBase
• Lazy boxes need to be opened using Hive.openLazyBox()
• Open lazy boxes can be acquired using Hive.lazyBox()
• Box name bug resolved (more information below)

Enhancements

• Support for relationships, HiveLists (see docs for details)
• Support for inheritance
• Lazy boxes can now have a type argument LazyBox<YourModel>
• Added method to delete boxes without opening them Hive.deleteBoxFromDisk()
• Added path parameter to open boxes in a custom path
• Improved documentation

Fixes

• HiveObjects have not been initialized correctly in lazy boxes
• Fixed bug where uppercase box name resulted in an uppercase filename
• Fixed compaction bug which caused corrupted boxes
• Fixed bug which did not allow the key 0xFFFFFFFF
• Fixed bug where not all BoxEvents have been broadcasted

More

• Changed type of encryptionKey from Uint8List to List<int>

Important:

Due to a bug in previous Hive versions, boxes whose name contains uppercase characters were stored in a file that also contains upper case characters (e.g. 'myBox' -> 'myBox.hive').

To avoid different behavior on case sensitive file systems, Hive should store files with lower case names. This bug has been resolved in version 1.2.0.

If your box name contains upper case characters, the new version will not find a box stored by an older version. Please rename the hive file manually in that case.
This also applies to the web version.

Breaking changes

• object.delete() now throws exception if object is not stored in a box

Fixes

• Fixed bug where object.save() would fail on subsequent calls

Breaking changes

• Changed return type of addAll() from List<int> to Iterable<int>.
• Removed the option to register TypeAdapters for a specific box. E.g. box.registerTypeAdapter().
• getAt(), putAt(), deleteAt() and keyAt() no longer allow indices out of range.

Enhancements

• Added HiveObject
• Boxes have now an optional type parameter Box<E>
• Support opening boxes from assets

Fixes

• Fixed bug which was caused by not awaiting write operations
• Fixed bug where custom compaction strategy was not applied
• Hive now locks box files while they are open to prevent concurrent access from multiple processes

More

• Improved performance of putAll(), deleteAll(), add(), addAll()
• Changed values parameter of addAll() from List to Iterable
• Improved documentation
• Preparation for queries

Fixes

• Fixed bug that corrupted boxes were not detected

Fixes

• Fixed bug that it was not possible to open typed boxes (Box<E>)

• First stable release

• Fixed Hive.init() bug in browser
• Fixed a bug with large lists or strings
• Improved box opening time in the browser
• Improved general write performance
• Improved docs
• Added integration tests

• Change keys parameter of deleteAll from List to Iterable
• Fixed bug in BinaryWriter

• Added keyComparator parameter for custom key order
• Added isEmpty and isNotEmpty getters to box
• Added support for reading and writing subclasses
• Removed length limitation for Lists, Maps, and Strings
• Greatly improved performance of storing Uint8Lists in browser
• Removed CRC check in the browser (not needed)
• Improved documentation
• TypeIds are now allowed in the range of 0-223
• Fixed compaction
• Fixed writing longer Strings
• Breaking: Binary format changed

• Allow different versions of the path package

• Document all public APIs
• Fixed flutter_web error

• Added BigInt support
• Added compactionStrategy parameter
• Added automatic crash recovery
• Added add() and addAll() for auto-increment keys
• Added getAt(), putAt() and deleteAt() for working with indices
• Support for int (32 bit unsigned) keys
• Non-lazy boxes now notify their listeners immediately about changes
• Bugfixes
• More tests
• Breaking: Open boxes with openBox()
• Breaking: Writing null is no longer equivalent to deleting a key
• Breaking: Temporarily removed support for transactions. New API design needed. Will be coming back in a future version.
• Breaking: Binary format changed
• Breaking: API changes

• Big step towards stable API
• Support for transactions
• Annotations for hive_generator
• Bugfixes
• Improved web support
• Breaking: inMemory -> lazy
• Breaking: Binary format changed

• Bugfix: Hive['yourBox'] didn't work with uppercase box names

• Support for dart2js
• Improved performance
• Added inMemory option
• Breaking: Minor API changes
• Breaking: Changed Endianness to little
• Breaking: Removed Migrator

• Downgrade to meta: ^1.1.6 to support flutter

• First release