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

Hunterness · 2025-04-01T14:41:35Z

We updated the store column to not say --0.0 in 2025.04 (and backported to next release of 5.LTS as well), and the currentPrimariesCount/currentSecondariesCount to be null to match what the requested versions already did.

Also added the sentence about being null for composite on the columns where that was already the case.

…bases return null

renetapopova

I left a suggestion. Otherwise, looks good.

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

renetapopova · 2025-04-01T16:09:32Z

We updated the store column to not say --0.0 in 2025.04

@Hunterness Where is this updated store column (that doesn't say --0.0 in 2025.04)? We need to mark the change with a label that it's available from 2025.04, but I don't see the change.

Hunterness · 2025-04-02T06:27:51Z

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

@@ -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 will be `NULL` for composite databases, as it is not applicable for them.


Where is this updated store column (that doesn't say --0.0 in 2025.04)? We need to mark the change with a label that it's available from 2025.04, but I don't see the change.

This is the store column, it's really just a bug fix as --0.0 isn't really a valid/useful storage engine/format. But we're not backporting it to the other calendar releases just the 5.LTS one 🤷

both the store, currentPrimariesCount and currentSecondariesCount columns got updated to return null for composite (the current_Count ones are also columns that now have this sentence)

Maybe we should add a footnote to explain that this change is applicable to 2025.04 and 5.25.5 and later.

5.26.5 maybe? but sure could work (but I don't know how to do a footnote)

Co-authored-by: Reneta Popova <[email protected]>

… and 5.26.5 and later

neo-technology-commit-status-publisher · 2025-04-03T15:31:23Z

This PR includes documentation updates
View the updated docs at https://neo4j-docs-operations-2212.surge.sh

Updated pages:

List databases

Hunterness · 2025-04-04T07:19:58Z

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

@@ -82,7 +82,7 @@ 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.
+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.25.5 and later.]


still don't think 5.25 is correct, the 5.LTS is 5.26

and should we mention the 5.X version here anyway or only in the 5.x version of the docs? (and then not mention the 2025.04 in the 5.x docs)

Hunterness · 2025-04-04T07:21:25Z

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

@@ -82,7 +82,7 @@ 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.
+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.25.5 and later.]


also the role column have been null since before, we only updated 3 of the columns but I added the comments in docs on all the columns where it applied as the old ones didn't have docs comments either.

Suggested change

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.25.5 and later.]

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

Hunterness · 2025-04-04T07:22:09Z

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

@@ -133,28 +133,28 @@ Not returned by `SHOW HOME DATABASE` or `SHOW DEFAULT DATABASE`.
 | 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.
+The value for composite databases is `NULL` because it does not apply to them.footnote:compositeDb[]


Suggested change

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

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.]

or if you want to keep the 5.LTS version info as well

Suggested change

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

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.]

Hunterness · 2025-04-04T07:22:28Z

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

 | 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.
+The value for composite databases is `NULL` because it does not apply to them.footnote:compositeDb[]


Suggested change

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

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

Hunterness · 2025-04-04T07:23:03Z

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

 | 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.footnote:compositeDb[]


Suggested change

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

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

Hunterness · 2025-04-04T07:23:42Z

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

@@ -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.


Suggested change

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

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

so you added the footnote to some that wasn't updated and missed one of the ones that were updated

Update column info for show databases to mention where composite data…

225bdab

…bases return null

Hunterness added cherry-pick-this-to-5.x team-cypher-operations 2025.04 labels Apr 1, 2025

renetapopova reviewed Apr 1, 2025

View reviewed changes

Hunterness commented Apr 2, 2025

View reviewed changes

Apply suggestions from code review

e224b02

Co-authored-by: Reneta Popova <[email protected]>

mnd999 requested a review from OliviaYtterbrink April 2, 2025 08:19

Hunterness added the cherry-pick-this-to-cypher-25 label Apr 2, 2025

Hunterness assigned OliviaYtterbrink Apr 3, 2025

OliviaYtterbrink approved these changes Apr 3, 2025

View reviewed changes

add a footnote that this change applies to versions 2025.04 and later…

2f42435

… and 5.26.5 and later

Hunterness commented Apr 4, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

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

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

Hunterness commented Apr 1, 2025 •

edited

Loading

renetapopova left a comment

renetapopova commented Apr 1, 2025

Hunterness Apr 2, 2025

Hunterness Apr 2, 2025

renetapopova Apr 3, 2025

Hunterness Apr 3, 2025

neo-technology-commit-status-publisher commented Apr 3, 2025

Hunterness Apr 4, 2025

Hunterness Apr 4, 2025

Hunterness Apr 4, 2025

Hunterness Apr 4, 2025

Hunterness Apr 4, 2025

Hunterness Apr 4, 2025

	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.25.5 and later.]
	The value for composite databases is `NULL` because it does not apply to them.

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

Are you sure you want to change the base?

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

Conversation

Hunterness commented Apr 1, 2025 • edited Loading

renetapopova left a comment

Choose a reason for hiding this comment

renetapopova commented Apr 1, 2025

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

neo-technology-commit-status-publisher commented Apr 3, 2025

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Hunterness commented Apr 1, 2025 •

edited

Loading