Skip to content

Commit b3dc5bd

Browse files
JPryce-AklundhrenetapopovaHunterness
committed
Move SHOW SETTINGS to ops manual (neo4j#3033)
Co-authored-by: Reneta Popova <reneta.popova@neo4j.com> Co-authored-by: Therese Magnusson <scout.therese@gmail.com>
1 parent 83105e0 commit b3dc5bd

3 files changed

Lines changed: 145 additions & 0 deletions

File tree

‎modules/ROOT/content-nav.adoc‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -80,6 +80,7 @@
8080
** xref:configuration/set-initial-password.adoc[]
8181
** xref:configuration/plugins.adoc[Plugins]
8282
** xref:configuration/dynamic-settings.adoc[]
83+
** xref:configuration/show-settings.adoc[]
8384
** xref:configuration/configuration-settings.adoc[]
8485
*** xref:configuration/configuration-settings.adoc#_checkpoint_settings[Checkpoint settings]
8586
*** 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
@@ -13,6 +13,7 @@ The topics described are:
1313
* xref:configuration/set-initial-password.adoc[Set initial password] -- How to set an initial password.
1414
* xref:configuration/plugins.adoc[Configure Neo4j plugins] -- How to load plugins to a Neo4j deployment.
1515
* xref:configuration/dynamic-settings.adoc[Update dynamic settings] -- How to configure certain Neo4j parameters while Neo4j is running.
16+
* xref:configuration/show-settings.adoc[Show configuration settings] -- How to list all available configuration settings using the `SHOW SETTINGS` command.
1617
* xref:configuration/configuration-settings.adoc[Configuration settings] -- A complete reference of all configuration settings.
1718

1819
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: 143 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,143 @@
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+
====
45+
46+
[[return-columns]]
47+
== Return columns
48+
49+
The `SHOW SETTINGS` command returns the following columns:
50+
51+
.Listing settings output
52+
[options="header", width="100%", cols="3m,6,2m,2a"]
53+
|===
54+
| Column
55+
| Description
56+
| Type
57+
| Default output
58+
59+
| name
60+
| The name of the setting.
61+
| STRING
62+
| {check-mark}
63+
64+
| value
65+
| The current value of the setting.
66+
| STRING
67+
| {check-mark}
68+
69+
| isDynamic
70+
| Whether the value of the setting can be updated dynamically, without restarting the server.
71+
For dynamically updating a setting value, see link:{neo4j-docs-base-uri}/operations-manual/current/configuration/dynamic-settings/[Update dynamic settings].
72+
| BOOLEAN
73+
| {check-mark}
74+
75+
| defaultValue
76+
| The default value of the setting.
77+
| STRING
78+
| {check-mark}
79+
80+
| description
81+
| The setting description.
82+
| STRING
83+
| {check-mark}
84+
85+
| startupValue
86+
| The value of the setting at last startup.
87+
| STRING
88+
|
89+
90+
| isExplicitlySet
91+
| Whether the value of the setting is explicitly set by the user, either through configuration or dynamically.
92+
| BOOLEAN
93+
|
94+
95+
| validValues
96+
| A description of valid values for the setting.
97+
| STRING
98+
|
99+
100+
| isDeprecated
101+
| Whether the setting is deprecated.
102+
| BOOLEAN
103+
|
104+
|===
105+
106+
[[examples]]
107+
== Examples
108+
109+
The following examples show how to use the `SHOW SETTINGS` command to list configuration settings.
110+
111+
=== List all settings with default return columns
112+
[source, cypher]
113+
----
114+
SHOW SETTINGS
115+
----
116+
117+
=== List all settings with all return columns
118+
119+
[source, cypher]
120+
----
121+
SHOW SETTINGS YIELD *
122+
----
123+
124+
=== List all settings with specified return columns
125+
[source, cypher]
126+
----
127+
SHOW SETTINGS YIELD name, defaultValue, startupValue
128+
----
129+
130+
=== List named settings
131+
[source, cypher]
132+
----
133+
SHOW SETTINGS "server.bolt.enabled", "server.bolt.advertised_address", "server.bolt.listen_address"
134+
----
135+
136+
=== Filter `SHOW SETTINGS` with `WHERE`
137+
138+
[source, cypher]
139+
----
140+
SHOW SETTINGS YIELD name, value, description
141+
WHERE name STARTS WITH 'server'
142+
RETURN name, value, description
143+
----

0 commit comments

Comments
 (0)