Skip to content

CHANGELOG.md

Latest commit

 

History

History
418 lines (255 loc) · 10.3 KB

CHANGELOG.md

File metadata and controls

418 lines (255 loc) · 10.3 KB

4.0.0-dev.2

⚠️ 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

3.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)

2.2.3

Enhancements

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

2.2.2

Fixes

  • Register DateTime adapter on web - #983

2.2.1

Fixes

  • Retracted hive@2.2.0 from pub.dev
  • Fixed hive web backend null value exception - #968

2.2.0

Enhancements

  • Added multiple storage backends for web - #956

2.1.0

Fixes

  • Do not return uninitialized box - #916

Enhancements

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

2.0.6

Fixes

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

2.0.5

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

2.0.4

Enhancements

  • Adds default value support to hive_generator generated class adapters

2.0.3

Fixes

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

2.0.2

Fixes

  • HiveObjectMixin not assigning box to object - #618

2.0.1

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

2.0.0

Fixes

  • Stable null-safety version

1.6.0-nullsafety.2

Fixes

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

1.6.0-nullsafety.1

Fixes

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

1.6.0-nullsafety.0

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

1.5.0-pre

Enhancements

  • Timezone support for DateTime - #419

1.4.4+1

Fixes

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

1.4.4

Fixes

  • Edge browser support - #357

1.4.3

Enhancements

  • Added Hive.ignoreTypeId(typeId) - #397

Fixes

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

1.4.2

Fixes

  • Fixed dependency issues and minor improvements

1.4.1+1

Other

  • Added docs to all public members

1.4.1

Enhancements

  • Minor performance improvements

Fixes

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

Other

  • Fixed GitHub homepage path

1.4.0+1

Enhancements

  • Minor performance improvements

Fixes

  • Allow more versions of crypto

1.4.0

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

1.3.0

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

1.2.0

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.

1.1.1

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

1.1.0+2

Fixes

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

1.1.0+1

Fixes

  • Fixed bug that corrupted boxes were not detected

1.1.0

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

1.0.0

  • First stable release

0.5.1+1

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

0.5.1

  • 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

0.5.0

  • 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

0.4.1+1

  • Document all public APIs
  • Fixed flutter_web error

0.4.1

  • Allow different versions of the path package

0.4.0

  • 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

0.3.0+1

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

0.3.0

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

0.2.0

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

0.1.1

  • Downgrade to meta: ^1.1.6 to support flutter

0.1.0

  • First release
⚡