Skip to content

Commit d1e84ac

Browse files
author
Frannie-Ludmilla
committed
Add docs
1 parent 8914fa7 commit d1e84ac

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
@@ -2044,13 +2044,21 @@ For more information, see the link:{neo4j-docs-base-uri}/cypher-manual/{page-ver
20442044
a|
20452045
Place a database into quarantine or remove it from it.
20462046
| Signature
2047-
m|dbms.quarantineDatabase(databaseName :: STRING, setStatus :: BOOLEAN, reason = No reason given :: STRING) :: (databaseName :: STRING, quarantined :: BOOLEAN, result :: STRING)
2047+
m|dbms.quarantineDatabase(databaseName :: STRING, setStatus :: BOOLEAN, reason = No reason given :: STRING, wipeMode = DO_NOT_WIPE :: STRING) :: (databaseName :: STRING, quarantined :: BOOLEAN, result :: STRING)
20482048
| Mode
20492049
m|DBMS
20502050
// | Default roles
20512051
// m|admin
20522052
|===
20532053

2054+
[NOTE]
2055+
====
2056+
The `wipeMode` option is only enforced during the removal of a database from quarantine.
2057+
The possible values for `wipeMode` are: `DO_NOT_WIPE` (default value and previous behaviour), `WIPE_STATE_KEEP_STORE` and `WIPE_STATE_AND_STORE`.
2058+
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.
2059+
====
2060+
2061+
20542062
[[procedure_dbms_queryjmx]]
20552063
.dbms.queryJmx()
20562064
[cols="<15s,<85"]

0 commit comments

Comments
 (0)