Skip to content

Add documentation on updated SHOW DATABASES behaviour #246

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 2 commits into from
Dec 14, 2022
Merged

Add documentation on updated SHOW DATABASES behaviour #246

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
48711d8
add documentation on show databases behaviour when servers are offline
jackwaudby Dec 6, 2022
9b4e011
Update to reflect suggestion
jackwaudby Dec 14, 2022
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
5 changes: 5 additions & 0 deletions modules/ROOT/pages/databases.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -258,6 +258,11 @@ However, some privileges enable users to see additional databases regardless of

If a user has not been granted `ACCESS` privilege to any databases nor any of the above special cases, the command can still be executed but will only return the `system` database, which is always visible.
====
[NOTE]
====
Databases hosted on servers that are offline are also returned by the `SHOW DATABASES` command.
For such databases, the `address` column displays `NULL`, the `currentStatus` column displays `unknown`, and the `statusMessage` displays `Server is unavailable`.
====

======

Expand Down
16 changes: 16 additions & 0 deletions modules/ROOT/pages/deprecations-additions-removals-compatibility.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,22 @@ Replacement syntax for deprecated and removed features are also indicated.
| Feature
| Details

a|
label:functionality[]
label:updated[]
[source, cypher, role="noheader"]
----
SHOW DATABASES
----
a|
Changes to the visibility of databases hosted on offline servers.

For such databases:

* The `address` column will return `NULL`.
* The `currentStatus` column will return `unknown`.
* The `statusMessage` will return `Server is unavailable`.

a|
label:functionality[]
label:updated[]
Expand Down