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.

  1. The store format version.

  2. When the store format version was introduced.

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

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

Table 1. Options
Name Description

--verbose

Enable verbose output.

--structured

Return result structured as JSON.

--all

Return store format info for all databases at provided path.

3. Examples

Example 1. Invoke neo4j-admin store-info against a database store
bin/neo4j-admin store-info data/databases/mygraph.db

Output:

Store format version:         SF4.0.0
Store format introduced in:   4.0.0
Example 2. Invoke neo4j-admin store-info against a database backup

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

Example 3. Invoke neo4j-admin store-info against a root containing several databases

The 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 in use and exclude all other information.

Example 4. Invoke neo4j-admin store-info against a database and output JSON

If 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

Table 2. Store versions — aligned
Store Format Name Store Format Version Neo4j Version

ALIGNED_V4_3

AF4.3.0

4.3.0

ALIGNED_V4_1

AF4.1.a

4.1.0

Table 3. Store limits — aligned
Name Limit

Property keys

2^24 (16 777 216)

Nodes

2^35 (34 359 738 368)

Relationships

2^35 (34 359 738 368)

Properties

2^36 (68 719 476 736)

Labels

2^32 (4 294 967 296)

Relationship types

2^16 (65 536)

Relationship groups

2^35 (34 359 738 368)

5. Store format — standard

Table 4. Store versions — standard
Store Format Name Store Format Version Neo4j Version

STANDARD_V4_3

SF4.3.0

4.3.0

STANDARD_V4_0

SF4.0.0

4.0.0

STANDARD_V3_4

v0.A.9

3.4.0

Table 5. Store limits — standard
Name Limit

Property keys

2^24 (16 777 216)

Nodes

2^35 (34 359 738 368)

Relationships

2^35 (34 359 738 368)

Properties

2^36 (68 719 476 736)

Labels

2^32 (4 294 967 296)

Relationship types

2^16 (65 536)

Relationship groups

2^35 (34 359 738 368)

6. Store format — high_limit

Table 6. Store versions — high_limit
Store Format Name Store Format Version Neo4j Version

HIGH_LIMIT_V4_3_0

HL4.3.0

4.3.0

HIGH_LIMIT_V4_0_0

HL4.0.0

4.0.0

HIGH_LIMIT_V3_4_0

vE.H.4

3.4.0

HIGH_LIMIT_V3_2_0

vE.H.3

3.2.0

HIGH_LIMIT_V3_1_0

vE.H.2

3.1.0

HIGH_LIMIT_V3_0_6

vE.H.0b

3.0.6

HIGH_LIMIT_V3_0_0

vE.H.0

3.0.0

Table 7. Store limits — high_limit
Name Limit

Property keys

2^24 (16 777 216)

Nodes

2^50 (1 Quadrillion)

Relationships

2^50 (1 Quadrillion)

Properties

2^50 (1 Quadrillion)

Labels

2^32 (4 294 967 296)

Relationship types

2^24 (16 777 216)

Relationship groups

2^50 (1 Quadrillion)