Skip to content

Commit 899a710

Browse files
committed
docs(migrate9): update for release
1 parent 9816f4f commit 899a710

File tree

1 file changed

+21
-8
lines changed

1 file changed

+21
-8
lines changed

docs/guides/migration/migrate9.md

+21-8
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ title: 'Migrate to version 9.0.0'
66
Here are the Important changes made for 9.0.0
77

88
:::caution Important, Read this first
9-
This Guide is written for migration from version `8.15.0` to `9.0.0`, for versions `>9.0.0 <10.0.0`, please consult the [CHANGELOG](https://github.com/nodkz/mongodb-memory-server/blob/master/CHANGELOG.md)
9+
This Guide is written for migration from version `8.16.0` to `9.0.0`, for versions `>9.0.0 <10.0.0`, please consult the [CHANGELOG](https://github.com/nodkz/mongodb-memory-server/blob/master/CHANGELOG.md)
1010
:::
1111

1212
## Breaking Changes
@@ -17,11 +17,15 @@ With 9.0.0 the minimal nodejs required is `14.20.1`.
1717

1818
### Mongodb Driver Version upgraded to 5.x
1919

20-
The used MongoDB Driver version is now `5.6.0`.
20+
The used MongoDB Driver version is now `5.9.0`.
21+
22+
### Default binary version is now 6.x
23+
24+
The default binary version has been upgraded from `5.0.x` to `6.0.x`. For more specifics see [mongodb-server-versions](../mongodb-server-versions.md).
2125

2226
### Removed platform translations
2327

24-
Some platform translations have been removed, because they are either not needed anymore or werent supported in the first place:
28+
Some platform translations have been removed, because they are either not needed anymore or werent properly supported in the first place:
2529

2630
- `sunos` -> `linux`
2731
- `elementary OS` -> `linux`
@@ -34,7 +38,7 @@ Some architectures were removed because they were not being build by mongodb any
3438

3539
### MongoMemoryServer `instance.auth` option is now ignored
3640

37-
With 9.0.0 the option `instance.auth` option is going to be ignored, because its set via the `auth` option directly.
41+
With 9.0.0 the option `instance.auth` option is going to be ignored, because its set via the (top-level) `auth` option directly.
3842

3943
Example:
4044

@@ -50,16 +54,16 @@ Replace `auth: { disable: false }` with `auth: { enable: true }`.
5054

5155
### MongoMemoryServer and MongoReplSet `.cleanup(boolean)` and `.stop(boolean)` have been removed
5256

53-
Previously `boolean` was the only option for the `.cleanup` and `.stop` function, but they behaved differently between those 2 function and were replaced with `Cleanup` options and now have been completely removed.
57+
Previously `boolean` was the only option for the `.cleanup` and `.stop` function, but they behaved differently between those 2 function and were replaced with `Cleanup` object-options and now have been completely removed.
5458

5559
Replace `.stop(true)` with `.stop({ doCleanup: true })`.
5660
Replace `.cleanup(true)` with `.stop({ doCleanup: true, force: true })`.
5761

58-
Default is still for both `{ doCleanup: true }`.
62+
Default is still for both `{ doCleanup: true, force: false }`.
5963

6064
### `MD5_CHECK` is now enabled by default
6165

62-
The config option [`MD5_CHECK`](../../api/config-options.md#md5_check) has been enabled by default now, resulting in always comparing the downloaded archive with a md5.
66+
The config option [`MD5_CHECK`](../../api/config-options.md#md5_check) has been enabled by default now, resulting in always comparing the downloaded archive with a md5 after a download.
6367

6468
### Merged Error types
6569

@@ -104,7 +108,7 @@ The Mongodb Binary childprocess is now also `.unref()`, like the killer process
104108

105109
This *should* help with non-closed instances not exiting the nodejs process.
106110

107-
## The port testing has been replaced
111+
## The port testing package has been replaced
108112

109113
Previously MMS used `get-port`, but it caused some big memory-leakage across big projects, so it has been replaced with one that uses less maps.
110114

@@ -115,4 +119,13 @@ It also has been replaced because newer versions were ESM only, but we couldnt s
115119
Mongob version `7.0.0` removed storage engine `ephemeralForTest`, with mongodb-memory-server 9.0.0 storage engine `wiredTiger` is the default for binary versions `7.0.0` and higher.
116120
Older versions (before `7.0.0`) will still continue to use `ephemeralForTest` by default.
117121

122+
:::info
123+
The version used for the decision is the version provided via the resolved [`VERSION`](../../api/config-options.md#version) config option.
124+
This mean it needs to match the version the system binary is (a warning is printed if they are not the same).
125+
126+
If the option is unset, the default version will be used, which is likely not correct for the system binary.
127+
128+
If the decision should not be automatic, the storage engine can be explicitly defined as a instance option.
129+
:::
130+
118131
It is recommended to run those instances with a db path which is equivalent to [`tmpfs`](https://wiki.archlinux.org/title/tmpfs).

0 commit comments

Comments
 (0)