Skip to content
Merged
Changes from all commits
Commits
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/tools/neo4j-admin/neo4j-admin-store-info.adoc
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
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"}
----
====