Skip to content

Commit fa31100

Browse files
author
Frannie-Ludmilla
committed
Add docs
1 parent 395ed4b commit fa31100

File tree

1 file changed

+9
-1
lines changed

1 file changed

+9
-1
lines changed

modules/ROOT/pages/reference/procedures.adoc

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2187,13 +2187,21 @@ For more information, see the link:{neo4j-docs-base-uri}/cypher-manual/{page-ver
21872187
a|
21882188
Place a database into quarantine or remove it from it.
21892189
| Signature
2190-
m|dbms.quarantineDatabase(databaseName :: STRING, setStatus :: BOOLEAN, reason = No reason given :: STRING) :: (databaseName :: STRING, quarantined :: BOOLEAN, result :: STRING)
2190+
m|dbms.quarantineDatabase(databaseName :: STRING, setStatus :: BOOLEAN, reason = No reason given :: STRING, wipeMode = DO_NOT_WIPE :: STRING) :: (databaseName :: STRING, quarantined :: BOOLEAN, result :: STRING)
21912191
| Mode
21922192
m|DBMS
21932193
// | Default roles
21942194
// m|admin
21952195
|===
21962196

2197+
[NOTE]
2198+
====
2199+
The `wipeMode` option is only enforced during the removal of a database from quarantine.
2200+
The possible values for `wipeMode` are: `DO_NOT_WIPE` (default value and previous behaviour), `WIPE_STATE_KEEP_STORE` and `WIPE_STATE_AND_STORE`.
2201+
Please keep in mind that the deletion of the cluster state and store (`WIPE_STATE_AND_STORE`) or even just the deletion of the state (`WIPE_STATE_KEEP_STORE`) could cause loss of data and should be carefully evaluated depending on the case.
2202+
====
2203+
2204+
21972205
[[procedure_dbms_queryjmx]]
21982206
.dbms.queryJmx()
21992207
[cols="<15s,<85"]

0 commit comments

Comments
 (0)