SHOW SETTINGS
Listing the configuration settings on a server can be done with SHOW SETTINGS
.
The command |
The command |
The SHOW SETTINGS
command will produce a table with the following columns:
Column | Description | Type |
---|---|---|
|
The name of the setting. Default Output |
|
|
The current value of the setting. Default Output |
|
|
Whether the value of the setting can be updated dynamically, without restarting the server. For dynamically updating a setting value, see Update dynamic settings. Default Output |
|
|
The default value of the setting. Default Output |
|
|
The setting description. Default Output |
|
|
The value of the setting at last startup. |
|
|
Whether the value of the setting is explicitly set by the user, either through configuration or dynamically. |
|
|
A description of valid values for the setting. |
|
|
Whether the setting is deprecated. Introduced in 5.9 |
|
Syntax
More details about the syntax descriptions can be found here. |
- List settings
SHOW SETTING[S] [setting-name[,...]]
[YIELD { * | field[, ...] } [ORDER BY field[, ...]] [SKIP n] [LIMIT n]]
[WHERE expression]
[RETURN field[, ...] [ORDER BY field[, ...]] [SKIP n] [LIMIT n]]
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>
.
When using the |
Listing all settings
To list all settings with the default output columns, the SHOW SETTINGS
command can be used.
If all columns are required, use SHOW SETTINGS YIELD *
.
SHOW SETTINGS
name | value | isDynamic | defaultValue | description |
---|---|---|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Rows: 10 |
The above table only displays the first 10 results of the query. For a full list of all available settings in Neo4j, refer to Configuration settings.
Listing settings with filtering on output columns
The listed settings can be filtered by using the WHERE
clause.
For example, the following query returns the name, value, and description of the first three settings starting with 'dbms':
SHOW SETTINGS YIELD name, value, description
WHERE name STARTS WITH 'dbms'
RETURN name, value, description
LIMIT 3
name | value | description |
---|---|---|
|
|
|
|
|
|
|
|
|
Rows: 3 |
Listing specific settings
It is possible to specify which settings to return in the list by setting names.
SHOW SETTINGS "server.bolt.enabled", "server.bolt.advertised_address", "server.bolt.listen_address"
name | value | isDynamic | defaultValue | description |
---|---|---|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Rows: 3 |