SHOW SETTINGS

Listing the configuration settings on a server can be done with SHOW SETTINGS.

The command SHOW SETTINGS returns settings on the executing server only. To retrieve settings on a specific server, you need to directly connect to it using bolt scheme.

The command SHOW SETTINGS returns only the default output. For a full output use the optional YIELD command. Full output: SHOW SETTINGS YIELD *.

The SHOW SETTINGS command will produce a table with the following columns:

Table 1. Show settings output
Column Description Type

name

The name of the setting. Default Output

STRING

value

The current value of the setting. Default Output

STRING

isDynamic

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

BOOLEAN

defaultValue

The default value of the setting. Default Output

STRING

description

The setting description. Default Output

STRING

startupValue

The value of the setting at last startup.

STRING

isExplicitlySet

Whether the value of the setting is explicitly set by the user, either through configuration or dynamically.

BOOLEAN

validValues

A description of valid values for the setting.

STRING

isDeprecated

Whether the setting is deprecated. Introduced in 5.9

BOOLEAN

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 RETURN clause, the YIELD clause is mandatory and must not be omitted.

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

Query
SHOW SETTINGS
Table 2. Result
name value isDynamic defaultValue description

"browser.allow_outgoing_connections"

"true"

false

"true"

"Configure the policy for outgoing Neo4j Browser connections."

"browser.credential_timeout"

"0s"

false

"0s"

"Configure the Neo4j Browser to time out logged in users after this idle period. Setting this to 0 indicates no limit."

"browser.post_connect_cmd"

""

false

""

"Commands to be run when Neo4j Browser successfully connects to this server. Separate multiple commands with semi-colon."

"browser.remote_content_hostname_whitelist"

"guides.neo4j.com,localhost"

false

"guides.neo4j.com,localhost"

"Whitelist of hosts for the Neo4j Browser to be allowed to fetch content from."

"browser.retain_connection_credentials"

"true"

false

"true"

"Configure the Neo4j Browser to store or not store user credentials."

"browser.retain_editor_history"

"true"

false

"true"

"Configure the Neo4j Browser to store or not store user editor history."

"client.allow_telemetry"

"true"

false

"true"

"Configure client applications such as Browser and Bloom to send Product Analytics data."

"db.checkpoint"

"PERIODIC"

false

"PERIODIC"

"Configures the general policy for when check-points should occur. The default policy is the 'periodic' check-point policy, as specified by the 'db.checkpoint.interval.tx' and 'db.checkpoint.interval.time' settings. The Neo4j Enterprise Edition provides two alternative policies: The first is the 'continuous' check-point policy, which will ignore those settings and run the check-point process all the time. The second is the 'volumetric' check-point policy, which makes a best-effort at check-pointing often enough so that the database doesn’t get too far behind on deleting old transaction logs in accordance with the 'db.tx_log.rotation.retention_policy' setting."

"db.checkpoint.interval.time"

"15m"

false

"15m"

"Configures the time interval between check-points. The database will not check-point more often than this (unless check pointing is triggered by a different event), but might check-point less often than this interval, if performing a check-point takes longer time than the configured interval. A check-point is a point in the transaction logs, which recovery would start from. Longer check-point intervals typically mean that recovery will take longer to complete in case of a crash. On the other hand, a longer check-point interval can also reduce the I/O load that the database places on the system, as each check-point implies a flushing and forcing of all the store files."

"db.checkpoint.interval.tx"

"100000"

false

"100000"

"Configures the transaction interval between check-points. The database will not check-point more often than this (unless check pointing is triggered by a different event), but might check-point less often than this interval, if performing a check-point takes longer time than the configured interval. A check-point is a point in the transaction logs, which recovery would start from. Longer check-point intervals typically mean that recovery will take longer to complete in case of a crash. On the other hand, a longer check-point interval can also reduce the I/O load that the database places on the system, as each check-point implies a flushing and forcing of all the store files. The default is '100000' for a check-point every 100000 transactions."

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 'server':

Query
SHOW SETTINGS YIELD name, value, description
WHERE name STARTS WITH 'server'
RETURN name, value, description
LIMIT 3
Table 3. Result
name value description

"server.backup.enabled"

"true"

"Enable support for running online backups."

"server.backup.exec_connector.command"

""

"Command to execute for ExecDataConnector list"

"server.backup.exec_connector.scheme"

""

"Schemes ExecDataConnector will match on"

Rows: 3

Listing specific settings

It is possible to specify which settings to return in the list by setting names.

Query
SHOW SETTINGS "server.bolt.enabled", "server.bolt.advertised_address", "server.bolt.listen_address"
Table 4. Result
name value isDynamic defaultValue description

"server.bolt.advertised_address"

"localhost:7687"

false

":7687"

"Advertised address for this connector."

"server.bolt.enabled"

"true"

false

"true"

"Enable the bolt connector."

"server.bolt.listen_address"

"localhost:7687"

false

":7687"

"Address the connector should bind to."

Rows: 3