Skip to content

Add description for the fields of recreateDatabase procedure #2042

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jan 10, 2025
Merged

Add description for the fields of recreateDatabase procedure #2042

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 8 additions & 2 deletions modules/ROOT/pages/procedures.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -531,11 +531,17 @@ CALL dbms.cluster.readReplicaToggle("neo4j", false)
| *Description* 3+a| Recreates a database while keeping all RBAC settings.
The procedure initiates a process, which when complete, will have synchronized and started all database instances within the cluster.
.3+| *Input arguments* | *Name* | *Type* | *Description*
| `database` | `STRING` | database :: STRING
| `options` | `MAP` | options = {} :: MAP
| `database` | `STRING` | The name of the database to recreate.
| `options` | `MAP` | The seeding and topology options to use for recreating the database.
| *Mode* 3+| WRITE
|===

[NOTE]
====
It is mandatory to specify either `seedURI` or `seedingServers` as seeding options in the `options` field.
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.
If no topology option is defined, the database will be recreated with the previous topology.
====

[role=label--enterprise-edition label--deprecated-5.21]
[[procedure_dbms_cluster_routing_getroutingtable]]
Expand Down
Loading