Display store information
This chapter describes the
neo4j-admin store-info
command.
The neo4j-admin store-info
command outputs information about the store format for a given database store.
-
The store format version.
-
When the store format version was introduced.
-
Whether the store format needs to be migrated to a newer version.
The store format can be set with the dbms.record_format
configuration setting.
The store formats are:
-
aligned
-
standard
-
high_limit
Enterprise Edition
1. Syntax
The neo4j-admin store-info
command is located in the bin directory.
It is invoked against an offline database store or a backup as follows:
neo4j-admin store-info [--all] [--structured] [--verbose] <path>
<path>
— Path to database store, or databases directory if --all
option is used.
2. Options
Name | Description |
---|---|
|
Enable verbose output. |
|
Return result structured as JSON. |
|
Return store format info for all databases at provided path. |
3. Examples
neo4j-admin store-info
against a database storebin/neo4j-admin store-info data/databases/mygraph.db
Output:
Store format version: SF4.0.0 Store format introduced in: 4.0.0
neo4j-admin store-info
against a database backupYou can run the store-info
command to see if the store format of the backup that you want to restore, is compatible with your running Neo4j instance.
For example, if you want to restore the database backup /tmp/3518/mygraph.db into a 4.x Neo4j instance:
bin/neo4j-admin store-info /tmp/3518/mygraph.db
Output:
Store format version: vE.H.4 (1) Store format introduced in: 3.4.0 (2) Store format superseded in: 4.0.0 (3)
1 | The store format version reveals that the database is configured to use the high_limit , see dbms.record_format . |
2 | The store format version was introduced in Neo4j 3.4.0 . |
3 | The store format of the current instance is 4.0.0, which means that a format migration must be performed if you want to restore this backup into the current instance. |
For more information on how to migrate a single database, see Upgrade and Migration Guide → Tutorial: Back up and copy a database in a standalone instance. |
neo4j-admin store-info
against a root containing several databasesThe command can also be invoked against a root directory containing several databases, as follows:
neo4j-admin store-info <path> --all
bin/neo4j-admin store-info data/databases --all
Output:
Database name: foo Database in use: false Store format version: SF4.0.0 Store format introduced in: 4.0.0 Last committed transaction id:2 Store needs recovery: true Database name: bar Database in use: true
When the command is invoked against several databases, if some are online they will simply report as |
neo4j-admin store-info
against a database and output JSONIf you are parsing the results of this command you may use the --structured
option to receive the output as JSON.
All the same fields are included and all values are strings.
bin/neo4j-admin store-info data/databases/foo --structured
Output:
{"databaseName":"foo", "inUse":"false", "storeFormat”:"SF4.0.0", "storeFormatIntroduced”:"4.0.0", "lastCommittedTransaction":"2", "recoveryRequired":"true"}
4. Store format — aligned
Store Format Name | Store Format Version | Neo4j Version |
---|---|---|
|
|
|
|
|
|
Name | Limit |
---|---|
Property keys |
|
Nodes |
|
Relationships |
|
Properties |
|
Labels |
|
Relationship types |
|
Relationship groups |
|
5. Store format — standard
Store Format Name | Store Format Version | Neo4j Version |
---|---|---|
|
|
|
|
|
|
|
|
|
Name | Limit |
---|---|
Property keys |
|
Nodes |
|
Relationships |
|
Properties |
|
Labels |
|
Relationship types |
|
Relationship groups |
|
6. Store format — high_limit
Store Format Name | Store Format Version | Neo4j Version |
---|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Name | Limit |
---|---|
Property keys |
|
Nodes |
|
Relationships |
|
Properties |
|
Labels |
|
Relationship types |
|
Relationship groups |
|
Was this page helpful?