You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/server/configuration/db-config.md
+5-1Lines changed: 5 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -26,7 +26,7 @@ Normally, you'd want to keep the database files separated from the OS and other
26
26
27
27
### In-memory database
28
28
29
-
When running KurrentDB for educational purposes or in an automated test environment, you might want to prevent it from saving any data to the disk. KurrentDB can keep the data in memory as soon as it has enough available RAM. When you shut down the instance that uses in-memory database, all the data will be lost.
29
+
When running KurrentDB for educational purposes or in an automated test environment, you might want to prevent it from saving any data to the disk. KurrentDB can keep the data in memory as long as it has enough available RAM. When you shut down the instance that uses in-memory database, all the data will be lost.
30
30
31
31
| Format | Syntax |
32
32
|:---------------------|:--------------------|
@@ -36,6 +36,10 @@ When running KurrentDB for educational purposes or in an automated test environm
36
36
37
37
**Default**: `false`
38
38
39
+
:::warning
40
+
`--mem-db` has been deprecated as of version 25.1.0 and will be removed in a future version to allow us to simplify and unify some core code paths. Users wishing to continue to run KurrentDB in memory can do so with ramfs or similar. Please reach out to us if this is problematic for your use case.
41
+
:::
42
+
39
43
### Skip database verification
40
44
41
45
When the database node restarts, it checks the database files to ensure they aren't corrupted. It is a lengthy process and can take hours on a large database. KurrentDB normally flushes every write to disk, so database files are unlikely to get corrupted. In an environment where nodes restart often for some reason, you might want to disable the database verification to allow faster startup of the node.
Packages are available for [Ubuntu/Debian](./installation.md#ubuntu-debian-packages), [RedHat](./installation.md#redhat-packages), [Docker](./installation.md#docker), and [NuGet](./installation.md#nuget).
21
-
22
6
## Should you upgrade?
23
7
24
-
KurrentDB 25.0 is a short term support (STS) feature release and will be supported until the next major or minor release of KurrentDB.
8
+
KurrentDB 25.1 is a short term support (STS) feature release and will be supported until the next major or minor release of KurrentDB.
25
9
26
-
Upgrade to this version if you want to use the new archiving feature, or want to prepare for some of the changes caused by the rebrand from EventStoreDB to KurrentDB.
10
+
Upgrade to this version if you want to try the new features and changes in this release and are able to the next release in a few months time.
27
11
28
12
## Upgrade procedure
29
13
30
-
You can perform an online rolling upgrade directly to KurrentDB 25.0 from these versions of EventStoreDB:
14
+
You can perform an online rolling upgrade directly to KurrentDB 25.1 from these earlier versions:
15
+
- 25.0
31
16
- 24.10
32
17
- 23.10
33
18
- 22.10
@@ -36,7 +21,7 @@ Follow the upgrade procedure below on each node, starting with a follower node:
36
21
37
22
1. Stop the node.
38
23
1. Uninstall any previous versions of EventStoreDB.
39
-
1. Install KurrentDB 25.0 and update the configuration. If you use licensed features, ensure that you configure a [license key](../quick-start/installation.md#license-keys).
24
+
1. Install the new version and update the configuration. If you use licensed features, ensure that you configure a [license key](../quick-start/installation.md#license-keys).
40
25
1. Start the node.
41
26
1. Wait for the node to become a follower or read-only replica.
42
27
1. Repeat the process for the next node.
@@ -50,18 +35,51 @@ Upgrading the cluster this way keeps the cluster online and able to service requ
50
35
If you modified the Linux service file to increase the open files limit, those changes will be overridden during the upgrade. You will need to reapply them after the upgrade.
51
36
:::
52
37
53
-
## Breaking changes
38
+
## 25.1 upgrade notes
39
+
40
+
General changes, features and fixes are described in the [what's new](./whatsnew.md) and [release notes](../release-schedule/release-notes.md).
41
+
42
+
- Consider if the new `StreamInfoCacheCapacity` default is appropriate for your workload.
43
+
- Consider whether to leave `SecondaryIndexing:Enabled` at its default of `true`.
The `MemDb` option has been deprecated and will be removed in a future version to allow us to simplify and unify some core code paths. Users wishing to continue to run KurrentDB in memory can do so with ramfs or similar. Please reach out to us if this is problematic for your use case.
62
+
63
+
## 25.0 upgrade notes
64
+
65
+
Event Store – the company and the product – have rebranded as Kurrent.
66
+
67
+
As part of this rebrand, EventStoreDB has been renamed to KurrentDB, with the first release of KurrentDB being version 25.0.
68
+
69
+
Read more about the rebrand in the [rebrand FAQ](https://www.kurrent.io/blog/kurrent-re-brand-faq).
70
+
71
+
### Breaking changes
72
+
73
+
#### File and location changes when upgrading from EventStoreDB
56
74
57
75
You will need to take the following changes into account when upgrading from EventStoreDB:
58
76
59
-
#### On Windows
77
+
#####On Windows
60
78
61
79
1. The executable `EventStore.ClusterNode.exe` has been renamed to `KurrentDB.exe`.
62
80
1. The test client executable `EventStore.TestClient.exe` has been renamed to `KurrentDB.TestClient.exe`.
63
81
64
-
#### On Linux
82
+
#####On Linux
65
83
66
84
1. The `eventstore` service has been renamed to `kurrentdb`.
67
85
1. The `eventstored` executable has been renamed to `kurrentd`.
@@ -88,14 +106,14 @@ If you install KurrentDB through a package manager, it will create a default con
88
106
If you are running KurrentDB as a service, you will need to grant the `kurrent` user access to any data, logs, or configuration directories that the `eventstore` user had access to.
89
107
:::
90
108
91
-
### Log Levels supported in logconfig.json
109
+
####Log Levels supported in logconfig.json
92
110
93
111
The log levels specified in `logconfig.json` must now be Microsoft levels rather than Serilog levels.
94
112
95
113
If you have customized your `logconfig.json` you will need to change `Fatal` to `Critical` and `Verbose` to `Trace`.
A number of configuration options have been removed in 25.0. KurrentDB will not start by default if any of these options are present in the database configuration.
157
175
@@ -178,7 +196,7 @@ The following deprecated options were removed as they had no effect:
178
196
-`DisableInternalTcpTls`
179
197
-`OptimizeIndexMerge`
180
198
181
-
### New OAuth redirect uri
199
+
####New OAuth redirect uri
182
200
183
201
The new embedded web UI requires a new redirect uri in order to work with the OAuth plugin.
184
202
@@ -204,7 +222,58 @@ Then you would need to update it to this:
204
222
]
205
223
```
206
224
207
-
### From v24.6 and earlier
225
+
### Deprecation Notices
226
+
227
+
#### Configuration sections and prefixes
228
+
229
+
The `EventStore` configuration section and configuration root has been renamed to `KurrentDB`.
230
+
231
+
The `EVENTSTORE_` environment variable prefix has been changed to `KURRENTDB_`
232
+
233
+
#### Custom HTTP content types
234
+
235
+
The `vnd.eventstore.*` content types have been renamed to `vnd.kurrent.*`:
@@ -216,11 +285,11 @@ Any tooling that relies on the histogram endpoint will receive a 404 when reques
216
285
217
286
Support for extremely old PTables (v1) has been removed.
218
287
219
-
This will only affect databases created on EventStoreDB version 3.9.0 and before, and which have not upgraded their PTables since EventStoreDB version 3.9.0.
288
+
This will only affect databases created before EventStoreDB version 3.9.0, and which have not upgraded their PTables since EventStoreDB version 3.9.0.
220
289
221
-
PTables are automatically upgraded when merged or when the PTables are rebuilt. So, if your EventStoreDB has been running for some time on a version greater than 3.9.0, then you are unlikely to be affected by this change.
290
+
PTables are automatically upgraded when merged or when the PTables are rebuilt. So, if your EventStoreDB has been running for some time on a version >= 3.9.0, then you are unlikely to be affected by this change.
222
291
223
-
If 32bit PTables are present, we detect them on startup and exit. If this happens, you can use a version between v3.9.0 and v24.10.0 to upgrade the PTables or rebuild the index.
292
+
If 32bit PTables are present, we detect them on startup and exit. If this happens, you can use a version >= v3.9.0 and < v24.10.0 to upgrade the PTables, or alternatively you can delete the index and it will be rebuilt. The rebuild would involve reading the whole database, which can take a long time on large databases.
@@ -344,7 +415,9 @@ In this case, you will see the following logs:
344
415
345
416
You can correct this by regenerating the certificates with the correct key usages. See the [Certificate Configuration](../security/protocol-security.md#certificates-configuration) documentation for more information about configuring and generating certificates.
346
417
347
-
### From v22.10 and earlier
418
+
## v22.10 upgrade notes
419
+
420
+
### Breaking changes
348
421
349
422
The updates to anonymous access described in the [release notes](https://www.kurrent.io/releases/kurrentdb/23-10/) have introduced some breaking changes. We have also removed, renamed, and deprecated some options in KurrentDB.
350
423
@@ -379,52 +452,3 @@ These options did not have any effect and can be safely removed from your config
379
452
We have renamed the event type used to store a persistent subscription configuration from `PersistentConfig1` to `$PersistentConfig`. This event type is a system event, so naming it as such will allow certain filters to exclude it correctly.
380
453
381
454
If you have any tools or clients relying on this event type, you will need to update them before upgrading.
382
-
383
-
## Deprecations
384
-
385
-
### Configuration sections and prefixes
386
-
387
-
The `EventStore` configuration section and configuration root has been renamed to `KurrentDB`.
388
-
389
-
The `EVENTSTORE_` environment variable prefix has been changed to `KURRENTDB_`
390
-
391
-
### Custom HTTP content types
392
-
393
-
The `vnd.eventstore.*` content types have been renamed to `vnd.kurrent.*`:
0 commit comments