Skip to content

Commit 02bad33

Browse files
JPryce-AklundhJPryce-Aklundh
authored
Merge branch 'dev' into procedure_playground_2
2 parents 0275619 + 92458a0 commit 02bad33

3 files changed

Lines changed: 192 additions & 0 deletions

File tree

‎modules/ROOT/content-nav.adoc‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -86,6 +86,7 @@
8686
** xref:configuration/dynamic-settings.adoc[]
8787
** xref:configuration/migrate-configuration.adoc[]
8888
** xref:configuration/validate-config.adoc[]
89+
** xref:configuration/show-settings.adoc[]
8990
** xref:configuration/configuration-settings.adoc[]
9091
*** xref:configuration/configuration-settings.adoc#_checkpoint_settings[Checkpoint settings]
9192
*** xref:configuration/configuration-settings.adoc#_cloud_storage_integration_settings[Cloud storage integration settings]

‎modules/ROOT/pages/configuration/index.adoc‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@ The topics described are:
1717
* xref:configuration/dynamic-settings.adoc[Update dynamic settings] -- How to configure certain Neo4j parameters while Neo4j is running.
1818
* xref:configuration/migrate-configuration.adoc[Migrate configurations] -- How to migrate configuration settings from a previous version of Neo4j to a new version.
1919
* xref:configuration/validate-config.adoc[Validate configurations] -- How to validate Neo4j and Log4j configurations.
20+
* xref:configuration/show-settings.adoc[Show configuration settings] -- How to list all available configuration settings using the `SHOW SETTINGS` command.
2021
* xref:configuration/configuration-settings.adoc[Configuration settings] -- A complete reference of all configuration settings.
2122

2223
For a complete reference of Neo4j configuration settings, see xref:configuration/configuration-settings.adoc[All configuration settings].

‎modules/ROOT/pages/configuration/show-settings.adoc‎

Lines changed: 190 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,190 @@
1+
:description: Information about the `SHOW SETTINGS` command.
2+
:keywords: SHOW SETTINGS, configuration settings, listing settings
3+
:page-role: not-on-aura
4+
= Show configuration settings
5+
6+
This page describes listing configuration settings using the `SHOW SETTINGS` command.
7+
For general information about the `SHOW` command, see the link:{neo4j-docs-base-uri}/cypher-manual/clauses/show/[Cypher Manual -> SHOW].
8+
9+
[NOTE]
10+
====
11+
* `SHOW SETTINGS` returns settings on the executing server only.
12+
To retrieve settings on a specific server, you need to directly connect to it using `bolt` scheme.
13+
For more information, see the link:{neo4j-docs-base-uri}/bolt/current/bolt[Bolt protocol documentation].
14+
15+
* Configurations settings can also be listed using the xref:procedures.adoc#procedure_dbms_listConfig[`dbms.listConfig()`] procedure.
16+
====
17+
18+
[[syntax]]
19+
== Syntax
20+
21+
For full details about the syntax descriptions, see xref:database-administration/syntax.adoc#administration-syntax-reading[Administration command syntax].
22+
23+
[options="header", width="100%", cols="1,5a"]
24+
|===
25+
| Action | Syntax
26+
27+
| List settings
28+
29+
a|
30+
[source, syntax, role="noheader"]
31+
----
32+
SHOW SETTING[S] [setting-name[,...]]
33+
[YIELD { * \| field[, ...] } [ORDER BY field[, ...]] [SKIP n] [LIMIT n]]
34+
[WHERE expression]
35+
[RETURN field[, ...] [ORDER BY field[, ...]] [SKIP n] [LIMIT n]]
36+
----
37+
|===
38+
39+
When using the `RETURN` clause, the `YIELD` clause is mandatory and must not be omitted.
40+
41+
[NOTE]
42+
====
43+
Setting names must be supplied as one or more comma-separated quoted `STRING` values or as an expression resolving to a `STRING` or a `LIST<STRING>`.
44+
As of Neo4j 2026.05, using Cypher 25, any setting names that resolve to `null` are ignored instead of causing a type error exception.
45+
This behavior aligns with not returning anything when the given setting name does not exist.
46+
====
47+
48+
[[return-columns]]
49+
== Return columns
50+
51+
The `SHOW SETTINGS` command returns the following columns:
52+
53+
.Listing settings output
54+
[options="header", width="100%", cols="3m,6,2m,2a"]
55+
|===
56+
| Column
57+
| Description
58+
| Type
59+
| Default output
60+
61+
| name
62+
| The name of the setting.
63+
| STRING
64+
| {check-mark}
65+
66+
| value
67+
| The current value of the setting.
68+
| STRING
69+
| {check-mark}
70+
71+
| isDynamic
72+
| Whether the value of the setting can be updated dynamically, without restarting the server.
73+
For dynamically updating a setting value, see link:{neo4j-docs-base-uri}/operations-manual/current/configuration/dynamic-settings/[Update dynamic settings].
74+
| BOOLEAN
75+
| {check-mark}
76+
77+
| defaultValue
78+
| The default value of the setting.
79+
| STRING
80+
| {check-mark}
81+
82+
| description
83+
| The setting description.
84+
| STRING
85+
| {check-mark}
86+
87+
| startupValue
88+
| The value of the setting at last startup.
89+
| STRING
90+
|
91+
92+
| isExplicitlySet
93+
| Whether the value of the setting is explicitly set by the user, either through configuration or dynamically.
94+
| BOOLEAN
95+
|
96+
97+
| validValues
98+
| A description of valid values for the setting.
99+
| STRING
100+
|
101+
102+
| isDeprecated
103+
| Whether the setting is deprecated.
104+
| BOOLEAN
105+
|
106+
|===
107+
108+
[[examples]]
109+
== Examples
110+
111+
The following examples show how to use the `SHOW SETTINGS` command to list configuration settings.
112+
113+
=== List all settings with default return columns
114+
[source, cypher]
115+
----
116+
SHOW SETTINGS
117+
----
118+
119+
=== List all settings with all return columns
120+
121+
[source, cypher]
122+
----
123+
SHOW SETTINGS YIELD *
124+
----
125+
126+
=== List all settings with specified return columns
127+
[source, cypher]
128+
----
129+
SHOW SETTINGS YIELD name, defaultValue, startupValue
130+
----
131+
132+
=== List named settings
133+
[source, cypher]
134+
----
135+
SHOW SETTINGS "server.bolt.enabled", "server.bolt.advertised_address", "server.bolt.listen_address"
136+
----
137+
138+
=== Filter `SHOW SETTINGS` with `WHERE`
139+
140+
[source, cypher]
141+
----
142+
SHOW SETTINGS YIELD name, value, description
143+
WHERE name STARTS WITH 'server'
144+
RETURN name, value, description
145+
----
146+
147+
[role=label--cypher-25 label--new-Neo4j-2026.05]
148+
[[combine-show-settings-with-general-cypher]]
149+
=== Combine `SHOW SETTINGS` with general Cypher clauses
150+
151+
The `SHOW SETTINGS` command can be combined with general Cypher clauses in a single query.
152+
153+
For example, checking that the current value of a setting is valid.
154+
155+
.Check if the current values of settings starting with `db.checkpoint` are valid
156+
[source, cypher]
157+
----
158+
SHOW SETTINGS
159+
YIELD name, value
160+
WHERE name STARTS WITH 'db.checkpoint'
161+
CALL dbms.checkConfigValue(name, value)
162+
YIELD valid, message
163+
RETURN name, value, valid, message;
164+
----
165+
166+
.Example output
167+
[result]
168+
----
169+
+-----------------------------------------------------------------------------+
170+
| name | value | valid | message |
171+
+-----------------------------------------------------------------------------+
172+
| "db.checkpoint" | "PERIODIC" | TRUE | "requires restart" |
173+
| "db.checkpoint.interval.time" | "15m" | TRUE | "requires restart" |
174+
| "db.checkpoint.interval.tx" | "100000" | TRUE | "requires restart" |
175+
| "db.checkpoint.interval.volume" | "250.00MiB" | TRUE | "requires restart" |
176+
| "db.checkpoint.iops.limit" | "600" | TRUE | "" |
177+
| "db.checkpoint.throughput.limit" | NULL | TRUE | "" |
178+
+-----------------------------------------------------------------------------+
179+
180+
6 rows
181+
ready to start consuming query after 46 ms, results consumed after another 13 ms
182+
----
183+
184+
[NOTE]
185+
====
186+
When combining `SHOW SETTINGS` with other clauses, the `YIELD` clause is mandatory and must not be omitted.
187+
`YIELD` must explicitly list the yielded columns.
188+
`YIELD *` is not permitted.
189+
The query must also end with a valid last clause (like a `RETURN` or an updating clause).
190+
====

0 commit comments

Comments
 (0)