Skip to content

Commit 40e3144

Browse files
authored
Update neo4j-admin database info syntax and options to reflect the code (#690)
Cherry-picked from #689
1 parent e711394 commit 40e3144

File tree

1 file changed

+42
-36
lines changed

1 file changed

+42
-36
lines changed

modules/ROOT/pages/tools/neo4j-admin/neo4j-admin-store-info.adoc

Lines changed: 42 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,8 @@
22
[[neo4j-admin-store-info]]
33
= Display store information
44

5-
You can use the `neo4j-admin database info` command to get the following information about the _store format_ of a given _database store_:
5+
You can use the `neo4j-admin database info` command to print information about a Neo4j database store.
6+
The following information about the _store format_ of a given _database store_ can be retrieved:
67

78
* The store format version.
89
* When the store format version was introduced.
@@ -16,57 +17,62 @@ The `neo4j-admin database info` command is located in the xref:configuration/fil
1617
The `neo4j-admin database info` command should be invoked against an *offline* database store or a backup and has the following syntax:
1718

1819
----
19-
neo4j-admin database info [-h] [--expand-commands]
20-
[--verbose]
21-
[--additional-config=<file>]
22-
[--format=text|json]
23-
[--from-path=<path>]
24-
[<database>]
25-
20+
neo4j-admin database info [-h] [--expand-commands] [--verbose]
21+
[--additional-config=<file>]
22+
[--format=text|json]
23+
[--from-path=<path>] [<database>]
2624
----
2725

26+
=== Parameters
27+
28+
.`neo4j-admin database info` parameters
29+
[options="header", cols="1m,3a,1m"]
30+
|===
31+
| Parameter
32+
| Description
33+
| Default
34+
35+
|[<database>]
36+
|Name of the database to show info for.
37+
Can contain * and ? for globbing.
38+
Note that * and ? have special meaning in some shells and might need to be escaped or used with quotes.
39+
| *
40+
|===
2841

29-
== Options
42+
=== Options
3043

3144
The `neo4j-admin database info` command has the following options:
3245

33-
.Options
34-
[options="header", cols="1m,1a, 3a"]
46+
.`neo4j-admin database info` options
47+
[options="header", cols="5m,6a,4m"]
3548
|===
36-
| Name
37-
| Possible values
49+
| Option
3850
| Description
51+
| Default
3952

40-
| -h, --help
41-
|
42-
| Show this help message and exit.
43-
44-
| --expand-commands
53+
|--additional-config=<file>
54+
|Configuration file with additional configuration.
4555
|
46-
| Allow command expansion in config value evaluation.
4756

48-
| --verbose
57+
|--expand-commands
58+
| Allow command expansion in config value evaluation.
4959
|
50-
| Enable verbose output.
5160

52-
| --additional-config
53-
| <file>
54-
| Configuration file with additional configuration.
61+
|--format=text\|json
62+
|The format of the returned information.
63+
|text
5564

56-
| --format
57-
| `text` or `json`
58-
| The format to use for the returned information.
59-
Default is `text`.
65+
|--from-path=<path>
66+
|Path to databases directory.
67+
|
6068

61-
| --from-path
62-
| <path>
63-
| Path to databases directory.
69+
|-h, --help
70+
| Show this help message and exit.
71+
|
6472

65-
| <database>
66-
|
67-
| Name of the database to show info for.
68-
Can contain `\*` and `?` for globbing.
69-
Default is `*`.
73+
|--verbose
74+
| Enable verbose output.
75+
|
7076
|===
7177

7278

0 commit comments

Comments
 (0)