Skip to content

Update the examples of display store information #2231

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
Apr 8, 2025
Merged

Update the examples of display store information #2231

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
bad7edf
update the outputs
renetapopova Apr 7, 2025
fa20011
apply suggestion from review
renetapopova Apr 7, 2025
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
71 changes: 40 additions & 31 deletions modules/ROOT/pages/database-internals/neo4j-admin-store-info.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,45 +81,59 @@ The `neo4j-admin database info` command has the following options:

== Examples

The following examples show how to use the `neo4j-admin database info` command to display information about a database and its store format.
All examples assume that the Neo4j server is Enterprise Edition and that the database is offline.

.Invoke `neo4j-admin database info` against a database store
====
[source, shell]
----
bin/neo4j-admin database info mygraph.db
bin/neo4j-admin database info healthcare
----

Output:

.Output
[results]
----
Store format version: record-aligned-1.1
Store format introduced in: 5.0.0
Database name: healthcare
Database in use: false
Store format version: block-block-1.1
Copy link
Collaborator

@NataliaIvakina NataliaIvakina Apr 7, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If we provide example with the block format, should we label it 'Enterprise edition'?

Copy link
Collaborator Author

@renetapopova renetapopova Apr 7, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do you mean to label the example output?

Copy link
Collaborator

@NataliaIvakina NataliaIvakina Apr 7, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I was thinking about labelling the whole example.
Now I think this would look weird.
I'm wondering if we need to clarify that we test Enterprise edition here. For example,

[source, shell]
----
bin/neo4j-admin database info healthcare
----
+
If you're using Neo4j Enterprise Edition, the output can be the following:
+
[results]
----
Database name:                healthcare
Database in use:              false
Store format version:         block-block-1.1
<....>
----

Copy link
Collaborator

@NataliaIvakina NataliaIvakina Apr 7, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Or it is unnecessary and we don't have to go into much detail here.

Copy link
Collaborator Author

@renetapopova renetapopova Apr 7, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I could add a sentence before all examples to say, "The following examples assume that you are using Neo4j Enterprise edition."

Copy link
Collaborator Author

@renetapopova renetapopova Apr 7, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey @NataliaIvakina, I added two intro sentences. Could you please take a look if they make sense?

Copy link
Collaborator

@NataliaIvakina NataliaIvakina Apr 8, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Perfect 👌 Looks great!

Store format introduced in: 5.14.0
Last committed transaction id:29
Store needs recovery: false
----
====

[role=enterprise-edition]
.Invoke `neo4j-admin database info` against all databases
====
The command can also be invoked against all databases, as follows:

`neo4j-admin database info --from-path=<databases-directory>`

[source, shell]
----
bin/neo4j-admin database info data/databases
bin/neo4j-admin database info --from-path=../data/databases
----

Output:

.Output
[results]
----
Database name: foo
Database in use: false
Store format version: record-aligned-1.1
Store format introduced in: 5.0.0
Last committed transaction id:2
Store needs recovery: true

Database name: bar
Database in use: true
Database name: healthcare
Database in use: false
Store format version: block-block-1.1
Store format introduced in: 5.14.0
Last committed transaction id:29
Store needs recovery: false

Database name: neo4j
Database in use: false
Store format version: block-block-1.1
Store format introduced in: 5.14.0
Last committed transaction id:27
Store needs recovery: false

Database name: system
Database in use: false
Store format version: record-aligned-1.1
Store format introduced in: 5.0.0
Last committed transaction id:213
Store needs recovery: false
----
====

Expand All @@ -133,22 +147,17 @@ When the command is invoked against several databases, if some are *online* they
.Invoke `neo4j-admin database info` against a database and output JSON
====

If you are parsing the results of this command you may use the `--format=json` option to receive the output as JSON.
If you are parsing the results of this command, you may use the `--format=json` option to receive the output as JSON.
All the same fields are included and all values are strings.

[source, shell]
----
bin/neo4j-admin database info --from-path data/databases --format=json foo
bin/neo4j-admin database info --from-path ../data/databases --format=json foo
----

Output:

.Output
[results]
----
{"databaseName":"foo",
"inUse":"false",
"storeFormat”:"record-aligned-1.1",
"storeFormatIntroduced”:"5.0.0",
"lastCommittedTransaction":"2",
"recoveryRequired":"true"}
{"databaseName":"healthcare","inUse":"false","storeFormat":"block-block-1.1","storeFormatIntroduced":"5.14.0","storeFormatSuperseded":null,"lastCommittedTransaction":"29","recoveryRequired":"false"}
----
====