Skip to content

Commit 225bdab

Browse files
committed
Update column info for show databases to mention where composite databases return null
1 parent 81f3635 commit 225bdab

File tree

1 file changed

+17
-3
lines changed

1 file changed

+17
-3
lines changed

modules/ROOT/pages/database-administration/standard-databases/listing-databases.adoc

Lines changed: 17 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ Depending on what you want to see, you can list:
3535

3636
* All databases.
3737
* A particular database.
38-
* The default database.
38+
* The DBMS default database.
3939
* The home database.
4040

4141
These commands return the following columns:
@@ -81,6 +81,8 @@ The default for a standalone database is `neo4j://localhost:7687`. label:default
8181

8282
| role
8383
| The current role of the database (`primary`, `secondary`, `unknown`). label:default-output[]
84+
85+
The value will be `NULL` for composite databases, as it is not applicable for them.
8486
| STRING
8587

8688
| writer
@@ -117,34 +119,42 @@ See <<database-states>> for more information.
117119

118120
| default
119121
|
120-
Show if this is the default database for the DBMS. label:default-output[]
122+
`true` if this is the default database for the DBMS. label:default-output[]
121123
Not returned by `SHOW HOME DATABASE` or `SHOW DEFAULT DATABASE`.
122124
| BOOLEAN
123125

124126
| home
125127
|
126-
Shown if this is the home database for the current user. label:default-output[]
128+
`true` if this is the home database for the current user. label:default-output[]
127129
Not returned by `SHOW HOME DATABASE` or `SHOW DEFAULT DATABASE`.
128130
| BOOLEAN
129131

130132
| `currentPrimariesCount`
131133
| Number of primaries for this database reported as running currently.
132134
It is the same as the number of rows where `role=primary` and `name=this database`.
135+
136+
The value will be `NULL` for composite databases, as it is not applicable for them.
133137
| INTEGER
134138

135139
| `currentSecondariesCount`
136140
| Number of secondaries for this database reported as running currently.
137141
It is the same as the number of rows where `role=secondary` and `name=this database`.
142+
143+
The value will be `NULL` for composite databases, as it is not applicable for them.
138144
| INTEGER
139145

140146
| `requestedPrimariesCount`
141147
| The requested number of primaries for this database.
142148
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.
149+
150+
The value will be `NULL` for composite databases, as it is not applicable for them.
143151
| INTEGER
144152

145153
| `requestedSecondariesCount`
146154
| The requested number of secondaries for this database.
147155
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.
156+
157+
The value will be `NULL` for composite databases, as it is not applicable for them.
148158
| INTEGER
149159

150160
| creationTime
@@ -171,6 +181,8 @@ The value is a string formatted as:
171181
----
172182
A database must be `online` or `deallocating` for this value to be available.
173183
For other database states the value will be `NULL`.
184+
185+
The value will be `NULL` for composite databases, as it is not applicable for them.
174186
| STRING
175187

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

196208
|options
197209
|The map of options applied to the database.
210+
211+
The value will be `NULL` for composite databases, as it is not applicable for them.
198212
| MAP
199213

200214
|===

0 commit comments

Comments
 (0)