Skip to content

Commit b9e02b4

Browse files
author
Frannie-Ludmilla
committed
Add description for the fields of recreateDatabase procedure
1 parent 3dd42c4 commit b9e02b4

File tree

1 file changed

+8
-2
lines changed

1 file changed

+8
-2
lines changed

modules/ROOT/pages/procedures.adoc

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -531,11 +531,17 @@ CALL dbms.cluster.readReplicaToggle("neo4j", false)
531531
| *Description* 3+a| Recreates a database while keeping all RBAC settings.
532532
The procedure initiates a process, which when complete, will have synchronized and started all database instances within the cluster.
533533
.3+| *Input arguments* | *Name* | *Type* | *Description*
534-
| `database` | `STRING` | database :: STRING
535-
| `options` | `MAP` | options = {} :: MAP
534+
| `database` | `STRING` | The name of the database to recreate.
535+
| `options` | `MAP` | The seeding and topology options to use for recreating the database.
536536
| *Mode* 3+| WRITE
537537
|===
538538

539+
[NOTE]
540+
====
541+
It is mandatory to specify either `seedURI` or `seedingServers` as seeding options in the `options` field.
542+
Further details on how to use the `dbms.cluster.recreateDatabase()` procedure are provided in the related section inside the xref:clustering/databases.adoc#recreate-databases[Managing databases in a cluster] page.
543+
If no topology option is defined, the database will be recreated with the previous topology.
544+
====
539545

540546
[role=label--enterprise-edition label--deprecated-5.21]
541547
[[procedure_dbms_cluster_routing_getroutingtable]]

0 commit comments

Comments
 (0)