Skip to content

Commit b4b2840

Browse files
committed
Adding note about performance update
1 parent e5ab01f commit b4b2840

File tree

3 files changed

+27
-0
lines changed

3 files changed

+27
-0
lines changed

.rustme/docs.md

+9
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,15 @@ activity](https://img.shields.io/github/commit-activity/m/khonsulabs/bonsaidb)).
2828
There may still be bugs that result in data loss. All users should regularly
2929
back up their data and test that restoring from backup works correctly.
3030

31+
Around May 2022, a bug and a mistake in benchmarking were discovered. The bug
32+
was promptly fixed, but the net result is that BonsaiDb's transactional write
33+
performance is significantly slower than other databases. Unless you're buliding
34+
a very write-heavy application, the performance will likely still be acceptable.
35+
[Issue #251 on GitHub](https://github.com/khonsulabs/bonsaidb/issues/251) is
36+
where progress of the performance updates are being tracked. From a developer's
37+
perspective, migration is expected to be painless beyond the IO needed to copy
38+
the old database into the new format.
39+
3140
## Example
3241

3342
To get an idea of how it works, let's review the [`view-examples` example][view-examples].

README.md

+9
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,15 @@ activity](https://img.shields.io/github/commit-activity/m/khonsulabs/bonsaidb)).
3030
There may still be bugs that result in data loss. All users should regularly
3131
back up their data and test that restoring from backup works correctly.
3232

33+
Around May 2022, a bug and a mistake in benchmarking were discovered. The bug
34+
was promptly fixed, but the net result is that BonsaiDb's transactional write
35+
performance is significantly slower than other databases. Unless you're buliding
36+
a very write-heavy application, the performance will likely still be acceptable.
37+
[Issue #251 on GitHub](https://github.com/khonsulabs/bonsaidb/issues/251) is
38+
where progress of the performance updates are being tracked. From a developer's
39+
perspective, migration is expected to be painless beyond the IO needed to copy
40+
the old database into the new format.
41+
3342
## Example
3443

3544
To get an idea of how it works, let's review the [`view-examples` example][view-examples].

crates/bonsaidb/crate-docs.md

+9
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,15 @@ activity](https://img.shields.io/github/commit-activity/m/khonsulabs/bonsaidb)).
2828
There may still be bugs that result in data loss. All users should regularly
2929
back up their data and test that restoring from backup works correctly.
3030

31+
Around May 2022, a bug and a mistake in benchmarking were discovered. The bug
32+
was promptly fixed, but the net result is that BonsaiDb's transactional write
33+
performance is significantly slower than other databases. Unless you're buliding
34+
a very write-heavy application, the performance will likely still be acceptable.
35+
[Issue #251 on GitHub](https://github.com/khonsulabs/bonsaidb/issues/251) is
36+
where progress of the performance updates are being tracked. From a developer's
37+
perspective, migration is expected to be painless beyond the IO needed to copy
38+
the old database into the new format.
39+
3140
## Example
3241

3342
To get an idea of how it works, let's review the [`view-examples` example][view-examples].

0 commit comments

Comments
 (0)