Skip to content
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.

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

Update column info for show databases to mention where composite databases return null #2212

Merged
merged 9 commits into from
Apr 7, 2025
Original file line number Diff line number Diff line change
Expand Up @@ -35,13 +35,13 @@ Depending on what you want to see, you can list:

* All databases.
* A particular database.
* The default database.
* The DBMS default database.
* The home database.

These commands return the following columns:

.Listing databases output
[options="header", width="100%", cols="4m,6a,2m"]
[options="header", width="100%", cols="4m,6,2m"]
|===
| Column | Description | Type

Expand Down Expand Up @@ -81,6 +81,8 @@ The default for a standalone database is `neo4j://localhost:7687`. label:default

| role
| The current role of the database (`primary`, `secondary`, `unknown`). label:default-output[]

The value for composite databases is `NULL` because it does not apply to them.
| STRING

| writer
Expand Down Expand Up @@ -117,34 +119,42 @@ See <<database-states>> for more information.

| default
|
Show if this is the default database for the DBMS. label:default-output[]
`true` if this is the default database for the DBMS. label:default-output[]
Not returned by `SHOW HOME DATABASE` or `SHOW DEFAULT DATABASE`.
| BOOLEAN

| home
|
Shown if this is the home database for the current user. label:default-output[]
`true` if this is the home database for the current user. label:default-output[]
Not returned by `SHOW HOME DATABASE` or `SHOW DEFAULT DATABASE`.
| BOOLEAN

| `currentPrimariesCount`
| Number of primaries for this database reported as running currently.
It is the same as the number of rows where `role=primary` and `name=this database`.

The value for composite databases is `NULL` because it does not apply to them.footnote:compositeDb[This change applies to versions 2025.04 and later and 5.26.5 and later.]
| INTEGER

| `currentSecondariesCount`
| Number of secondaries for this database reported as running currently.
It is the same as the number of rows where `role=secondary` and `name=this database`.

The value for composite databases is `NULL` because it does not apply to them.footnote:compositeDb[]
| INTEGER

| `requestedPrimariesCount`
| The requested number of primaries for this database.
May be lower than current if the DBMS is currently reducing the number of copies of the database, or higher if it is currently increasing the number of copies.

The value for composite databases is `NULL` because it does not apply to them.
| INTEGER

| `requestedSecondariesCount`
| The requested number of secondaries for this database.
May be lower than current if the DBMS is currently reducing the number of copies of the database, or higher if it is currently increasing the number of copies.

The value for composite databases is `NULL` because it does not apply to them.
| INTEGER

| creationTime
Expand All @@ -160,7 +170,7 @@ May be lower than current if the DBMS is currently reducing the number of copies
| ZONED DATETIME

| store
a|
|
Information about the storage engine and the store format.

The value is a string formatted as:
Expand All @@ -171,6 +181,8 @@ The value is a string formatted as:
----
A database must be `online` or `deallocating` for this value to be available.
For other database states the value will be `NULL`.

The value for composite databases is `NULL` because it does not apply to them.footnote:compositeDb[]
| STRING

| lastCommittedTxn
Expand All @@ -195,6 +207,8 @@ For other database states the value will be `NULL`.

|options
|The map of options applied to the database.

The value for composite databases is `NULL` because it does not apply to them.
| MAP

|===
Expand Down