Skip to content

Commit d062f01

Browse files
Apply suggestions from code review
Co-authored-by: NataliaIvakina <[email protected]>
1 parent 7bfe5e3 commit d062f01

File tree

2 files changed

+9
-14
lines changed

2 files changed

+9
-14
lines changed

modules/ROOT/pages/database-administration/standard-databases/errors.adoc

Lines changed: 8 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -162,26 +162,26 @@ It produces a database dump that can be further examined and potentially repaire
162162

163163
When a database encounters a severe error during its normal run, which prevents it from a further operation, Neo4j stops that database and brings it into a `quarantined` state.
164164
Meaning, it is not possible to restart it with a simple `START DATABASE` command.
165-
You have to execute `CALL dbms.unquarantineDatabase(server, databaseName, operation)` in order to lift the quarantine, specifying as `server` the instance with the failing database.
165+
You have to run `CALL dbms.unquarantineDatabase(server, database, operation)` to lift the quarantine, specifying as `server` the instance with the failing database.
166+
167+
The `dbms.unquarantineDatabase()` procedure is introduced in Neo4j 2025.01 to replace the now-deprecated xref:procedures.adoc#procedure_dbms_quarantineDatabase[`dbms.quarantineDatabase`()].
166168

167169
After lifting the quarantine, the instance will automatically try to bring the database to the desired state.
168170

169171
*Syntax:*
170172

171-
`CALL dbms.unquarantineDatabase(server, databaseName, operation)`
173+
`CALL dbms.unquarantineDatabase(server, database, operation)`
172174

173-
*Arguments:*
175+
*Input arguments:*
174176

175177
[options="header"]
176178
|===
177179
| Name | Type | Description
178180
| `server` | String | The identifier of the server where the quarantine for database will be lifted.
179-
| `databaseName` | String | The name of the database that will be put into or removed from quarantine.
181+
| `database` | String | The name of the database that will be put into or removed from quarantine.
180182
| `operation` | String | Optional operation to apply while lifting the quarantine.
181183
|===
182184

183-
[NOTE]
184-
====
185185
The possible values for the optional operation are:
186186

187187
* `keepStateKeepStore` -- do nothing; leave store and cluster state as they are.
@@ -193,16 +193,11 @@ but this joining can succeed if and only if there is a majority of old members "
193193
Let's assume our cluster has a topology with three primaries.
194194
If there is only one server in `QUARANTINED` mode, then it is safe to choose `replaceStateKeepStore` or `replaceStateReplaceStore`.
195195
If there are two servers in `QUARANTINED` mode, then you should not use concurrently `replaceStateKeepStore` or `replaceStateReplaceStore` for both servers because there would be no majority to let them in.
196-
====
197196

198-
*Returns:*
197+
*Return arguments:*
199198

200199
The procedure doesn't return any value.
201200

202-
[NOTE]
203-
====
204-
The `dbms.unquarantineDatabase` procedure replaces xref:procedures.adoc#procedure_dbms_quarantineDatabase[`dbms.quarantineDatabase`], which has been deprecated in Neo4j 5.26.
205-
====
206201

207202
.Check if a database is quarantined
208203
[source, cypher]
@@ -226,7 +221,7 @@ neo4j@system> SHOW DATABASE foo;
226221
====
227222
A `quarantined` state is persisted for user databases.
228223
This means that if a database is quarantined, it will remain so even if that Neo4j instance is restarted.
229-
You can remove it only by running the xref:procedures.adoc#procedure_dbms_unquarantineDatabase[`dbms.unquarantineDatabase`] procedure.
224+
You can remove it only by running the xref:procedures.adoc#procedure_dbms_unquarantineDatabase[`dbms.unquarantineDatabase()`] procedure.
230225
231226
The one exception to this rule is for the built-in `system` database.
232227
Any quarantine for that database is removed automatically after instance restart.

modules/ROOT/pages/procedures.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1093,7 +1093,7 @@ The deprecated `dbms.quarantineDatabase()` procedure is available in Cypher 5, b
10931093
| *Description* 3+a| Lift quarantine from a database on a given server.
10941094
.4+| *Input arguments* | *Name* | *Type* | *Description*
10951095
| `server` | `STRING` | The identifier of the server where the quarantine for database will be lifted.
1096-
| `databaseName` | `STRING` | The name of the database for the quarantine will be lifted.
1096+
| `database` | `STRING` | The name of the database for the quarantine will be lifted.
10971097
| `operation` | `STRING` | Optional operation to apply while lifting the quarantine.
10981098
| *Mode* 3+| DBMS
10991099
|===

0 commit comments

Comments
 (0)