diff --git a/modules/ROOT/pages/configuration/configuration-settings.adoc b/modules/ROOT/pages/configuration/configuration-settings.adoc index 090eac162..821ca2464 100644 --- a/modules/ROOT/pages/configuration/configuration-settings.adoc +++ b/modules/ROOT/pages/configuration/configuration-settings.adoc @@ -29,8 +29,6 @@ The checkpoint settings control the frequency of checkpoints, and the amount of //For more information, see <>. See also, <>. -[[config_db.checkpoint]] - [[config_db.checkpoint]] === `db.checkpoint` @@ -40,7 +38,7 @@ See also, <>. |Description a|Configures the general policy for when checkpoints should occur. The default policy is the 'periodic' checkpoint policy, as specified by the xref:configuration/configuration-settings.adoc#config_db.checkpoint.interval.tx[`db.checkpoint.interval.tx`] and xref:configuration/configuration-settings.adoc#config_db.checkpoint.interval.time[`db.checkpoint.interval.time`] settings. The Neo4j Enterprise Edition provides two alternative policies: The first is the 'continuous' checkpoint policy, which will ignore those settings and run the checkpoint process all the time. The second is the 'volumetric' checkpoint policy, which makes a best-effort at checkpointing often enough so that the database doesn't get too far behind on deleting old transaction logs in accordance with the `<>` setting. |Valid values -a|one of [PERIODIC, CONTINUOUS, VOLUME, VOLUMETRIC] +a|One of [PERIODIC, CONTINUOUS, VOLUME, VOLUMETRIC]. |Default value m|+++PERIODIC+++ |=== @@ -54,7 +52,7 @@ m|+++PERIODIC+++ |Description a|Configures the time interval between checkpoints. The database will not checkpoint more often than this (unless checkpointing is triggered by a different event), but might checkpoint less often than this interval, if performing a checkpoint takes longer time than the configured interval. A checkpoint is a point in the transaction logs, which recovery would start from. Longer checkpoint intervals typically mean that recovery will take longer to complete in case of a crash. On the other hand, a longer checkpoint interval can also reduce the I/O load that the database places on the system, as each checkpoint implies a flushing and forcing of all the store files. |Valid values -a|a duration (Valid units are: `ns`, `μs`, `ms`, `s`, `m`, `h` and `d`; default unit is `s`) +a|A duration (Valid units are: `ns`, `μs`, `ms`, `s`, `m`, `h` and `d`; default unit is `s`). |Default value m|+++15m+++ |=== @@ -68,7 +66,7 @@ m|+++15m+++ |Description a|Configures the transaction interval between checkpoints. The database will not checkpoint more often than this (unless check pointing is triggered by a different event), but might checkpoint less often than this interval, if performing a checkpoint takes longer time than the configured interval. A checkpoint is a point in the transaction logs, which recovery would start from. Longer checkpoint intervals typically mean that recovery will take longer to complete in case of a crash. On the other hand, a longer checkpoint interval can also reduce the I/O load that the database places on the system, as each checkpoint implies a flushing and forcing of all the store files. The default is '100000' for a checkpoint every 100000 transactions. |Valid values -a|an integer which is minimum `1` +a|An integer that is minimum `1`. |Default value m|+++100000+++ |=== @@ -82,7 +80,7 @@ m|+++100000+++ |Description a|Configures the volume of transaction logs between checkpoints. The database will not checkpoint more often than this (unless check pointing is triggered by a different event), but might checkpoint less often than this interval, if performing a checkpoint takes longer time than the configured interval. A checkpoint is a point in the transaction logs, which recovery would start from. Longer checkpoint intervals typically mean that recovery will take longer to complete in case of a crash. On the other hand, a longer checkpoint interval can also reduce the I/O load that the database places on the system, as each checkpoint implies a flushing and forcing of all the store files. |Valid values -a|a byte size (valid multipliers are `B`, `KiB`, `KB`, `K`, `kB`, `kb`, `k`, `MiB`, `MB`, `M`, `mB`, `mb`, `m`, `GiB`, `GB`, `G`, `gB`, `gb`, `g`, `TiB`, `TB`, `PiB`, `PB`, `EiB`, `EB`) which is minimum `1.00KiB` +a|A byte size (valid multipliers are `B`, `KiB`, `KB`, `K`, `kB`, `kb`, `k`, `MiB`, `MB`, `M`, `mB`, `mb`, `m`, `GiB`, `GB`, `G`, `gB`, `gb`, `g`, `TiB`, `TB`, `PiB`, `PB`, `EiB`, `EB`) that is minimum `1.00KiB`. |Default value m|+++250.00MiB+++ |=== @@ -98,7 +96,7 @@ label:dynamic[Dynamic] |Description a|Limit the number of IOs the background checkpoint process will consume per second. This setting is advisory, is ignored in Neo4j Community Edition, and is followed to best effort in Enterprise Edition. An IO is in this case a 8 KiB (mostly sequential) write. Limiting the write IO in this way will leave more bandwidth in the IO subsystem to service random-read IOs, which is important for the response time of queries when the database cannot fit entirely in memory. The only drawback of this setting is that longer checkpoint times may lead to slightly longer recovery times in case of a database or system crash. A lower number means lower IO pressure, and consequently longer checkpoint times. Set this to -1 to disable the IOPS limit and remove the limitation entirely; this will let the checkpointer flush data as fast as the hardware will go. Removing the setting, or commenting it out, will set the default value of 600. |Valid values -a|an integer +a|An integer. |Default value m|+++600+++ |=== @@ -120,7 +118,7 @@ label:enterprise-edition[Enterprise Edition] |Description a|Interval of pulling updates from primaries. |Valid values -a|a duration (Valid units are: `ns`, `μs`, `ms`, `s`, `m`, `h` and `d`; default unit is `s`) +a|A duration (Valid units are: `ns`, `μs`, `ms`, `s`, `m`, `h` and `d`; default unit is `s`). |Default value m|+++1s+++ |=== @@ -136,7 +134,7 @@ label:enterprise-edition[Enterprise Edition] |Description a|The maximum number of bytes in the apply buffer. This parameter limits the amount of memory that can be consumed by the apply buffer. If the bytes limit is reached, buffer size will be limited even if max_entries is not exceeded. |Valid values -a|a byte size (valid multipliers are `B`, `KiB`, `KB`, `K`, `kB`, `kb`, `k`, `MiB`, `MB`, `M`, `mB`, `mb`, `m`, `GiB`, `GB`, `G`, `gB`, `gb`, `g`, `TiB`, `TB`, `PiB`, `PB`, `EiB`, `EB`) +a|A byte size (valid multipliers are `B`, `KiB`, `KB`, `K`, `kB`, `kb`, `k`, `MiB`, `MB`, `M`, `mB`, `mb`, `m`, `GiB`, `GB`, `G`, `gB`, `gb`, `g`, `TiB`, `TB`, `PiB`, `PB`, `EiB`, `EB`). |Default value m|+++1.00GiB+++ |=== @@ -152,7 +150,7 @@ label:enterprise-edition[Enterprise Edition] |Description a|The maximum number of entries in the raft log entry prefetch buffer. |Valid values -a|an integer +a|An integer. |Default value m|+++1024+++ |=== @@ -168,7 +166,7 @@ label:enterprise-edition[Enterprise Edition] |Description a|Largest batch processed by RAFT in bytes. |Valid values -a|a byte size (valid multipliers are `B`, `KiB`, `KB`, `K`, `kB`, `kb`, `k`, `MiB`, `MB`, `M`, `mB`, `mb`, `m`, `GiB`, `GB`, `G`, `gB`, `gb`, `g`, `TiB`, `TB`, `PiB`, `PB`, `EiB`, `EB`) +a|A byte size (valid multipliers are `B`, `KiB`, `KB`, `K`, `kB`, `kb`, `k`, `MiB`, `MB`, `M`, `mB`, `mb`, `m`, `GiB`, `GB`, `G`, `gB`, `gb`, `g`, `TiB`, `TB`, `PiB`, `PB`, `EiB`, `EB`). |Default value m|+++8.00MiB+++ |=== @@ -184,7 +182,7 @@ label:enterprise-edition[Enterprise Edition] |Description a|Maximum number of bytes in the RAFT in-queue. |Valid values -a|a byte size (valid multipliers are `B`, `KiB`, `KB`, `K`, `kB`, `kb`, `k`, `MiB`, `MB`, `M`, `mB`, `mb`, `m`, `GiB`, `GB`, `G`, `gB`, `gb`, `g`, `TiB`, `TB`, `PiB`, `PB`, `EiB`, `EB`) +a|A byte size (valid multipliers are `B`, `KiB`, `KB`, `K`, `kB`, `kb`, `k`, `MiB`, `MB`, `M`, `mB`, `mb`, `m`, `GiB`, `GB`, `G`, `gB`, `gb`, `g`, `TiB`, `TB`, `PiB`, `PB`, `EiB`, `EB`). |Default value m|+++2.00GiB+++ |=== @@ -192,7 +190,7 @@ m|+++2.00GiB+++ [[config_db.cluster.raft.leader_transfer.priority_group]] === `db.cluster.raft.leader_transfer.priority_group` -label:enterprise-edition[Enterprise Edition] +label:enterprise-edition[Enterprise Edition] label:deprecated[Deprecated in 5.4] .db.cluster.raft.leader_transfer.priority_group [frame="topbot", stripes=odd, grid="cols", cols="<1s,<4"] @@ -200,7 +198,7 @@ label:enterprise-edition[Enterprise Edition] |Description a|The name of a server_group whose members should be prioritized as leaders. This does not guarantee that members of this group will be leader at all times, but the cluster will attempt to transfer leadership to such a member when possible. If a database is specified using `db.cluster.raft.leader_transfer.priority_group`. the specified priority group will apply to that database only. If no database is specified that group will be the default and apply to all databases which have no priority group explicitly set. Using this setting will disable leadership balancing. |Valid values -a|a string identifying a Server Tag +a|A string identifying a server tag. |Default value m|++++++ |=== @@ -216,7 +214,7 @@ label:enterprise-edition[Enterprise Edition] |Description a|The name of a server tag whose members should be prioritized as leaders. This does not guarantee that members with this group will be leader at all times, but the cluster will attempt to transfer leadership to such a member when possible. If a database is specified using `db.cluster.raft.leader_transfer.priority_tag`. the specified priority tag will apply to that database only. If no database is specified that tag will be the default and apply to all databases which have no priority tag explicitly set. Using this setting will disable leadership balancing. |Valid values -a|a string identifying a server tag +a|A string identifying a server tag. |Default value m|++++++ |=== @@ -232,7 +230,7 @@ label:enterprise-edition[Enterprise Edition] |Description a|RAFT log pruning strategy that determines which logs are to be pruned. Neo4j only prunes log entries up to the last applied index, which guarantees that logs are only marked for pruning once the transactions within are safely copied over to the local transaction logs and safely committed by a majority of cluster members. Possible values are a byte size or a number of transactions (e.g., 200K txs). |Valid values -a|a string +a|A string. |Default value m|+++1g size+++ |=== @@ -248,7 +246,7 @@ label:enterprise-edition[Enterprise Edition] |Description a|The maximum number of bytes in the in-flight cache. This parameter limits the amount of memory that can be consumed by cache. If the bytes limit is reached, cache size will be limited even if max_entries is not exceeded. |Valid values -a|a byte size (valid multipliers are `B`, `KiB`, `KB`, `K`, `kB`, `kb`, `k`, `MiB`, `MB`, `M`, `mB`, `mb`, `m`, `GiB`, `GB`, `G`, `gB`, `gb`, `g`, `TiB`, `TB`, `PiB`, `PB`, `EiB`, `EB`) +a|A byte size (valid multipliers are `B`, `KiB`, `KB`, `K`, `kB`, `kb`, `k`, `MiB`, `MB`, `M`, `mB`, `mb`, `m`, `GiB`, `GB`, `G`, `gB`, `gb`, `g`, `TiB`, `TB`, `PiB`, `PB`, `EiB`, `EB`). |Default value m|+++1.00GiB+++ |=== @@ -264,7 +262,7 @@ label:enterprise-edition[Enterprise Edition] |Description a|The maximum number of entries in the in-flight cache. Increasing size will require more memory but might improve performance in high load situations. |Valid values -a|an integer +a|An integer. |Default value m|+++1024+++ |=== @@ -280,7 +278,7 @@ label:enterprise-edition[Enterprise Edition] |Description a|The catch up protocol times out if the given duration elapses with no network activity. Every message received by the client from the server extends the time out duration. |Valid values -a|a duration (Valid units are: `ns`, `μs`, `ms`, `s`, `m`, `h` and `d`; default unit is `s`) +a|A duration (Valid units are: `ns`, `μs`, `ms`, `s`, `m`, `h` and `d`; default unit is `s`). |Default value m|+++10m+++ |=== @@ -297,7 +295,7 @@ label:enterprise-edition[Enterprise Edition] a|A comma-separated list of endpoints which a server should contact in order to discover other cluster members. Typically, all members of the cluster, including the current server, should be specified in this list. |Valid values -a|a ',' separated list with elements of type 'a socket address in the format 'hostname:port', 'hostname' or ':port''. +a|A comma-separated list where each element is a socket address in the format of `hostname:port`, `hostname`, or `:port`. |Default value m| |=== @@ -313,7 +311,7 @@ label:enterprise-edition[Enterprise Edition] |Description a|The level of middleware logging. |Valid values -a|one of [DEBUG, INFO, WARN, ERROR, NONE] +a|One of [DEBUG, INFO, WARN, ERROR, NONE]. |Default value m|+++WARN+++ |=== @@ -329,11 +327,30 @@ label:enterprise-edition[Enterprise Edition] |Description a|Configure the discovery resolver type used for cluster member resolution. |Valid values -a|one of [DNS, LIST, SRV, K8S] which may require different settings depending on the discovery type: `DNS requires [dbms.cluster.discovery.endpoints], LIST requires [], SRV requires [dbms.cluster.discovery.endpoints], K8S requires [dbms.kubernetes.label_selector, dbms.kubernetes.service_port_name]` +a|A string. |Default value m|+++LIST+++ |=== + +[[conifg_]] +=== `dbms.cluster.discovery.type` + +label:enterprise-edition[Enterprise Edition] label:deprecated[Deprecated in 5.7] + +.dbms.cluster.discovery.type +[frame="topbot", stripes=odd, grid="cols", cols="<1s,<4"] +|=== +|Description +a|This setting has been replaced by 'dbms.cluster.discovery.resolver_type' +|Valid values +a|One of [DNS, LIST, SRV, K8S]. +|Default value +m|+++LIST+++ +|=== + +[[config_dbms.cluster.discovery.verification_timeout]] + [[config_dbms.cluster.minimum_initial_system_primaries_count]] === `dbms.cluster.minimum_initial_system_primaries_count` @@ -345,7 +362,7 @@ label:enterprise-edition[Enterprise Edition] |Description a|Minimum number of machines initially required to form a clustered DBMS. The cluster is considered formed when at least this many members have discovered each other, bound together and bootstrapped a highly available system database. As a result, at least this many of the cluster's initial machines must have `<>` set to 'PRIMARY'.NOTE: If `<>` is set to 'LIST' and `<>` is empty then the user is assumed to be deploying a standalone DBMS, and the value of this setting is ignored. |Valid values -a|an integer which is minimum `2` +a|An integer that is minimum `2`. |Default value m|+++3+++ |=== @@ -361,7 +378,7 @@ label:enterprise-edition[Enterprise Edition] |Description a|Time out for protocol negotiation handshake. |Valid values -a|a duration (Valid units are: `ns`, `μs`, `ms`, `s`, `m`, `h` and `d`; default unit is `s`) +a|A duration (Valid units are: `ns`, `μs`, `ms`, `s`, `m`, `h` and `d`; default unit is `s`). |Default value m|+++20s+++ |=== @@ -377,7 +394,7 @@ label:enterprise-edition[Enterprise Edition] |Description a|Maximum chunk size allowable across network by clustering machinery. |Valid values -a|an integer which is in the range `4096` to `10485760` +a|An integer that is in the range `4096` to `10485760`. |Default value m|+++32768+++ |=== @@ -393,7 +410,7 @@ label:enterprise-edition[Enterprise Edition] |Description a|Network compression algorithms that this instance will allow in negotiation as a comma-separated list. Listed in descending order of preference for incoming connections. An empty list implies no compression. For outgoing connections this merely specifies the allowed set of algorithms and the preference of the remote peer will be used for making the decision. Allowable values: [Gzip, Snappy, Snappy_validating, LZ4, LZ4_high_compression, LZ_validating, LZ4_high_compression_validating] |Valid values -a|a ',' separated list with elements of type 'a string'. +a|A comma-separated list where each element is a string. |Default value m|++++++ |=== @@ -409,9 +426,9 @@ label:enterprise-edition[Enterprise Edition] |Description a|The time allowed for a database on a Neo4j server to either join a cluster or form a new cluster with the other Neo4j Servers provided by `<>`. |Valid values -a|a duration (Valid units are: `ns`, `μs`, `ms`, `s`, `m`, `h` and `d`; default unit is `s`) +a|A duration (Valid units are: `ns`, `μs`, `ms`, `s`, `m`, `h` and `d`; default unit is `s`). |Default value -m|+++24h+++ +m|+++1d+++ |=== [[config_dbms.cluster.raft.client.max_channels]] @@ -425,7 +442,7 @@ label:enterprise-edition[Enterprise Edition] |Description a|The maximum number of TCP channels between two nodes to operate the raft protocol. Each database gets allocated one channel, but a single channel can be used by more than one database. |Valid values -a|an integer +a|An integer. |Default value m|+++8+++ |=== @@ -441,7 +458,7 @@ label:enterprise-edition[Enterprise Edition] |Description a|The rate at which leader elections happen. Note that due to election conflicts it might take several attempts to find a leader. The window should be significantly larger than typical communication delays to make conflicts unlikely. |Valid values -a|a duration-range (Valid units are: `ns`, `μs`, `ms`, `s`, `m`, `h` and `d`; default unit is `s`) +a|A duration-range (Valid units are: `ns`, `μs`, `ms`, `s`, `m`, `h` and `d`; default unit is `s`). |Default value m|+++3s-6s+++ |=== @@ -457,7 +474,7 @@ label:enterprise-edition[Enterprise Edition] |Description a|The time window within which the loss of the leader is detected and the first re-election attempt is held. The window should be significantly larger than typical communication delays to make conflicts unlikely. |Valid values -a|a duration-range (Valid units are: `ns`, `μs`, `ms`, `s`, `m`, `h` and `d`; default unit is `s`) +a|A duration-range (Valid units are: `ns`, `μs`, `ms`, `s`, `m`, `h` and `d`; default unit is `s`). |Default value m|+++20s-23s+++ |=== @@ -473,7 +490,7 @@ label:enterprise-edition[Enterprise Edition] |Description a|Which strategy to use when transferring database leaderships around a cluster. This can be one of `equal_balancing` or `no_balancing`. `equal_balancing` automatically ensures that each Core server holds the leader role for an equal number of databases.`no_balancing` prevents any automatic balancing of the leader role. Note that if a `leadership_priority_group` is specified for a given database, the value of this setting will be ignored for that database. |Valid values -a|one of [NO_BALANCING, EQUAL_BALANCING] +a|One of [NO_BALANCING, EQUAL_BALANCING]. |Default value m|+++EQUAL_BALANCING+++ |=== @@ -489,7 +506,7 @@ label:enterprise-edition[Enterprise Edition] |Description a|RAFT log pruning frequency. |Valid values -a|a duration (Valid units are: `ns`, `μs`, `ms`, `s`, `m`, `h` and `d`; default unit is `s`) +a|A duration (Valid units are: `ns`, `μs`, `ms`, `s`, `m`, `h` and `d`; default unit is `s`). |Default value m|+++10m+++ |=== @@ -505,7 +522,7 @@ label:enterprise-edition[Enterprise Edition] |Description a|RAFT log reader pool size. |Valid values -a|an integer +a|An integer. |Default value m|+++8+++ |=== @@ -521,7 +538,7 @@ label:enterprise-edition[Enterprise Edition] |Description a|RAFT log rotation size. |Valid values -a|a byte size (valid multipliers are `B`, `KiB`, `KB`, `K`, `kB`, `kb`, `k`, `MiB`, `MB`, `M`, `mB`, `mb`, `m`, `GiB`, `GB`, `G`, `gB`, `gb`, `g`, `TiB`, `TB`, `PiB`, `PB`, `EiB`, `EB`) which is minimum `1.00KiB` +a|A byte size (valid multipliers are `B`, `KiB`, `KB`, `K`, `kB`, `kb`, `k`, `MiB`, `MB`, `M`, `mB`, `mb`, `m`, `GiB`, `GB`, `G`, `gB`, `gb`, `g`, `TiB`, `TB`, `PiB`, `PB`, `EiB`, `EB`) that is minimum `1.00KiB`. |Default value m|+++250.00MiB+++ |=== @@ -537,7 +554,7 @@ label:enterprise-edition[Enterprise Edition] |Description a|Maximum amount of lag accepted for a new follower to join the Raft group. |Valid values -a|a duration (Valid units are: `ns`, `μs`, `ms`, `s`, `m`, `h` and `d`; default unit is `s`) +a|A duration (Valid units are: `ns`, `μs`, `ms`, `s`, `m`, `h` and `d`; default unit is `s`). |Default value m|+++10s+++ |=== @@ -553,7 +570,7 @@ label:enterprise-edition[Enterprise Edition] |Description a|Time out for a new member to catch up. |Valid values -a|a duration (Valid units are: `ns`, `μs`, `ms`, `s`, `m`, `h` and `d`; default unit is `s`) +a|A duration (Valid units are: `ns`, `μs`, `ms`, `s`, `m`, `h` and `d`; default unit is `s`). |Default value m|+++10m+++ |=== @@ -569,7 +586,7 @@ label:enterprise-edition[Enterprise Edition] |Description a|Maximum retry time per request during store copy. Regular store files and indexes are downloaded in separate requests during store copy. This configures the maximum time failed requests are allowed to resend. |Valid values -a|a duration (Valid units are: `ns`, `μs`, `ms`, `s`, `m`, `h` and `d`; default unit is `s`) +a|A duration (Valid units are: `ns`, `μs`, `ms`, `s`, `m`, `h` and `d`; default unit is `s`). |Default value m|+++20m+++ |=== @@ -585,7 +602,7 @@ label:enterprise-edition[Enterprise Edition] label:new[Introduced in 5.10] |Description a|Automatically enable free servers. |Valid values -a|a boolean +a|A boolean. |Default value m|+++false+++ |=== @@ -601,7 +618,7 @@ label:enterprise-edition[Enterprise Edition] |Description a|Name of the initial database allocator. After the creation of the dbms it can be set with the 'dbms.setDatabaseAllocator' procedure. |Valid values -a|a string +a|A string. |Default value m|+++EQUAL_NUMBERS+++ |=== @@ -617,8 +634,7 @@ label:enterprise-edition[Enterprise Edition] |Description a|Initial default number of primary instances of user databases. If the user does not specify the number of primaries in 'CREATE DATABASE', this value will be used, unless it is overwritten with the 'dbms.setDefaultAllocationNumbers' procedure. |Valid values -a|an integer which is minimum `1` and is maximum `11`. -The same value applies to runtime max number. +a|An integer that is minimum `1` and is maximum `11`. |Default value m|+++1+++ |=== @@ -634,8 +650,7 @@ label:enterprise-edition[Enterprise Edition] |Description a|Initial default number of secondary instances of user databases. If the user does not specify the number of secondaries in 'CREATE DATABASE', this value will be used, unless it is overwritten with the 'dbms.setDefaultAllocationNumbers' procedure. |Valid values -a|an integer which is minimum `0` and is maximum `20`. -The same value applies to runtime max number. +a|An integer that is minimum `0` and is maximum `20`. |Default value m|+++0+++ |=== @@ -651,7 +666,7 @@ label:enterprise-edition[Enterprise Edition] |Description a|The names of databases that are allowed on this server - all others are denied. Empty means all are allowed. Can be overridden when enabling the server, or altered at runtime, without changing this setting. Exclusive with 'server.initial_denied_databases' |Valid values -a|a ',' separated set with elements of type 'a string'. +a|A comma-separated set where each element is a string. |Default value m|++++++ |=== @@ -667,7 +682,7 @@ label:enterprise-edition[Enterprise Edition] |Description a|The names of databases that are not allowed on this server. Empty means nothing is denied. Can be overridden when enabling the server, or altered at runtime, without changing this setting. Exclusive with 'server.initial_allowed_databases' |Valid values -a|a ',' separated set with elements of type 'a string'. +a|A comma-separated set where each element is a string. |Default value m|++++++ |=== @@ -683,7 +698,7 @@ label:enterprise-edition[Enterprise Edition] |Description a|An instance can restrict itself to allow databases to be hosted only as primaries or secondaries. This setting is the default input for the `ENABLE SERVER` command - the user can overwrite it when executing the procedure. |Valid values -a|one of [PRIMARY, SECONDARY, NONE] +a|One of [PRIMARY, SECONDARY, NONE]. |Default value m|+++NONE+++ |=== @@ -699,7 +714,7 @@ label:enterprise-edition[Enterprise Edition] |Description a|A list of tag names for the server used by database allocation and when configuring load balancing and replication policies. |Valid values -a|a ',' separated list with elements of type 'a string identifying a Server Tag'. +a|A comma-separated list where each element is a string identifying a server tag, which contains no duplicate items. |Default value m|++++++ |=== @@ -715,7 +730,7 @@ label:enterprise-edition[Enterprise Edition] |Description a|Advertised hostname/IP address and port for the transaction shipping server. |Valid values -a|a socket address in the format 'hostname:port', 'hostname' or ':port' which accessible address. If missing port or hostname it is acquired from server.default_advertised_address +a|A socket address in the format of `hostname:port`, `hostname`, or `:port` that is an accessible address. If missing, it is acquired from server.default_advertised_address. |Default value m|+++:6000+++ |=== @@ -723,7 +738,7 @@ m|+++:6000+++ [[config_server.cluster.catchup.connect_randomly_to_server_group]] === `server.cluster.catchup.connect_randomly_to_server_group` -label:enterprise-edition[Enterprise Edition] label:dynamic[Dynamic] +label:enterprise-edition[Enterprise Edition] label:dynamic[Dynamic] label:deprecated[Deprecated in 5.4] .server.cluster.catchup.connect_randomly_to_server_group [frame="topbot", stripes=odd, grid="cols", cols="<1s,<4"] @@ -731,7 +746,7 @@ label:enterprise-edition[Enterprise Edition] label:dynamic[Dynamic] |Description a|Comma separated list of groups to be used by the connect-randomly-to-server-group selection strategy. The connect-randomly-to-server-group strategy is used if the list of strategies (`<>`) includes the value `connect-randomly-to-server-group`. |Valid values -a|a ',' separated list with elements of type 'a string identifying a Server Tag'. +a|A comma-separated list where each element is a string identifying a server tag. |Default value m|++++++ |=== @@ -747,7 +762,7 @@ label:enterprise-edition[Enterprise Edition] label:dynamic[Dynamic] |Description a|Comma separated list of groups to be used by the connect-randomly-to-server-with-tag selection strategy. The connect-randomly-to-server-with-tag strategy is used if the list of strategies (`<>`) includes the value `connect-randomly-to-server-with-tag`. |Valid values -a|a ',' separated list with elements of type 'a string identifying a Server Tag'. +a|A comma-separated list where each element is a string identifying a server tag. |Default value m|++++++ |=== @@ -763,7 +778,7 @@ label:enterprise-edition[Enterprise Edition] |Description a|An ordered list in descending preference of the strategy which secondaries use to choose the upstream server from which to pull transactional updates. If none are valid or the list is empty, there is a default strategy of `typically-connect-to-random-secondary`. |Valid values -a|a ',' separated list with elements of type 'a string'. +a|A comma-separated list where each element is a string. |Default value m|++++++ |=== @@ -779,7 +794,7 @@ label:enterprise-edition[Enterprise Edition] |Description a|Configuration of a user-defined upstream selection strategy. The user-defined strategy is used if the list of strategies (`<>`) includes the value `user_defined`. |Valid values -a|a string +a|A string. |Default value m|++++++ |=== @@ -795,7 +810,7 @@ label:enterprise-edition[Enterprise Edition] |Description a|Network interface and port for the transaction shipping server to listen on. Please note that it is also possible to run the backup client against this port so always limit access to it via the firewall and configure an ssl policy. |Valid values -a|a socket address in the format 'hostname:port', 'hostname' or ':port'. If missing port or hostname it is acquired from server.default_listen_address +a|A socket address in the format of `hostname:port`, `hostname`, or `:port`. If missing, it is acquired from server.default_listen_address. |Default value m|+++:6000+++ |=== @@ -811,7 +826,7 @@ label:enterprise-edition[Enterprise Edition] |Description a|Use native transport if available. Epoll for Linux or Kqueue for MacOS/BSD. If this setting is set to false, or if native transport is not available, Nio transport will be used. |Valid values -a|a boolean +a|A boolean. |Default value m|+++true+++ |=== @@ -827,7 +842,7 @@ label:enterprise-edition[Enterprise Edition] |Description a|Advertised hostname/IP address and port for the RAFT server. |Valid values -a|a socket address in the format 'hostname:port', 'hostname' or ':port' which accessible address. If missing port or hostname it is acquired from server.default_advertised_address +a|A socket address in the format of `hostname:port`, `hostname`, or `:port` that is an accessible address. If missing, it is acquired from server.default_advertised_address. |Default value m|+++:7000+++ |=== @@ -843,7 +858,7 @@ label:enterprise-edition[Enterprise Edition] |Description a|Network interface and port for the RAFT server to listen on. |Valid values -a|a socket address in the format 'hostname:port', 'hostname' or ':port'. If missing port or hostname it is acquired from server.default_listen_address +a|A socket address in the format of `hostname:port`, `hostname`, or `:port`. If missing, it is acquired from server.default_listen_address. |Default value m|+++:7000+++ |=== @@ -859,7 +874,7 @@ label:enterprise-edition[Enterprise Edition] |Description a|Users must manually specify the mode for the system database on each instance. |Valid values -a|one of [PRIMARY, SECONDARY] +a|One of [PRIMARY, SECONDARY]. |Default value m|+++PRIMARY+++ |=== @@ -875,7 +890,7 @@ label:enterprise-edition[Enterprise Edition] |Description a|Host and port to bind the cluster member discovery management communication. |Valid values -a|a socket address in the format 'hostname:port', 'hostname' or ':port'. If missing port or hostname it is acquired from server.default_listen_address +a|A socket address in the format of `hostname:port`, `hostname`, or `:port`. If missing, it is acquired from server.default_listen_address. |Default value m|+++:5000+++ |=== @@ -883,7 +898,7 @@ m|+++:5000+++ [[config_server.groups]] === `server.groups` -label:enterprise-edition[Enterprise Edition] label:dynamic[Dynamic] label:deprecated[Deprecated in 5.4] +label:enterprise-edition[Enterprise Edition] label:deprecated[Deprecated in 5.4] .server.groups [frame="topbot", stripes=odd, grid="cols", cols="<1s,<4"] @@ -891,7 +906,7 @@ label:enterprise-edition[Enterprise Edition] label:dynamic[Dynamic] label:deprec |Description a|A list of tag names for the server used when configuring load balancing and replication policies. |Valid values -a|a ',' separated list with elements of type 'a string identifying a Server Tag'. +a|A comma-separated list where each element is a string identifying a server tag. |Default value m|++++++ |Replaced by @@ -916,7 +931,7 @@ When configuring the HTTPS or xref:/performance/bolt-thread-pool-configuration.a |Description a|Advertised address for this connector. |Valid values -a|a socket address in the format 'hostname:port', 'hostname' or ':port' which accessible address. If missing, port or hostname, it is acquired from `server.default_advertised_address`. +a|A socket address in the format of `hostname:port`, `hostname`, or `:port` that is an accessible address. If missing, it is acquired from `server.default_advertised_address`. |Default value m|+++:7687+++ |=== @@ -930,9 +945,9 @@ m|+++:7687+++ |Description a|The maximum time to wait before sending a NOOP on connections waiting for responses from active ongoing queries.The minimum value is 1 millisecond. |Valid values -a|a duration (Valid units are: `ns`, `μs`, `ms`, `s`, `m`, `h` and `d`; default unit is `s`) which is minimum `1ms` +a|A duration (Valid units are: `ns`, `μs`, `ms`, `s`, `m`, `h` and `d`; default unit is `s`) that is minimum `1ms`. |Default value -m|1m +m|+++1m+++ |=== [[config_server.bolt.connection_keep_alive_for_requests]] @@ -944,9 +959,9 @@ m|1m |Description a|The type of messages to enable keep-alive messages for (ALL, STREAMING or OFF) |Valid values -a|one of [ALL, STREAMING, OFF] +a|One of [ALL, STREAMING, OFF]. |Default value -m|STREAMING +m|+++ALL+++ |=== [[config_server.bolt.connection_keep_alive_probes]] @@ -958,9 +973,9 @@ m|STREAMING |Description a|The total amount of probes to be missed before a connection is considered stale.The minimum for this value is 1. |Valid values -a|an integer which is minimum `1` +a|An integer that is minimum `1`. |Default value -m|2 +m|+++2+++ |=== [[config_server.bolt.connection_keep_alive_streaming_scheduling_interval]] @@ -972,9 +987,9 @@ m|2 |Description a|The interval between every scheduled keep-alive check on all connections with active queries. Zero duration turns off keep-alive service. |Valid values -a|a duration (Valid units are: `ns`, `μs`, `ms`, `s`, `m`, `h` and `d`; default unit is `s`) which is minimum `0s` +a|A duration (Valid units are: `ns`, `μs`, `ms`, `s`, `m`, `h` and `d`; default unit is `s`) that is minimum `0s`. |Default value -m|1m +m|+++1m+++ |=== [[config_server.bolt.enabled]] @@ -986,9 +1001,9 @@ m|1m |Description a|Enable the bolt connector. |Valid values -a|a boolean +a|A boolean. |Default value -m|true +m|+++true+++ |=== [[config_server.bolt.listen_address]] @@ -1000,7 +1015,7 @@ m|true |Description a|Address the connector should bind to. |Valid values -a|a socket address in the format 'hostname:port', 'hostname' or ':port'. If missing port or hostname it is acquired from server.default_listen_address +a|A socket address in the format of `hostname:port`, `hostname`, or `:port`. If missing, it is acquired from server.default_listen_address. |Default value m|+++:7687+++ |=== @@ -1014,11 +1029,29 @@ m|+++:7687+++ |Description a|Enable server OCSP stapling for bolt and http connectors. |Valid values -a|a boolean +a|A boolean. |Default value -m|false +m|+++false+++ +|=== + +[[config_server.bolt.telemetry.enabled]] +=== `server.bolt.telemetry.enabled` + +label:introduced[Introduced in 5.4] + +.server.bolt.telemetry.enabled +[frame="topbot", stripes=odd, grid="cols", cols="<1s,<4"] +|=== +|Description +a|Enable the collection of driver telemetry. +|Valid values +a|A boolean. +|Default value +m|+++false+++ |=== +[[config_server.bolt.thread_pool_keep_alive]] + [[config_server.bolt.thread_pool_keep_alive]] === `server.bolt.thread_pool_keep_alive` @@ -1028,7 +1061,7 @@ m|false |Description a|The maximum time an idle thread in the thread pool bound to this connector will wait for new tasks. |Valid values -a|a duration (Valid units are: `ns`, `μs`, `ms`, `s`, `m`, `h` and `d`; default unit is `s`) +a|A duration (Valid units are: `ns`, `μs`, `ms`, `s`, `m`, `h` and `d`; default unit is `s`). |Default value m|+++5m+++ |=== @@ -1042,7 +1075,7 @@ m|+++5m+++ |Description a|The maximum number of threads allowed in the thread pool bound to this connector. |Valid values -a|an integer +a|An integer. |Default value m|+++400+++ |=== @@ -1056,7 +1089,7 @@ m|+++400+++ |Description a|The number of threads to keep in the thread pool bound to this connector, even if they are idle. |Valid values -a|an integer +a|An integer. |Default value m|+++5+++ |=== @@ -1070,7 +1103,7 @@ m|+++5+++ |Description a|Encryption level to require this connector to use. |Valid values -a|one of [REQUIRED, OPTIONAL, DISABLED] +a|One of [REQUIRED, OPTIONAL, DISABLED]. |Default value m|+++DISABLED+++ |=== @@ -1084,7 +1117,7 @@ m|+++DISABLED+++ |Description a|Advertised address for this connector. |Valid values -a|a socket address in the format 'hostname:port', 'hostname' or ':port' which accessible address. If missing port or hostname it is acquired from server.default_advertised_address +a|A socket address in the format of `hostname:port`, `hostname`, or `:port` that is an accessible address. If missing, it is acquired from server.default_advertised_address. |Default value m|+++:7474+++ |=== @@ -1098,9 +1131,9 @@ m|+++:7474+++ |Description a|Enable the http connector. |Valid values -a|a boolean +a|A boolean. |Default value -m|true +m|+++true+++ |=== [[config_server.http.listen_address]] @@ -1112,7 +1145,7 @@ m|true |Description a|Address the connector should bind to. |Valid values -a|a socket address in the format 'hostname:port', 'hostname' or ':port'. If missing port or hostname it is acquired from server.default_listen_address +a|A socket address in the format of `hostname:port`, `hostname`, or `:port`. If missing, it is acquired from server.default_listen_address. |Default value m|+++:7474+++ |=== @@ -1126,7 +1159,7 @@ m|+++:7474+++ |Description a|Defines the set of modules loaded into the Neo4j web server. Options include TRANSACTIONAL_ENDPOINTS, BROWSER, UNMANAGED_EXTENSIONS and ENTERPRISE_MANAGEMENT_ENDPOINTS (if applicable). |Valid values -a|a ',' separated set with elements of type 'one of [TRANSACTIONAL_ENDPOINTS, UNMANAGED_EXTENSIONS, BROWSER, ENTERPRISE_MANAGEMENT_ENDPOINTS]'. +a|A comma-separated set where each element is one of [TRANSACTIONAL_ENDPOINTS, UNMANAGED_EXTENSIONS, BROWSER, ENTERPRISE_MANAGEMENT_ENDPOINTS]. |Default value m|+++TRANSACTIONAL_ENDPOINTS,UNMANAGED_EXTENSIONS,BROWSER,ENTERPRISE_MANAGEMENT_ENDPOINTS+++ |=== @@ -1140,7 +1173,7 @@ m|+++TRANSACTIONAL_ENDPOINTS,UNMANAGED_EXTENSIONS,BROWSER,ENTERPRISE_MANAGEMENT_ |Description a|Advertised address for this connector. |Valid values -a|a socket address in the format 'hostname:port', 'hostname' or ':port' which accessible address. If missing port or hostname it is acquired from server.default_advertised_address +a|A socket address in the format of `hostname:port`, `hostname`, or `:port` that is an accessible address. If missing, it is acquired from server.default_advertised_address. |Default value m|+++:7473+++ |=== @@ -1154,7 +1187,7 @@ m|+++:7473+++ |Description a|Enable the https connector. |Valid values -a|a boolean +a|A boolean. |Default value m|+++false+++ |=== @@ -1168,7 +1201,7 @@ m|+++false+++ |Description a|Address the connector should bind to. |Valid values -a|a socket address in the format 'hostname:port', 'hostname' or ':port'. If missing port or hostname it is acquired from server.default_listen_address +a|A socket address in the format of `hostname:port`, `hostname`, or `:port`. If missing, it is acquired from server.default_listen_address. |Default value m|+++:7473+++ |=== @@ -1182,7 +1215,7 @@ m|+++:7473+++ |Description a|Default hostname or IP address the server uses to advertise itself. |Valid values -a|a socket address in the format 'hostname:port', 'hostname' or ':port' which has no specified port and accessible address +a|A socket address in the format of `hostname:port`, `hostname`, or `:port` that has no specified port and is an accessible address. |Default value m|+++localhost+++ |=== @@ -1196,7 +1229,7 @@ m|+++localhost+++ |Description a|Default network interface to listen for incoming connections. To listen for connections on all interfaces, use "0.0.0.0". |Valid values -a|a socket address in the format 'hostname:port', 'hostname' or ':port' which has no specified port +a|A socket address in the format of `hostname:port`, `hostname`, or `:port` that has no specified port. |Default value m|+++localhost+++ |=== @@ -1212,7 +1245,7 @@ label:enterprise-edition[Enterprise Edition] |Description a|Advertised cluster member discovery management communication. |Valid values -a|a socket address in the format 'hostname:port', 'hostname' or ':port' which accessible address. If missing port or hostname it is acquired from server.default_advertised_address +a|A socket address in the format of `hostname:port`, `hostname`, or `:port` that is an accessible address. If missing, it is acquired from `server.default_advertised_address`. |Default value m|+++:5000+++ |=== @@ -1228,7 +1261,7 @@ label:enterprise-edition[Enterprise Edition] |Description a|The advertised address for the intra-cluster routing connector. |Valid values -a|a socket address in the format 'hostname:port', 'hostname' or ':port' which accessible address. If missing port or hostname it is acquired from server.default_advertised_address +a|A socket address in the format of `hostname:port`, `hostname`, or `:port` that is an accessible address. If missing, it is acquired from `server.default_advertised_address`. |Default value m|+++:7688+++ |=== @@ -1242,7 +1275,7 @@ m|+++:7688+++ |Description a|The address the routing connector should bind to. |Valid values -a|a socket address in the format 'hostname:port', 'hostname' or ':port'. If missing port or hostname it is acquired from server.default_listen_address +a|A socket address in the format of `hostname:port`, `hostname`, or `:port`. If missing, it is acquired from server.default_listen_address. |Default value m|+++:7688+++ |=== @@ -1258,7 +1291,7 @@ label:dynamic[Dynamic] |Description a|Always use client side routing (regardless of the default router) for neo4j:// protocol connections to these domains. A comma separated list of domains. Wildcards (*) are supported. |Valid values -a|a ',' separated set with elements of type 'a string'. +a|A comma-separated set where each element is a string. |Default value m|++++++ |=== @@ -1275,7 +1308,7 @@ Default is `CLIENT`, using client-side routing, with server-side routing as a fa When set to `SERVER`, client-side routing is short-circuited, and requests will rely on server-side routing (which must be enabled for proper operation, i.e. `<>=true`). Can be overridden by `<>`. |Valid values -a|one of [SERVER, CLIENT] +a|One of [SERVER, CLIENT]. |Default value m|+++CLIENT+++ |=== @@ -1291,7 +1324,7 @@ a|Socket connection timeout. A timeout of zero is treated as an infinite timeout and will be bound by the timeout configured on the operating system level. |Valid values -a|a duration (Valid units are: `ns`, `μs`, `ms`, `s`, `m`, `h` and `d`; default unit is `s`) +a|A duration (Valid units are: `ns`, `μs`, `ms`, `s`, `m`, `h` and `d`; default unit is `s`). |Default value m|+++5s+++ |=== @@ -1309,7 +1342,7 @@ It is recommended to set maximum lifetime to a slightly smaller value than the o equipment (load balancer, proxy, firewall, etc. can also limit maximum connection lifetime). Zero and negative values result in lifetime not being checked. |Valid values -a|a duration (Valid units are: `ns`, `μs`, `ms`, `s`, `m`, `h` and `d`; default unit is `s`) +a|A duration (Valid units are: `ns`, `μs`, `ms`, `s`, `m`, `h` and `d`; default unit is `s`). |Default value m|+++1h+++ |=== @@ -1326,7 +1359,7 @@ This timeout only kicks in when all existing connections are being used and no n Error is raised when connection can't be acquired within configured time. Negative values are allowed and result in unlimited acquisition timeout. Value of 0 is allowed and results in no timeout and immediate failure when connection is unavailable. |Valid values -a|a duration (Valid units are: `ns`, `μs`, `ms`, `s`, `m`, `h` and `d`; default unit is `s`) +a|A duration (Valid units are: `ns`, `μs`, `ms`, `s`, `m`, `h` and `d`; default unit is `s`). |Default value m|+++1m+++ |=== @@ -1343,11 +1376,11 @@ If this option is set too low, an additional network call will be incurred when If this is set high, no longer live connections might be used which might lead to errors. Hence, this parameter tunes a balance between the likelihood of experiencing connection problems and performance Normally, this parameter should not need tuning. -Value 0 means connections will always be tested for validity. +Value 0 means connections will always be tested for validity. No connection liveliness check is done by default. |Valid values -a|a duration (Valid units are: `ns`, `μs`, `ms`, `s`, `m`, `h` and `d`; default unit is `s`) +a|A duration (Valid units are: `ns`, `μs`, `ms`, `s`, `m`, `h` and `d`; default unit is `s`). |Default value -m|No connection liveliness check is done by default. +m| |=== [[config_dbms.routing.driver.connection.pool.max_size]] @@ -1360,9 +1393,9 @@ m|No connection liveliness check is done by default. a|Maximum total number of connections to be managed by a connection pool. The limit is enforced for a combination of a host and user. Negative values are allowed and result in unlimited pool. Value of 0is not allowed. |Valid values -a|an integer +a|An integer. |Default value -m|Unlimited +m|+++-1+++ |=== [[config_dbms.routing.driver.logging.level]] @@ -1374,7 +1407,7 @@ m|Unlimited |Description a|Sets level for driver internal logging. |Valid values -a|one of [DEBUG, INFO, WARN, ERROR, NONE] +a|One of [DEBUG, INFO, WARN, ERROR, NONE]. |Default value m|+++INFO+++ |=== @@ -1389,7 +1422,7 @@ m|+++INFO+++ a|Enable server-side routing in clusters using an additional bolt connector. When configured, this allows requests to be forwarded from one cluster member to another, if the requests can't be satisfied by the first member (e.g. write requests received by a non-leader). |Valid values -a|a boolean +a|A boolean. |Default value m|+++true+++ |=== @@ -1405,7 +1438,7 @@ label:enterprise-edition[Enterprise Edition] |Description a|The load balancing plugin to use. |Valid values -a|a string which specified load balancer plugin exist. +a|A string that specified load balancer plugin exist.. |Default value m|+++server_policies+++ |=== @@ -1421,7 +1454,7 @@ label:enterprise-edition[Enterprise Edition] |Description a|Vary the order of the entries in routing tables each time one is produced. This means that different clients should select a range of servers as their first contact, reducing the chance of all clients contacting the same server if alternatives are available. This makes the load across the servers more even. |Valid values -a|a boolean +a|A boolean. |Default value m|+++true+++ |=== @@ -1437,7 +1470,7 @@ label:enterprise-edition[Enterprise Edition] |Description a|Configure if the `dbms.routing.getRoutingTable()` procedure should include non-writer primaries as read endpoints or return only secondaries. Note: if there are no secondaries for the given database primaries are returned as read end points regardless the value of this setting. Defaults to true so that non-writer primaries are available for read-only queries in a typical heterogeneous setup. |Valid values -a|a boolean +a|A boolean. |Default value m|+++true+++ |=== @@ -1453,7 +1486,7 @@ label:enterprise-edition[Enterprise Edition] label:dynamic[Dynamic] |Description a|Configure if the `dbms.routing.getRoutingTable()` procedure should include the writer as read endpoint or return only non-writers (non writer primaries and secondaries) Note: writer is returned as read endpoint if no other member is present all. |Valid values -a|a boolean +a|A boolean. |Default value m|+++false+++ |=== @@ -1467,7 +1500,7 @@ m|+++false+++ |Description a|How long callers should cache the response of the routing procedure `dbms.routing.getRoutingTable()` |Valid values -a|a duration (Valid units are: `ns`, `μs`, `ms`, `s`, `m`, `h` and `d`; default unit is `s`) which is minimum `1s` +a|A duration (Valid units are: `ns`, `μs`, `ms`, `s`, `m`, `h` and `d`; default unit is `s`) that is minimum `1s`. |Default value m|+++5m+++ |=== @@ -1487,7 +1520,7 @@ For more information, see xref:/performance/statistics-execution-plans.adoc[Stat |Description a|This setting is associated with performance optimization. Set this to `true` in situations where it is preferable to have any queries using the 'shortestPath' function terminate as soon as possible with no answer, rather than potentially running for a long time attempting to find an answer (even if there is no path to be found). For most queries, the 'shortestPath' algorithm will return the correct answer very quickly. However there are some cases where it is possible that the fast bidirectional breadth-first search algorithm will find no results even if they exist. This can happen when the predicates in the `WHERE` clause applied to 'shortestPath' cannot be applied to each step of the traversal, and can only be applied to the entire path. When the query planner detects these special cases, it will plan to perform an exhaustive depth-first search if the fast algorithm finds no paths. However, the exhaustive search may be orders of magnitude slower than the fast algorithm. If it is critical that queries terminate as soon as possible, it is recommended that this option be set to `true`, which means that Neo4j will never consider using the exhaustive search for shortestPath queries. However, please note that if no paths are found, an error will be thrown at run time, which will need to be handled by the application. |Valid values -a|a boolean +a|A boolean. |Default value m|+++false+++ |=== @@ -1501,7 +1534,7 @@ m|+++false+++ |Description a|This setting is associated with performance optimization. The shortest path algorithm does not work when the start and end nodes are the same. With this setting set to `false` no path will be returned when that happens. The default value of `true` will instead throw an exception. This can happen if you perform a shortestPath search after a cartesian product that might have the same start and end nodes for some of the rows passed to shortestPath. If it is preferable to not experience this exception, and acceptable for results to be missing for those rows, then set this to `false`. If you cannot accept missing results, and really want the shortestPath between two common nodes, then re-write the query using a standard Cypher variable length pattern expression followed by ordering by path length and limiting to one result. |Valid values -a|a boolean +a|A boolean. |Default value m|+++true+++ |=== @@ -1515,7 +1548,7 @@ m|+++true+++ |Description a|Set this to specify the behavior when Cypher planner or runtime hints cannot be fulfilled. If true, then non-conformance will result in an error, otherwise only a warning is generated. |Valid values -a|a boolean +a|A boolean. |Default value m|+++false+++ |=== @@ -1529,7 +1562,7 @@ m|+++false+++ |Description a|Set this to change the behavior for Cypher create relationship when the start or end node is missing. By default this fails the query and stops execution, but by setting this flag the create operation is simply not performed and execution continues. |Valid values -a|a boolean +a|A boolean. |Default value m|+++false+++ |=== @@ -1543,7 +1576,7 @@ m|+++false+++ |Description a|The minimum time between possible Cypher query replanning events. After this time, the graph statistics will be evaluated, and if they have changed by more than the value set by <>, the query will be replanned. If the statistics have not changed sufficiently, the same interval will need to pass before the statistics will be evaluated again. Each time they are evaluated, the divergence threshold will be reduced slightly until it reaches 10% after 7h, so that even moderately changing databases will see query replanning after a sufficiently long time interval. |Valid values -a|a duration (Valid units are: `ns`, `μs`, `ms`, `s`, `m`, `h` and `d`; default unit is `s`) +a|A duration (Valid units are: `ns`, `μs`, `ms`, `s`, `m`, `h` and `d`; default unit is `s`). |Default value m|+++10s+++ |=== @@ -1557,7 +1590,7 @@ m|+++10s+++ |Description a|Set this to specify the default planner for the default language version. |Valid values -a|one of [DEFAULT, COST] +a|One of [DEFAULT, COST]. |Default value m|+++DEFAULT+++ |=== @@ -1573,9 +1606,9 @@ label:dynamic[Dynamic] |Description a|If set to `true` a textual representation of the plan description will be rendered on the server for all queries running with `EXPLAIN` or `PROFILE`. This allows clients such as the neo4j browser and Cypher shell to show a more detailed plan description. |Valid values -a|a boolean +a|A boolean. |Default value -m|+++false+++ +m|+++true+++ |=== [[config_dbms.cypher.statistics_divergence_threshold]] @@ -1593,7 +1626,7 @@ This means that a value of `0.75` requires the database to quadruple in size bef This interval is defined by `<>` and defaults to 10s. After this interval, the divergence threshold will slowly start to decline, reaching 10% after about 7h. This will ensure that long running databases will still get query replanning on even modest changes, while not replanning frequently unless the changes are very large. |Valid values -a|a double which is in the range `0.0` to `1.0` +a|A double that is in the range `0.0` to `1.0`. |Default value m|+++0.75+++ |=== @@ -1617,10 +1650,10 @@ If set to a negative number, the total number of logical processors available on For example, if the server has 16 available processors and you set `server.cypher.parallel.worker_limit` to `-1`, the parallel runtime will have 15 threads available. |Valid values -a| Integer +a| An integer. |Default value -m| 0 +m|+++0+++ |=== == Database settings @@ -1637,7 +1670,7 @@ They can be varied between each database but must be consistent across all confi |Description a|Allows the enabling or disabling of the file watcher service. This is an auxiliary service but should be left enabled in almost all cases. |Valid values -a|a boolean +a|A boolean. |Default value m|+++true+++ |=== @@ -1653,7 +1686,7 @@ label:dynamic[Dynamic] |Description a|Database format. This is the format that will be used for new databases. Valid values are `standard`, `aligned`, or `high_limit`.The `aligned` format is essentially the `standard` format with some minimal padding at the end of pages such that a single record will never cross a page boundary. The `high_limit` format is available for Enterprise Edition only. It is required if you have a graph that is larger than 34 billion nodes, 34 billion relationships, or 68 billion properties. |Valid values -a|a string +a|A string. |Default value m|+++aligned+++ |=== @@ -1667,7 +1700,7 @@ m|+++aligned+++ |Description a|Relationship count threshold for considering a node to be dense. |Valid values -a|an integer which is minimum `1` +a|An integer that is minimum `1`. |Default value m|+++50+++ |=== @@ -1681,7 +1714,7 @@ m|+++50+++ |Description a|Specify if Neo4j should try to preallocate store files as they grow. |Valid values -a|a boolean +a|A boolean. |Default value m|+++true+++ |=== @@ -1695,7 +1728,7 @@ m|+++true+++ |Description a|Database timezone for temporal functions. All Time and DateTime values that are created without an explicit timezone will use this configured default timezone. |Valid values -a|a string describing a timezone, either described by offset (e.g. `+02:00`) or by name (e.g. `Europe/Stockholm`) +a|A string describing a timezone, either described by offset (e.g. `+02:00`) or by name (e.g. `Europe/Stockholm`). |Default value m|+++Z+++ |=== @@ -1712,7 +1745,7 @@ label:enterprise-edition[Enterprise Edition] label:dynamic[Dynamic] a|Enables or disables tracking of how much time a query spends actively executing on the CPU. Calling `SHOW TRANSACTIONS` will display the time, but not in the _query.log_. + If you want the CPU time to be logged in the _query.log_, set `db.track_query_cpu_time=true`. |Valid values -a|a boolean +a|A boolean. |Default value m|+++false+++ |=== @@ -1741,7 +1774,7 @@ Once it is created, the setting is not valid anymore. To set the default database, use the xref:/clustering/databases.adoc#cluster-default-database[`dbms.setDefaultDatabase()`] procedure instead. ==== |Valid values -a|A valid database name containing only alphabetic characters, numbers, dots and dashes with a length between 3 and 63 characters, starting with an alphabetic character but not with the name 'system' +a|A valid database name containing only alphabetic characters, numbers, dots, and dashes with a length between 3 and 63 characters, starting with an alphabetic character but not with the name system. |Default value m|+++neo4j+++ |=== @@ -1755,7 +1788,7 @@ m|+++neo4j+++ |Description a|Database timezone. Among other things, this setting influences the monitoring procedures. |Valid values -a|one of [UTC, SYSTEM] +a|One of [UTC, SYSTEM]. |Default value m|+++UTC+++ |=== @@ -1778,7 +1811,7 @@ If a seed source (URI scheme) is supported by multiple providers in the list, th If the list is set to empty, the seed from URI functionality is effectively disabled. See xref:/clustering/databases.adoc#cluster-seed-uri[Seed from URI] for more information. |Valid values -a|a `,` separated list with elements of type `a string`. +a|A comma-separated list where each element is a string. |Default value m|+++S3SeedProvider+++ |=== @@ -1794,7 +1827,7 @@ label:enterprise-edition[Enterprise Edition] |Description a|The maximum number of databases. |Valid values -a|a long which is minimum `2` +a|A long that is minimum `2`. |Default value m|+++100+++ |=== @@ -1813,7 +1846,7 @@ The import settings control the size of the internal buffer used by `LOAD CSV` a |Description a|The size of the internal buffer in bytes used by `LOAD CSV`. If the csv file contains huge fields this value may have to be increased. |Valid values -a|a long which is minimum `1` +a|A long that is minimum `1`. |Default value m|+++2097152+++ |=== @@ -1827,7 +1860,7 @@ m|+++2097152+++ |Description a|Selects whether to conform to the standard https://tools.ietf.org/html/rfc4180 for interpreting escaped quotation characters in CSV files loaded using `LOAD CSV`. Setting this to `false` will use the standard, interpreting repeated quotes '""' as a single in-lined quote, while `true` will use the legacy convention originally supported in Neo4j 3.0 and 3.1, allowing a backslash to include quotes in-lined in fields. |Valid values -a|a boolean +a|A boolean. |Default value m|+++true+++ |=== @@ -1846,7 +1879,7 @@ For more information, see xref:/performance/index-configuration.adoc[Index confi |Description a|The name of the analyzer that the full-text indexes should use by default. |Valid values -a|a string +a|A string. |Default value m|+++standard-no-stop-words+++ |=== @@ -1860,7 +1893,7 @@ m|+++standard-no-stop-words+++ |Description a|Whether or not full-text indexes should be eventually consistent by default or not. |Valid values -a|a boolean +a|A boolean. |Default value m|+++false+++ |=== @@ -1874,7 +1907,7 @@ m|+++false+++ |Description a|The _eventually consistent_ mode of the full-text indexes works by queueing up index updates to be applied later in a background thread. This newBuilder sets an upper bound on how many index updates are allowed to be in this queue at any one point in time. When it is reached, the commit process will slow down and wait for the index update applier thread to make some more room in the queue. |Valid values -a|an integer which is in the range `1` to `50000000` +a|An integer that is in the range `1` to `50000000`. |Default value m|+++10000+++ |=== @@ -1888,7 +1921,7 @@ m|+++10000+++ |Description a|Enable or disable background index sampling. |Valid values -a|a boolean +a|A boolean. |Default value m|+++true+++ |=== @@ -1902,7 +1935,7 @@ m|+++true+++ |Description a|Index sampling chunk size limit. |Valid values -a|an integer which is in the range `1048576` to `2147483647` +a|An integer that is in the range `1048576` to `2147483647`. |Default value m|+++8388608+++ |=== @@ -1916,7 +1949,7 @@ m|+++8388608+++ |Description a|Percentage of index updates of total index size required before sampling of a given index is triggered. |Valid values -a|an integer which is minimum `0` +a|An integer that is minimum `0`. |Default value m|+++5+++ |=== @@ -1938,7 +1971,7 @@ label:new[Introduced in 5.8] label:dynamic[Dynamic] label:deprecated[Deprecated a|Log the annotation data as JSON strings instead of a Cypher map. This configuration has an effect only when the query log is in JSON format. From 5.9, if `true`, it collapses the nested JSON objects in the query logger. |Valid values -a|a boolean +a|A boolean. |Default value m|+++false+++ |Replaced by @@ -1962,7 +1995,7 @@ a|The format to use for the JSON annotation data. This only have effect when the query log is in JSON format. |Valid values -a|one of [CYPHER,JSON,FLAT_JSON] +a|One of [CYPHER, JSON, FLAT_JSON]. |Default value m|+++CYPHER+++ |=== @@ -1978,7 +2011,7 @@ label:dynamic[Dynamic] |Description a|Log query text and parameters without obfuscating passwords. This allows queries to be logged earlier before parsing starts. |Valid values -a|a boolean +a|A boolean. |Default value m|+++false+++ |=== @@ -2002,7 +2035,7 @@ Log entries are written to the query log. This feature is available in the Neo4j Enterprise Edition. |Valid values -a|one of [OFF, INFO, VERBOSE] +a|One of [OFF, INFO, VERBOSE]. |Default value m|+++VERBOSE+++ |=== @@ -2018,7 +2051,7 @@ label:dynamic[Dynamic] |Description a|Sets a maximum character length use for each parameter in the log. This only takes effect if `<> = true`. |Valid values -a|an integer +a|An integer. |Default value m|+++2147483647+++ |=== @@ -2034,7 +2067,7 @@ label:dynamic[Dynamic] |Description a|Obfuscates all literals of the query before writing to the log. Note that node labels, relationship types and map property keys are still shown. Changing the setting will not affect queries that are cached. So, if you want the switch to have an immediate effect, you must also call `CALL db.clearQueryCaches()`. |Valid values -a|a boolean +a|A boolean. |Default value m|+++false+++ |=== @@ -2050,7 +2083,7 @@ label:dynamic[Dynamic] |Description a|Log parameters for the executed queries being logged. |Valid values -a|a boolean +a|A boolean. |Default value m|+++true+++ |=== @@ -2066,7 +2099,7 @@ label:dynamic[Dynamic] |Description a|Log query plan description table, useful for debugging purposes. |Valid values -a|a boolean +a|A boolean. |Default value m|false |=== @@ -2082,7 +2115,7 @@ label:dynamic[Dynamic] |Description a|If the execution of a query takes more time than this threshold, the query is logged once completed - provided query logging is set to INFO. Defaults to 0 seconds, that is all queries are logged. |Valid values -a|a duration (Valid units are: `ns`, `μs`, `ms`, `s`, `m`, `h` and `d`; default unit is `s`) +a|A duration (Valid units are: `ns`, `μs`, `ms`, `s`, `m`, `h` and `d`; default unit is `s`). |Default value m|+++0s+++ |=== @@ -2102,7 +2135,7 @@ INFO: log the start and end of transactions that take longer than the configured VERBOSE: log the start and end of all transactions. Log entries are written to the query log. |Valid values -a|one of [OFF, INFO, VERBOSE] +a|One of [OFF, INFO, VERBOSE]. |Default value m|+++OFF+++ |=== @@ -2118,7 +2151,7 @@ label:dynamic[Dynamic] |Description a|If the transaction is open for more time than this threshold, the transaction is logged once completed - provided transaction logging (<>) is set to `INFO`. Defaults to 0 seconds (all transactions are logged). |Valid values -a|a duration (Valid units are: `ns`, `μs`, `ms`, `s`, `m`, `h` and `d`; default unit is `s`) +a|A duration (Valid units are: `ns`, `μs`, `ms`, `s`, `m`, `h` and `d`; default unit is `s`). |Default value m|+++0s+++ |=== @@ -2132,7 +2165,7 @@ m|+++0s+++ |Description a|Enable HTTP request logging. |Valid values -a|a boolean +a|A boolean. |Default value m|+++false+++ |=== @@ -2146,7 +2179,7 @@ m|+++false+++ |Description a|Path to the logging configuration for debug, query, http and security logs. |Valid values -a|a path. If relative it is resolved from server.directories.neo4j_home +a|A path. If relative, it is resolved from server.directories.neo4j_home. |Default value m|+++conf/server-logs.xml+++ |=== @@ -2160,7 +2193,7 @@ m|+++conf/server-logs.xml+++ |Description a|Enable the debug log. |Valid values -a|a boolean +a|A boolean. |Default value m|+++true+++ |=== @@ -2174,7 +2207,7 @@ m|+++true+++ |Description a|Enable GC Logging. |Valid values -a|a boolean +a|A boolean. |Default value m|+++false+++ |=== @@ -2188,7 +2221,7 @@ m|+++false+++ |Description a|GC Logging Options. |Valid values -a|a string +a|A string. |Default value m|+++-Xlog:gc*,safepoint,age*=trace+++ |=== @@ -2202,7 +2235,7 @@ m|+++-Xlog:gc*,safepoint,age*=trace+++ |Description a|Number of GC logs to keep. |Valid values -a|an integer +a|An integer. |Default value m|+++5+++ |=== @@ -2216,7 +2249,7 @@ m|+++5+++ |Description a|Size of each GC log that is kept. |Valid values -a|a byte size (valid multipliers are `B`, `KiB`, `KB`, `K`, `kB`, `kb`, `k`, `MiB`, `MB`, `M`, `mB`, `mb`, `m`, `GiB`, `GB`, `G`, `gB`, `gb`, `g`, `TiB`, `TB`, `PiB`, `PB`, `EiB`, `EB`) +a|A byte size (valid multipliers are `B`, `KiB`, `KB`, `K`, `kB`, `kb`, `k`, `MiB`, `MB`, `M`, `mB`, `mb`, `m`, `GiB`, `GB`, `G`, `gB`, `gb`, `g`, `TiB`, `TB`, `PiB`, `PB`, `EiB`, `EB`). |Default value m|+++20.00MiB+++ |=== @@ -2230,7 +2263,7 @@ m|+++20.00MiB+++ |Description a|Path to the logging configuration of user logs. |Valid values -a|a path. If relative it is resolved from `server.directories.neo4j_home` +a|A path. If relative, it is resolved from `server.directories.neo4j_home`. |Default value m|+++conf/user-logs.xml+++ |=== @@ -2251,7 +2284,7 @@ For more information on how to tune these settings, see xref:/performance/memory a|Page cache can be configured to perform usage sampling of loaded pages that can be used to construct active load profile. According to that profile pages can be reloaded on the restart, replication, etc. This setting allows disabling that behavior. This feature is available in Neo4j Enterprise Edition. |Valid values -a|a boolean +a|A boolean. |Default value m|+++true+++ |=== @@ -2265,7 +2298,7 @@ m|+++true+++ |Description a|Page cache warmup can be configured to prefetch files, preferably when cache size is bigger than store size. Files to be prefetched can be filtered by 'dbms.memory.pagecache.warmup.preload.allowlist'. Enabling this disables warmup by profile. |Valid values -a|a boolean +a|A boolean. |Default value m|+++false+++ |=== @@ -2279,9 +2312,9 @@ m|+++false+++ |Description a|Page cache warmup prefetch file allowlist regex. By default matches all files. |Valid values -a|a string +a|A string. |Default value -m|+++.*+++ +m|.* |=== [[config_db.memory.pagecache.warmup.profile.interval]] @@ -2295,7 +2328,7 @@ label:enterprise-edition[Enterprise Edition] |Description a|The profiling frequency for the page cache. Accurate profiles allow the page cache to do an active warmup after a restart, reducing the mean time to performance. |Valid values -a|a duration (Valid units are: `ns`, `μs`, `ms`, `s`, `m`, `h` and `d`; default unit is `s`) +a|A duration (Valid units are: `ns`, `μs`, `ms`, `s`, `m`, `h` and `d`; default unit is `s`). |Default value m|+++1m+++ |=== @@ -2311,7 +2344,7 @@ label:dynamic[Dynamic] |Description a|Limit the amount of memory that a single transaction can consume, in bytes (or kilobytes with the 'k' suffix, megabytes with 'm', and gigabytes with 'g'). Zero means 'largest possible value'. |Valid values -a|a byte size (valid multipliers are `B`, `KiB`, `KB`, `K`, `kB`, `kb`, `k`, `MiB`, `MB`, `M`, `mB`, `mb`, `m`, `GiB`, `GB`, `G`, `gB`, `gb`, `g`, `TiB`, `TB`, `PiB`, `PB`, `EiB`, `EB`) which is minimum `1.00MiB` or is `0B` +a|A byte size (valid multipliers are `B`, `KiB`, `KB`, `K`, `kB`, `kb`, `k`, `MiB`, `MB`, `M`, `mB`, `mb`, `m`, `GiB`, `GB`, `G`, `gB`, `gb`, `g`, `TiB`, `TB`, `PiB`, `PB`, `EiB`, `EB`) that is minimum `1.00MiB` or is `0B`. |Default value m|+++0B+++ |=== @@ -2327,7 +2360,7 @@ label:dynamic[Dynamic] |Description a|Limit the amount of memory that all transactions in one database can consume, in bytes (or kilobytes with the 'k' suffix, megabytes with 'm' and gigabytes with 'g'). Zero means 'unlimited'. |Valid values -a|a byte size (valid multipliers are `B`, `KiB`, `KB`, `K`, `kB`, `kb`, `k`, `MiB`, `MB`, `M`, `mB`, `mb`, `m`, `GiB`, `GB`, `G`, `gB`, `gb`, `g`, `TiB`, `TB`, `PiB`, `PB`, `EiB`, `EB`) which is minimum `10.00MiB` or is `0B` +a|A byte size (valid multipliers are `B`, `KiB`, `KB`, `K`, `kB`, `kb`, `k`, `MiB`, `MB`, `M`, `mB`, `mb`, `m`, `GiB`, `GB`, `G`, `gB`, `gb`, `g`, `TiB`, `TB`, `PiB`, `PB`, `EiB`, `EB`) that is minimum `10.00MiB` or is `0B`. |Default value m|+++0B+++ |=== @@ -2335,13 +2368,15 @@ m|+++0B+++ [[config_db.tx_state.memory_allocation]] === `db.tx_state.memory_allocation` +label:deprecated[Deprecated in 5.8] + .db.tx_state.memory_allocation [frame="topbot", stripes=odd, grid="cols", cols="<1s,<4"] |=== |Description a|Defines whether memory for transaction state should be allocated on- or off-heap. Note that for small transactions you can gain up to 25% write speed by setting it to `ON_HEAP`. |Valid values -a|one of [ON_HEAP, OFF_HEAP] +a|One of [ON_HEAP, OFF_HEAP]. |Default value m|+++ON_HEAP+++ |=== @@ -2357,7 +2392,7 @@ label:deprecated[Deprecated in 5.7] |Description a|The number of cached Cypher query execution plans per database. The max number of query plans that can be kept in cache is the `number of databases` * ``server.db.query_cache_size``. With 10 databases and ``server.db.query_cache_size``=1000, the caches can keep 10000 plans in total on the instance, assuming that each DB receives queries that fill up its cache. |Valid values -a|an integer which is minimum `0` +a|An integer that is minimum `0`. |Default value m|+++1000+++ |Replaced by @@ -2373,7 +2408,7 @@ a|<> * `server.memory.off_heap.block_cache_size` |Valid values -a|an integer which is minimum `16` +a|An integer that is minimum `16`. |Default value m|+++128+++ |=== @@ -2445,7 +2480,7 @@ m|+++128+++ |Description a|Defines the maximum size of an off-heap memory block that can be cached to speed up allocations. The value must be a power of 2. |Valid values -a|a byte size (valid multipliers are `B`, `KiB`, `KB`, `K`, `kB`, `kb`, `k`, `MiB`, `MB`, `M`, `mB`, `mb`, `m`, `GiB`, `GB`, `G`, `gB`, `gb`, `g`, `TiB`, `TB`, `PiB`, `PB`, `EiB`, `EB`) which is minimum `4.00KiB` and is power of 2 +a|A byte size (valid multipliers are `B`, `KiB`, `KB`, `K`, `kB`, `kb`, `k`, `MiB`, `MB`, `M`, `mB`, `mb`, `m`, `GiB`, `GB`, `G`, `gB`, `gb`, `g`, `TiB`, `TB`, `PiB`, `PB`, `EiB`, `EB`) that is minimum `4.00KiB` and is power of 2. |Default value m|+++512.00KiB+++ |=== @@ -2453,13 +2488,15 @@ m|+++512.00KiB+++ [[config_server.memory.off_heap.transaction_max_size]] === `server.memory.off_heap.transaction_max_size` +label:deprecated[Deprecated in 5.8] + .server.memory.off_heap.transaction_max_size [frame="topbot", stripes=odd, grid="cols", cols="<1s,<4"] |=== |Description a|The maximum amount of off-heap memory that can be used to store transaction state data; it's a total amount of memory shared across all active transactions. Zero means 'unlimited'. Used when <> is set to 'OFF_HEAP'. |Valid values -a|a byte size (valid multipliers are `B`, `KiB`, `KB`, `K`, `kB`, `kb`, `k`, `MiB`, `MB`, `M`, `mB`, `mb`, `m`, `GiB`, `GB`, `G`, `gB`, `gb`, `g`, `TiB`, `TB`, `PiB`, `PB`, `EiB`, `EB`) which is minimum `0B` +a|A byte size (valid multipliers are `B`, `KiB`, `KB`, `K`, `kB`, `kb`, `k`, `MiB`, `MB`, `M`, `mB`, `mb`, `m`, `GiB`, `GB`, `G`, `gB`, `gb`, `g`, `TiB`, `TB`, `PiB`, `PB`, `EiB`, `EB`) that is minimum `0B`. |Default value m|+++2.00GiB+++ |=== @@ -2473,7 +2510,7 @@ m|+++2.00GiB+++ |Description a|Use direct I/O for page cache. This setting is supported only on Linux and only for a subset of record formats that use platform-aligned page size. |Valid values -a|a boolean +a|A boolean. |Default value m|+++false+++ |=== @@ -2489,7 +2526,7 @@ label:dynamic[Dynamic] |Description a|Page cache can be configured to use a temporal buffer for flushing purposes. It is used to combine, if possible, sequence of several cache pages into one bigger buffer to minimize the number of individual IOPS performed and better utilization of available I/O resources, especially when those are restricted. |Valid values -a|a boolean +a|A boolean. |Default value m|+++false+++ |=== @@ -2505,7 +2542,7 @@ label:dynamic[Dynamic] |Description a|Page cache can be configured to use a temporal buffer for flushing purposes. It is used to combine, if possible, sequence of several cache pages into one bigger buffer to minimize the number of individual IOPS performed and better utilization of available I/O resources, especially when those are restricted. Use this setting to configure individual file flush the buffer size in pages (8KiB). To be able to utilize this buffer during page cache flushing, buffered flush should be enabled. |Valid values -a|an integer which is in the range `1` to `512` +a|An integer that is in the range `1` to `512`. |Default value m|+++128+++ |=== @@ -2519,7 +2556,7 @@ m|+++128+++ |Description a|The maximum number of worker threads to use for pre-fetching data when doing sequential scans. Set to '0' to disable pre-fetching for scans. |Valid values -a|an integer which is in the range `0` to `255` +a|An integer that is in the range `0` to `255`. |Default value m|+++4+++ |=== @@ -2531,11 +2568,11 @@ m|+++4+++ [frame="topbot", stripes=odd, grid="cols", cols="<1s,<4"] |=== |Description -a|The amount of memory to use for mapping the store files. If Neo4j is running on a dedicated server, then it is generally recommended to leave about 2-4 gigabytes for the operating system, give the JVM enough heap to hold all your transaction state and query context, and then leave the rest for the page cache. If no page cache memory is configured, then a heuristic setting is computed based on available system resources. +a|The amount of memory to use for mapping the store files. If Neo4j is running on a dedicated server, then it is generally recommended to leave about 2-4 gigabytes for the operating system, give the JVM enough heap to hold all your transaction state and query context, and then leave the rest for the page cache. If no page cache memory is configured, then a heuristic setting is computed based on available system resources. By default the size of page cache will be 50% och available RAM minus the max heap size.The size of the page cache will also not be larger than 70x the max heap size (due to some overhead of the page cache in the heap. |Valid values -a|a byte size (valid multipliers are `B`, `KiB`, `KB`, `K`, `kB`, `kb`, `k`, `MiB`, `MB`, `M`, `mB`, `mb`, `m`, `GiB`, `GB`, `G`, `gB`, `gb`, `g`, `TiB`, `TB`, `PiB`, `PB`, `EiB`, `EB`) +a|A byte size (valid multipliers are `B`, `KiB`, `KB`, `K`, `kB`, `kb`, `k`, `MiB`, `MB`, `M`, `mB`, `mb`, `m`, `GiB`, `GB`, `G`, `gB`, `gb`, `g`, `TiB`, `TB`, `PiB`, `PB`, `EiB`, `EB`). |Default value -m|By default the size of page cache will be 50% och available RAM minus the max heap size.The size of the page cache will also not be larger than 70x the max heap size (due to some overhead of the page cache in the heap. +m| |=== [[config_server.memory.query_cache.sharing_enabled]] @@ -2556,7 +2593,7 @@ In essence, databases may compete for cache space, but may not observe each othe When this option is turned on, the cache space available to all databases is configured with `server.memory.query_cache.shared_cache_num_entries`. With this option turned off, the cache space available to each individual database is configured with `server.memory.query_cache.per_db_cache_num_entries`. |Valid values -a|a boolean +a|A boolean. |Default value m|+++false+++ |=== @@ -2574,7 +2611,7 @@ a|The number of cached queries for all databases. The maximum number of queries that can be kept in a cache is exactly `server.memory.query_cache.shared_cache_num_entries`. This setting is only deciding cache size when `server.memory.query_cache.sharing_enabled` is set to `true`. |Valid values -a|a integer +a|An integer that is minimum `0`. |Default value m|+++1000+++ |=== @@ -2594,7 +2631,7 @@ The maximum number of queries that can be kept in a cache is `number of database With 10 databases and `server.memory.query_cache.per_db_cache_num_entries`=1000, the cache can keep 10000 plans in total. This setting is only deciding cache size when `server.memory.query_cache.sharing_enabled` is set to `false`. |Valid values -a|a integer +a|An integer that is minimum `0`. |Default value m|+++1000+++ |=== @@ -2616,7 +2653,7 @@ label:enterprise-edition[Enterprise Edition] |Description a|Set to `true` to enable exporting metrics to CSV files. |Valid values -a|a boolean +a|A boolean. |Default value m|+++true+++ |=== @@ -2632,7 +2669,7 @@ label:enterprise-edition[Enterprise Edition] |Description a|The reporting interval for the CSV files. That is, how often new rows with numbers are appended to the CSV files. |Valid values -a|a duration (Valid units are: `ns`, `μs`, `ms`, `s`, `m`, `h` and `d`; default unit is `s`) which is minimum `1ms` +a|A duration (Valid units are: `ns`, `μs`, `ms`, `s`, `m`, `h` and `d`; default unit is `s`) that is minimum `1ms`. |Default value m|+++30s+++ |=== @@ -2648,7 +2685,7 @@ label:enterprise-edition[Enterprise Edition] |Description a|Decides what compression to use for the csv history files. |Valid values -a|one of [NONE, ZIP, GZ] +a|One of [NONE, ZIP, GZ]. |Default value m|+++NONE+++ |=== @@ -2664,7 +2701,7 @@ label:enterprise-edition[Enterprise Edition] |Description a|Maximum number of history files for the csv files. |Valid values -a|an integer which is minimum `1` +a|An integer that is minimum `1`. |Default value m|+++7+++ |=== @@ -2680,7 +2717,7 @@ label:enterprise-edition[Enterprise Edition] |Description a|The file size in bytes at which the csv files will auto-rotate. If set to zero then no rotation will occur. Accepts a binary suffix `k`, `m` or `g`. |Valid values -a|a byte size (valid multipliers are `B`, `KiB`, `KB`, `K`, `kB`, `kb`, `k`, `MiB`, `MB`, `M`, `mB`, `mb`, `m`, `GiB`, `GB`, `G`, `gB`, `gb`, `g`, `TiB`, `TB`, `PiB`, `PB`, `EiB`, `EB`) which is in the range `0B` to `8388608.00TiB` +a|A byte size (valid multipliers are `B`, `KiB`, `KB`, `K`, `kB`, `kb`, `k`, `MiB`, `MB`, `M`, `mB`, `mb`, `m`, `GiB`, `GB`, `G`, `gB`, `gb`, `g`, `TiB`, `TB`, `PiB`, `PB`, `EiB`, `EB`) that is in the range `0B` to `8388608.00TiB`. |Default value m|+++10.00MiB+++ |=== @@ -2696,7 +2733,7 @@ label:enterprise-edition[Enterprise Edition] |Description a|Enable metrics. Setting this to `false` will to turn off all metrics. |Valid values -a|a boolean +a|A boolean. |Default value m|+++true+++ |=== @@ -2712,9 +2749,9 @@ label:enterprise-edition[Enterprise Edition] |Description a|Specifies which metrics should be enabled by using a comma separated list of globbing patterns. Only the metrics matching the filter will be enabled. For example `\*check_point*,neo4j.page_cache.evictions` will enable any checkpoint metrics and the pagecache eviction metric. |Valid values -a|a ',' separated list with elements of type 'A simple globbing pattern that can use `*` and `?`.'. +a|A comma-separated list where each element is A simple globbing pattern that can use `*` and `?`.. |Default value -m|+++*bolt.connections*,*bolt.messages_received*,*bolt.messages_started*,*dbms.pool.bolt.free,*dbms.pool.bolt.total_size,*dbms.pool.bolt.total_used,*dbms.pool.bolt.used_heap,*cluster.core.is_leader,*cluster.core.last_leader_message,*cluster.core.replication_attempt,*cluster.core.replication_fail,*cluster.core.last_applied,*cluster.core.last_appended,*check_point.duration,*check_point.total_time,*cypher.replan_events,*ids_in_use*,*pool.transaction.*.total_used,*pool.transaction.*.used_heap,*pool.transaction.*.used_native,*store.size*,*transaction.active_read,*transaction.active_write,*transaction.committed*,*transaction.last_committed_tx_id,*transaction.peak_concurrent,*transaction.rollbacks*,*page_cache.hit*,*page_cache.page_faults,*page_cache.usage_ratio,*vm.file.descriptors.count,*vm.gc.time.*,*vm.heap.used,*vm.memory.buffer.direct.used,*vm.memory.pool.g1_eden_space,*vm.memory.pool.g1_old_gen,*vm.pause_time,*vm.thread*,*db.query.execution*+++ +m|`*bolt.connections*,*bolt.messages_received*,*bolt.messages_started*,*dbms.pool.bolt.free,*dbms.pool.bolt.total_size,*dbms.pool.bolt.total_used,*dbms.pool.bolt.used_heap,*cluster.raft.is_leader,*cluster.raft.last_leader_message,*cluster.raft.replication_attempt,*cluster.raft.replication_fail,*cluster.raft.last_applied,*cluster.raft.last_appended,*cluster.raft.append_index,*cluster.raft.commit_index,*cluster.raft.applied_index,*check_point.*,*cypher.replan_events,*ids_in_use*,*pool.transaction.*.total_used,*pool.transaction.*.used_heap,*pool.transaction.*.used_native,*store.size*,*transaction.active_read,*transaction.active_write,*transaction.committed*,*transaction.last_committed_tx_id,*transaction.peak_concurrent,*transaction.rollbacks*,*page_cache.hit*,*page_cache.page_faults,*page_cache.usage_ratio,*vm.file.descriptors.count,*vm.gc.time.*,*vm.heap.used,*vm.memory.buffer.direct.used,*vm.memory.pool.g1_eden_space,*vm.memory.pool.g1_old_gen,*vm.pause_time,*vm.thread*,*db.query.execution*` |=== [[config_server.metrics.graphite.enabled]] @@ -2728,7 +2765,7 @@ label:enterprise-edition[Enterprise Edition] |Description a|Set to `true` to enable exporting metrics to Graphite. |Valid values -a|a boolean +a|A boolean. |Default value m|+++false+++ |=== @@ -2744,7 +2781,7 @@ label:enterprise-edition[Enterprise Edition] |Description a|The reporting interval for Graphite. That is, how often to send updated metrics to Graphite. |Valid values -a|a duration (Valid units are: `ns`, `μs`, `ms`, `s`, `m`, `h` and `d`; default unit is `s`) +a|A duration (Valid units are: `ns`, `μs`, `ms`, `s`, `m`, `h` and `d`; default unit is `s`). |Default value m|+++30s+++ |=== @@ -2760,7 +2797,7 @@ label:enterprise-edition[Enterprise Edition] |Description a|The hostname or IP address of the Graphite server. |Valid values -a|a socket address in the format 'hostname:port', 'hostname' or ':port'. If missing port or hostname it is acquired from server.default_listen_address +a|A socket address in the format of `hostname:port`, `hostname`, or `:port`. If missing, it is acquired from server.default_listen_address. |Default value m|+++:2003+++ |=== @@ -2776,7 +2813,7 @@ label:enterprise-edition[Enterprise Edition] |Description a|Set to `true` to enable the JMX metrics endpoint. |Valid values -a|a boolean +a|A boolean. |Default value m|+++true+++ |=== @@ -2792,7 +2829,7 @@ label:enterprise-edition[Enterprise Edition] |Description a|A common prefix for the reported metrics field names. |Valid values -a|a string +a|A string. |Default value m|+++neo4j+++ |=== @@ -2808,7 +2845,7 @@ label:enterprise-edition[Enterprise Edition] |Description a|Set to `true` to enable the Prometheus endpoint. |Valid values -a|a boolean +a|A boolean. |Default value m|+++false+++ |=== @@ -2824,7 +2861,7 @@ label:enterprise-edition[Enterprise Edition] |Description a|The hostname and port to use as Prometheus endpoint. |Valid values -a|a socket address in the format `hostname:port`, `hostname`, or `:port`. If missing, port and hostname are acquired from `server.default_listen_address`. +a|A socket address in the format of `hostname:port`, `hostname`, or `:port`. If missing, it is acquired from `server.default_listen_address`. |Default value m|+++localhost:2004+++ |=== @@ -2844,7 +2881,7 @@ label:enterprise-edition[Enterprise Edition] |Description a|Configure the policy for outgoing Neo4j Browser connections. |Valid values -a|a boolean +a|A boolean. |Default value m|+++true+++ |=== @@ -2860,7 +2897,7 @@ label:enterprise-edition[Enterprise Edition] |Description a|Configure the Neo4j Browser to time out logged in users after this idle period. Setting this to 0 indicates no limit. |Valid values -a|a duration (Valid units are: `ns`, `μs`, `ms`, `s`, `m`, `h` and `d`; default unit is `s`) +a|A duration (Valid units are: ns, μs, ms, s, m, h and d; default unit is s). |Default value m|+++0s+++ |=== @@ -2874,7 +2911,7 @@ m|+++0s+++ |Description a|Commands to be run when Neo4j Browser successfully connects to this server. Separate multiple commands with semi-colon. |Valid values -a|a string +a|A string. |Default value m|++++++ |=== @@ -2888,7 +2925,7 @@ m|++++++ |Description a|Whitelist of hosts for the Neo4j Browser to be allowed to fetch content from. |Valid values -a|a string +a|A string. |Default value m|+++guides.neo4j.com,localhost+++ |=== @@ -2904,7 +2941,7 @@ label:enterprise-edition[Enterprise Edition] |Description a|Configure the Neo4j Browser to store or not store user credentials. |Valid values -a|a boolean +a|A boolean. |Default value m|+++true+++ |=== @@ -2920,7 +2957,7 @@ label:enterprise-edition[Enterprise Edition] |Description a|Configure the Neo4j Browser to store or not store user editor history. |Valid values -a|a boolean +a|A boolean. |Default value m|+++true+++ |=== @@ -2934,7 +2971,7 @@ m|+++true+++ |Description a|Configure client applications such as Browser and Bloom to send Product Analytics data. |Valid values -a|a boolean +a|A boolean. |Default value m|+++true+++ |=== @@ -2957,7 +2994,7 @@ label:enterprise-edition[Enterprise Edition] |Description a|Address for Kubernetes API. |Valid values -a|a socket address in the format `hostname:port`, `hostname` or `:port` +a|A socket address in the format of `hostname:port`, `hostname`, or `:port`. |Default value m|+++kubernetes.default.svc:443+++ |=== @@ -2973,7 +3010,7 @@ label:enterprise-edition[Enterprise Edition] |Description a|File location of CA certificate for Kubernetes API. |Valid values -a|a path +a|A path. |Default value m|+++/var/run/secrets/kubernetes.io/serviceaccount/ca.crt+++ |=== @@ -2989,7 +3026,7 @@ label:enterprise-edition[Enterprise Edition] |Description a|Kubernetes cluster domain. |Valid values -a|a string +a|A string. |Default value m|+++cluster.local+++ |=== @@ -3005,7 +3042,7 @@ label:enterprise-edition[Enterprise Edition] |Description a|LabelSelector for Kubernetes API. |Valid values -a|a string +a|A string. |Default value m| |=== @@ -3021,7 +3058,7 @@ label:enterprise-edition[Enterprise Edition] |Description a|File location of namespace for Kubernetes API. |Valid values -a|a path +a|A path. |Default value m|+++/var/run/secrets/kubernetes.io/serviceaccount/namespace+++ |=== @@ -3037,7 +3074,7 @@ label:enterprise-edition[Enterprise Edition] |Description a|Service port name for discovery for Kubernetes API. |Valid values -a|a string +a|A string. |Default value m| |=== @@ -3052,7 +3089,7 @@ label:enterprise-edition[Enterprise Edition] |Description a|File location of token for Kubernetes API. |Valid values -a|a path +a|A path. |Default value m|+++/var/run/secrets/kubernetes.io/serviceaccount/token+++ |=== @@ -3071,7 +3108,7 @@ Refer to the xref:security/index.adoc[Security] section for thorough information |Description a|Determines if Cypher will allow using file URLs when loading data using `LOAD CSV`. Setting this value to `false` will cause Neo4j to fail `LOAD CSV` clauses that load data from the file system. |Valid values -a|a boolean +a|A boolean. |Default value m|+++true+++ |=== @@ -3087,7 +3124,7 @@ label:enterprise-edition[Enterprise Edition] |Description a|The maximum capacity for authentication and authorization caches (respectively). |Valid values -a|an integer +a|An integer. |Default value m|+++10000+++ |=== @@ -3103,7 +3140,7 @@ label:enterprise-edition[Enterprise Edition] |Description a|The time to live (TTL) for cached authentication and authorization info when using external auth providers (LDAP or plugin). Setting the TTL to 0 will disable auth caching. Disabling caching while using the LDAP auth provider requires the use of an LDAP system account for resolving authorization information. |Valid values -a|a duration (Valid units are: `ns`, `μs`, `ms`, `s`, `m`, `h` and `d`; default unit is `s`) +a|A duration (Valid units are: `ns`, `μs`, `ms`, `s`, `m`, `h` and `d`; default unit is `s`). |Default value m|+++10m+++ |=== @@ -3119,7 +3156,7 @@ label:enterprise-edition[Enterprise Edition] |Description a|Enable time-based eviction of the authentication and authorization info cache for external auth providers (LDAP or plugin). Disabling this setting will make the cache live forever and only be evicted when `<>` is exceeded. |Valid values -a|a boolean +a|A boolean. |Default value m|+++true+++ |=== @@ -3133,7 +3170,7 @@ m|+++true+++ |Description a|Enable auth requirement to access Neo4j. |Valid values -a|a boolean +a|A boolean. |Default value m|true |=== @@ -3149,7 +3186,7 @@ label:version-number[Neo4j 5.3] |Description a|The minimum number of characters required in a password. |Valid values -a|an integer +a|An integer that is minimum `1`. |Default value m|+++8+++ |=== @@ -3163,7 +3200,7 @@ m|+++8+++ |Description a|The amount of time user account should be locked after a configured number of unsuccessful authentication attempts. The locked out user will not be able to log in until the lock period expires, even if correct credentials are provided. Setting this configuration option to a low value is not recommended because it might make it easier for an attacker to brute force the password. |Valid values -a|a duration (Valid units are: `ns`, `μs`, `ms`, `s`, `m`, `h` and `d`; default unit is `s`) which is minimum `0s` +a|A duration (Valid units are: `ns`, `μs`, `ms`, `s`, `m`, `h` and `d`; default unit is `s`) that is minimum `0s`. |Default value m|+++5s+++ |=== @@ -3177,7 +3214,7 @@ m|+++5s+++ |Description a|The maximum number of unsuccessful authentication attempts before imposing a user lock for the configured amount of time, as defined by `<>`.The locked out user will not be able to log in until the lock period expires, even if correct credentials are provided. Setting this configuration option to values less than 3 is not recommended because it might make it easier for an attacker to brute force the password. |Valid values -a|an integer which is minimum `0` +a|An integer that is minimum `0`. |Default value m|+++3+++ |=== @@ -3193,7 +3230,7 @@ label:enterprise-edition[Enterprise Edition] |Description a|A list of security authentication providers containing the users and roles. This can be any of the built-in `native` or `ldap` providers, or it can be an externally provided plugin, with a custom name prefixed by `plugin-`, i.e. `plugin-`. They will be queried in the given order when login is attempted. |Valid values -a|a ',' separated list with elements of type 'a string'. +a|A comma-separated list where each element is a string. |Default value m|+++native+++ |=== @@ -3209,7 +3246,7 @@ label:enterprise-edition[Enterprise Edition] |Description a|A list of security authorization providers containing the users and roles. This can be any of the built-in `native` or `ldap` providers, or it can be an externally provided plugin, with a custom name prefixed by `plugin-`, i.e. `plugin-`. They will be queried in the given order when login is attempted. |Valid values -a|a ',' separated list with elements of type 'a string'. +a|A comma-separated list where each element is a string. |Default value m|+++native+++ |=== @@ -3225,7 +3262,7 @@ label:enterprise-edition[Enterprise Edition] |Description a|Require authorization for access to the Causal Clustering status endpoints. |Valid values -a|a boolean +a|A boolean. |Default value m|+++true+++ |=== @@ -3239,7 +3276,7 @@ m|+++true+++ |Description a|Value of the Access-Control-Allow-Origin header sent over any HTTP or HTTPS connector. This defaults to '*', which allows broadest compatibility. Note that any URI provided here limits HTTP/HTTPS access to that URI only. |Valid values -a|a string +a|A string. |Default value m|+++*+++ |=== @@ -3253,7 +3290,7 @@ m|+++*+++ |Description a|Defines an allowlist of http paths where Neo4j authentication is not required. |Valid values -a|a ',' separated list with elements of type 'a string'. +a|A comma-separated list where each element is a string. |Default value m|+++/,/browser.*+++ |=== @@ -3267,7 +3304,7 @@ m|+++/,/browser.*+++ |Description a|Value of the HTTP Strict-Transport-Security (HSTS) response header. This header tells browsers that a webpage should only be accessed using HTTPS instead of HTTP. It is attached to every HTTPS response. Setting is not set by default so 'Strict-Transport-Security' header is not sent. Value is expected to contain directives like 'max-age', 'includeSubDomains' and 'preload'. |Valid values -a|a string +a|A string. |Default value m| |=== @@ -3283,7 +3320,7 @@ label:enterprise-edition[Enterprise Edition] label:dynamic[Dynamic] |Description a|Name of the 256 length AES encryption key, which is used for the symmetric encryption. |Valid values -a|a string +a|A string. |Default value m|+++aesKey+++ |=== @@ -3299,7 +3336,7 @@ label:enterprise-edition[Enterprise Edition] label:dynamic[Dynamic] |Description a|Password for accessing the keystore holding a 256 length AES encryption key, which is used for the symmetric encryption. |Valid values -a|a secure string +a|A secure string. |Default value m| |=== @@ -3315,7 +3352,7 @@ label:enterprise-edition[Enterprise Edition] label:dynamic[Dynamic] |Description a|Location of the keystore holding a 256 length AES encryption key, which is used for the symmetric encryption of secrets held in system database. |Valid values -a|a path +a|A path. |Default value m| |=== @@ -3332,7 +3369,7 @@ label:enterprise-edition[Enterprise Edition] label:dynamic[Dynamic] a|The attribute to use when looking up users. Using this setting requires `<>` to be true and thus `<>` and `<>` to be configured. |Valid values -a|a string which matches the pattern `[A-Za-z0-9-]*` (has to be a valid LDAP attribute name, only containing letters [A-Za-z], digits [0-9] and hyphens [-].) +a|A string that matches the pattern `[A-Za-z0-9-]*` (has to be a valid LDAP attribute name, only containing letters [A-Za-z], digits [0-9] and hyphens [-].). |Default value m|+++samaccountname+++ |=== @@ -3347,9 +3384,9 @@ label:enterprise-edition[Enterprise Edition] |=== |Description a|Determines if the result of authentication via the LDAP server should be cached or not. Caching is used to limit the number of LDAP requests that have to be made over the network for users that have already been authenticated successfully. A user can be authenticated against an existing cache entry (instead of via an LDAP server) as long as it is alive (see `<>`). -An important consequence of setting this to `true` is that Neo4j then needs to cache a hashed version of the credentials in order to perform credentials matching. This hashing is done using a cryptographic hash function together with a random salt. Preferably a conscious decision should be made if this method is considered acceptable by the security standards of the organization in which this Neo4j instance is deployed. +An important consequence of setting this to `true` is that Neo4j then needs to cache a hashed version of the credentials in order to perform credentials matching. This hashing is done using a cryptographic hash function together with a random salt. Preferably a conscious decision should be made if this method is considered acceptable by the security standards of the organization in that this Neo4j instance is deployed. |Valid values -a|a boolean +a|A boolean. |Default value m|+++true+++ |=== @@ -3365,7 +3402,7 @@ label:enterprise-edition[Enterprise Edition] |Description a|LDAP authentication mechanism. This is one of `simple` or a SASL mechanism supported by JNDI, for example `DIGEST-MD5`. `simple` is basic username and password authentication and SASL is used for more advanced mechanisms. See RFC 2251 LDAPv3 documentation for more details. |Valid values -a|a string +a|A string. |Default value m|+++simple+++ |=== @@ -3382,7 +3419,7 @@ label:enterprise-edition[Enterprise Edition] a|Perform authentication by searching for an unique attribute of a user. Using this setting requires `<>` and `<>` to be configured. |Valid values -a|a boolean +a|A boolean. |Default value m|+++false+++ |=== @@ -3398,7 +3435,7 @@ label:enterprise-edition[Enterprise Edition] label:dynamic[Dynamic] |Description a|LDAP user DN template. An LDAP object is referenced by its distinguished name (DN), and a user DN is an LDAP fully-qualified unique user identifier. This setting is used to generate an LDAP DN that conforms with the LDAP directory's schema from the user principal that is submitted with the authentication token when logging in. The special token {0} is a placeholder where the user principal will be substituted into the DN string. |Valid values -a|a string which Must be a string containing '{0}' to understand where to insert the runtime authentication principal. +a|A string that Must be a string containing '{0}' to understand where to insert the runtime authentication principal.. |Default value m|+++uid={0},ou=users,dc=example,dc=com+++ |=== @@ -3415,7 +3452,7 @@ label:enterprise-edition[Enterprise Edition] label:dynamic[Dynamic] |Description a|The LDAP group to which a user must belong to get any access to the system.Set this to restrict access to a subset of LDAP users belonging to a particular group. If this is not set, any user to successfully authenticate via LDAP will have access to the PUBLIC role and any other roles assigned to them via <>. |Valid values -a|a string +a|A string. |Default value m|++++++ |=== @@ -3431,7 +3468,7 @@ label:enterprise-edition[Enterprise Edition] label:dynamic[Dynamic] |Description a|A list of attribute names on a user object that contains groups to be used for mapping to roles when LDAP authorization is enabled. This setting is ignored when `dbms.ldap_authorization_nested_groups_enabled` is `true`. |Valid values -a|a ',' separated list with elements of type 'a string'. which Can not be empty +a|A comma-separated list where each element is a string, which Can not be empty. |Default value m|+++memberOf+++ |=== @@ -3455,7 +3492,7 @@ You could also use whitespaces and quotes around group names to make this mappin "cn=Neo4j Administrator,cn=users,dc=example,dc=com" = admin ---- |Valid values -a|a string that must be semicolon-separated list of key-value pairs or empty +a|A string that must be a semicolon-separated list of key-value pairs or empty. |Default value m|++++++ |=== @@ -3471,7 +3508,7 @@ label:enterprise-edition[Enterprise Edition] label:dynamic[Dynamic] |Description a|This setting determines whether multiple LDAP search results will be processed (as is required for the lookup of nested groups). If set to `true` then instead of using attributes on the user object to determine group membership (as specified by `<>`), the `user` object will only be used to determine the user's Distinguished Name, which will subsequently be used with `<>` in order to perform a nested group search. The Distinguished Names of the resultant group search results will be used to determine roles. |Valid values -a|a boolean +a|A boolean. |Default value m|+++false+++ |=== @@ -3487,7 +3524,7 @@ label:enterprise-edition[Enterprise Edition] label:dynamic[Dynamic] |Description a|The search template which will be used to find the nested groups which the user is a member of. The filter should contain the placeholder token `{0}` which will be substituted with the user's Distinguished Name (which is found for the specified user principle using `<>`). The default value specifies Active Directory's LDAP_MATCHING_RULE_IN_CHAIN (aka 1.2.840.113556.1.4.1941) implementation which will walk the ancestry of group membership for the specified user. |Valid values -a|a string +a|A string. |Default value m|+++(&(objectclass=group)(member:1.2.840.113556.1.4.1941:={0}))+++ |=== @@ -3503,7 +3540,7 @@ label:enterprise-edition[Enterprise Edition] |Description a|An LDAP system account password to use for authorization searches when `<>` is `true`. |Valid values -a|a secure string +a|A secure string. |Default value m| |=== @@ -3519,7 +3556,7 @@ label:enterprise-edition[Enterprise Edition] |Description a|An LDAP system account username to use for authorization searches when `<>` is `true`. Note that the `<>` will not be applied to this username, so you may have to specify a full DN. |Valid values -a|a string +a|A string. |Default value m| |=== @@ -3537,7 +3574,7 @@ a|Perform LDAP search for authorization info using a system account instead of t If this is set to `false` (default), the search for group membership will be performed directly after authentication using the LDAP context bound with the user's own account. The mapped roles will be cached for the duration of `<>`, and then expire, requiring re-authentication. To avoid frequently having to re-authenticate sessions you may want to set a relatively long auth cache expiration time together with this option. NOTE: This option will only work if the users are permitted to search for their own group membership attributes in the directory. If this is set to `true`, the search will be performed using a special system account user with read access to all the users in the directory. You need to specify the username and password using the settings `<>` and `<>` with this option. Note that this account only needs read access to the relevant parts of the LDAP directory and does not need to have access rights to Neo4j, or any other systems. |Valid values -a|a boolean +a|A boolean. |Default value m|+++false+++ |=== @@ -3553,7 +3590,7 @@ label:enterprise-edition[Enterprise Edition] label:dynamic[Dynamic] |Description a|The name of the base object or named context to search for user objects when LDAP authorization is enabled. A common case is that this matches the last part of `<>`. |Valid values -a|a string that cannot be empty +a|A string that Can not be empty. |Default value m|+++ou=users,dc=example,dc=com+++ |=== @@ -3569,7 +3606,7 @@ label:enterprise-edition[Enterprise Edition] label:dynamic[Dynamic] |Description a|The LDAP search filter to search for a user principal when LDAP authorization is enabled. The filter should contain the placeholder token {0} which will be substituted for the user principal. |Valid values -a|a string +a|A string. |Default value m|+++(&(objectClass=*)(uid={0}))+++ |=== @@ -3585,7 +3622,7 @@ label:enterprise-edition[Enterprise Edition] |Description a|The timeout for establishing an LDAP connection. If a connection with the LDAP server cannot be established within the given time the attempt is aborted. A value of 0 means to use the network protocol's (i.e., TCP's) timeout value. |Valid values -a|a duration (Valid units are: `ns`, `μs`, `ms`, `s`, `m`, `h` and `d`; default unit is `s`) +a|A duration (Valid units are: `ns`, `μs`, `ms`, `s`, `m`, `h` and `d`; default unit is `s`). |Default value m|+++30s+++ |=== @@ -3602,7 +3639,7 @@ label:enterprise-edition[Enterprise Edition] a|URL of LDAP server to use for authentication and authorization. The format of the setting is `://:`, where hostname is the only required field. The supported values for protocol are `ldap` (default) and `ldaps`. The default port for `ldap` is 389 and for `ldaps` 636. For example: `ldaps://ldap.example.com:10389`. You may want to consider using STARTTLS (`<>`) instead of LDAPS for secure connections, in which case the correct protocol is `ldap`. |Valid values -a|a string +a|A string. |Default value m|+++localhost+++ |=== @@ -3618,7 +3655,7 @@ label:enterprise-edition[Enterprise Edition] |Description a|The timeout for an LDAP read request (i.e. search). If the LDAP server does not respond within the given time the request will be aborted. A value of 0 means wait for a response indefinitely. |Valid values -a|a duration (Valid units are: `ns`, `μs`, `ms`, `s`, `m`, `h` and `d`; default unit is `s`) +a|A duration (Valid units are: `ns`, `μs`, `ms`, `s`, `m`, `h` and `d`; default unit is `s`). |Default value m|+++30s+++ |=== @@ -3638,7 +3675,7 @@ a|The LDAP referral behavior when creating a connection. This is one of `follow` * `ignore` ignores any referrals * `throw` throws an exception, which will lead to authentication failure. |Valid values -a|a string +a|A string. |Default value m|+++follow+++ |=== @@ -3654,7 +3691,7 @@ label:enterprise-edition[Enterprise Edition] |Description a|Use secure communication with the LDAP server using opportunistic TLS. First an initial insecure connection will be made with the LDAP server, and a STARTTLS command will be issued to negotiate an upgrade of the connection to TLS before initiating authentication. |Valid values -a|a boolean +a|A boolean. |Default value m|+++false+++ |=== @@ -3670,7 +3707,7 @@ label:enterprise-edition[Enterprise Edition] |Description a|Set to log successful authentication events to the security log. If this is set to `false` only failed authentication events will be logged, which could be useful if you find that the successful events spam the logs too much, and you do not require full auditing capability. |Valid values -a|a boolean +a|A boolean. |Default value m|+++true+++ |=== @@ -3686,7 +3723,7 @@ label:enterprise-edition[Enterprise Edition] |Description a|When set to `true`, will log the groups retrieved from the ldap server. This will only take effect when the security log level is set to `DEBUG`.WARNING: It is strongly advised that this is set to `false` when running in a production environment in order to prevent logging of sensitive information. |Valid values -a|a boolean +a|A boolean. |Default value m|+++false+++ |=== @@ -3702,7 +3739,7 @@ label:enterprise-edition[Enterprise Edition] label:dynamic[Dynamic] |Description a|Expected values of the Audience (aud) claim in the id token. |Valid values -a|a ',' separated list with elements of type 'a string'. which Can not be empty +a|A comma-separated list where each element is a string, which Can not be empty. |=== [[config_dbms.security.oidc.-provider-.auth_endpoint]] @@ -3730,7 +3767,7 @@ label:enterprise-edition[Enterprise Edition] label:dynamic[Dynamic] |Description a|The OIDC flow to use. This is exposed to clients via the discovery endpoint. Supported values are `pkce` and `implicit` |Valid values -a|one of [PKCE, IMPLICIT] +a|One of [PKCE, IMPLICIT]. |Default value m|+++PKCE+++ |=== @@ -3770,7 +3807,7 @@ dbms.security.oidc..authorization.group_to_role_mapping=\ "Neo4j Administrator" = admin ---- |Valid values -a|a string which must be semicolon separated list of key-value pairs or empty +a|A string that must be semicolon-separated list of key-value pairs or empty |=== [[config_dbms.security.oidc.-provider-.claims.groups]] @@ -3783,10 +3820,10 @@ label:enterprise-edition[Enterprise Edition] label:dynamic[Dynamic] |=== |Description a|The claim to use as the list of groups in Neo4j. These could be Neo4J roles directly, or can be mapped using dbms.security.oidc..authorization.group_to_role_mapping. -From Neo4j 5.4, the JWT claim may also contain a single group returned as a string as well as a list of groups as was previously required. +From Neo4j 5.4, the JWT claim may also contain a single group returned as A string. as well as a list of groups as was previously required. |Valid values -a|a string +a|A string. |=== [[config_dbms.security.oidc.-provider-.claims.username]] @@ -3800,7 +3837,7 @@ label:enterprise-edition[Enterprise Edition] label:dynamic[Dynamic] |Description a|The claim to use as the username in Neo4j. This would typically be sub, but in some situations it may be be desirable to use something else such as email. |Valid values -a|a string +a|A string. |Default value m|+++sub+++ |=== @@ -3816,7 +3853,7 @@ label:enterprise-edition[Enterprise Edition] label:dynamic[Dynamic] |Description a|Client id needed if token contains multiple Audience (aud) claims. |Valid values -a|a string +a|A string. |=== [[config_dbms.security.oidc.-provider-.config]] @@ -3852,7 +3889,7 @@ m|+++{}+++ a|When set to `true`, it logs the claims from the JWT. This will only take effect when the security log level is set to `DEBUG`. + WARNING: It is strongly advised that this is set to `false` when running in a production environment in order to prevent logging of sensitive information. Also note that the contents of the JWT claims set can change over time because they are dependent entirely upon the ID provider. |Valid values -a|a boolean +a|A boolean. |Default value m|+++false+++ |=== @@ -3869,7 +3906,7 @@ label:enterprise-edition[Enterprise Edition] |Description a|The user-facing name of the provider as provided by the discovery endpoint to clients (Bloom, Browser etc.). |Valid values -a|a string +a|A string. |=== [[config_dbms.security.oidc.-provider-.get_groups_from_user_info]] @@ -3883,7 +3920,7 @@ label:enterprise-edition[Enterprise Edition] label:dynamic[Dynamic] |Description a|When turned on, Neo4j gets the groups from the provider user info endpoint. |Valid values -a|a boolean +a|A boolean. |Default value m|+++false+++ |=== @@ -3899,7 +3936,7 @@ label:enterprise-edition[Enterprise Edition] label:dynamic[Dynamic] |Description a|When turned on, Neo4j gets the username from the provider user info endpoint. |Valid values -a|a boolean +a|A boolean. |Default value m|+++false+++ |=== @@ -3915,7 +3952,7 @@ label:enterprise-edition[Enterprise Edition] label:dynamic[Dynamic] |Description a|The expected value of the iss claim in the id token. If this is not supplied Neo4j will attempt to discover it from the well_known_discovery_uri. |Valid values -a|a string +a|A string. |=== [[config_dbms.security.oidc.-provider-.jwks_uri]] @@ -4022,7 +4059,7 @@ a|a URI |Description a|A list of procedures (comma separated) that are to be loaded. The list may contain both fully-qualified procedure names, and partial names with the wildcard `*`. The default (`*`) loads all procedures. If no value is specified, no procedures will be loaded. |Valid values -a|a ',' separated list with elements of type 'a string'. +a|A comma-separated list where each element is a string. |Default value m|+++*+++ |=== @@ -4036,7 +4073,7 @@ m|+++*+++ |Description a|A list of procedures and user-defined functions (comma separated) that are allowed full access to the database. The list may contain both fully-qualified procedure names, and partial names with the wildcard `*`. Note that this enables these procedures to bypass security. Use with caution. |Valid values -a|a ',' separated list with elements of type 'a string'. +a|A comma-separated list where each element is a string. |Default value m|++++++ |=== @@ -4050,7 +4087,7 @@ m|++++++ |Description a|Netty SSL provider. |Valid values -a|one of [JDK, OPENSSL, OPENSSL_REFCNT] +a|One of [JDK, OPENSSL, OPENSSL_REFCNT]. |Default value m|+++JDK+++ |=== @@ -4071,7 +4108,7 @@ label:enterprise-edition[Enterprise Edition] |Description a|Directory to hold cluster state including Raft log. |Valid values -a|a path. If relative it is resolved from server.directories.data +a|A path. If relative, it is resolved from server.directories.data. |Default value m|+++cluster-state+++ |=== @@ -4085,7 +4122,7 @@ m|+++cluster-state+++ |Description a|Path of the data directory. You must not configure more than one Neo4j installation to use the same data directory. |Valid values -a|a path. If relative it is resolved from server.directories.neo4j_home +a|A path. If relative, it is resolved from server.directories.neo4j_home. |Default value m|+++data+++ |=== @@ -4099,7 +4136,7 @@ m|+++data+++ |Description a|Root location where Neo4j will store database dumps optionally produced when dropping said databases. |Valid values -a|a path. If relative it is resolved from server.directories.data +a|A path. If relative, it is resolved from server.directories.data. |Default value m|+++dumps+++ |=== @@ -4113,7 +4150,7 @@ m|+++dumps+++ |Description a|Sets the root directory for file URLs used with the Cypher `LOAD CSV` clause. This should be set to a directory relative to the Neo4j installation path, restricting access to only those files within that directory and its subdirectories. For example the value "import" will only enable access to files within the 'import' folder. Removing this setting will disable the security feature, allowing all files in the local system to be imported. Setting this to an empty field will allow access to all files within the Neo4j installation folder. |Valid values -a|a path. If relative it is resolved from server.directories.neo4j_home +a|A path. If relative, it is resolved from server.directories.neo4j_home. |Default value m| |=== @@ -4127,7 +4164,7 @@ m| |Description a|Path of the lib directory. |Valid values -a|a path. If relative it is resolved from server.directories.neo4j_home +a|A path. If relative, it is resolved from server.directories.neo4j_home. |Default value m|+++lib+++ |=== @@ -4141,7 +4178,7 @@ m|+++lib+++ |Description a|Path of the licenses directory. |Valid values -a|a path. If relative it is resolved from server.directories.neo4j_home +a|A path. If relative, it is resolved from server.directories.neo4j_home. |Default value m|+++licenses+++ |=== @@ -4155,7 +4192,7 @@ m|+++licenses+++ |Description a|Path of the logs directory. |Valid values -a|a path. If relative it is resolved from server.directories.neo4j_home +a|A path. If relative, it is resolved from server.directories.neo4j_home. |Default value m|+++logs+++ |=== @@ -4171,7 +4208,7 @@ label:enterprise-edition[Enterprise Edition] |Description a|The target location of the CSV files: a path to a directory wherein a CSV file per reported field will be written. |Valid values -a|a path. If relative it is resolved from server.directories.neo4j_home +a|A path. If relative, it is resolved from server.directories.neo4j_home. |Default value m|+++metrics+++ |=== @@ -4183,11 +4220,11 @@ m|+++metrics+++ [frame="topbot", stripes=odd, grid="cols", cols="<1s,<4"] |=== |Description -a|Root relative to which directory settings are resolved. Calculated and set by the server on startup. +a|Root relative to which directory settings are resolved. Calculated and set by the server on startup. Defaults to the current working directory. |Valid values -a| an absolute path +a|A path that is absolute. |Default value -m|Defaults to current working directory +m| |=== [[config_server.directories.plugins]] @@ -4199,7 +4236,7 @@ m|Defaults to current working directory |Description a|Location of the database plugin directory. Compiled Java JAR files that contain database procedures will be loaded if they are placed in this directory. |Valid values -a|a path. If relative it is resolved from server.directories.neo4j_home +a|A path. If relative, it is resolved from server.directories.neo4j_home. |Default value m|+++plugins+++ |=== @@ -4213,7 +4250,7 @@ m|+++plugins+++ |Description a|Path of the run directory. This directory holds Neo4j's runtime state, such as a pidfile when it is running in the background. The pidfile is created when starting neo4j and removed when stopping it. It may be placed on an in-memory filesystem such as tmpfs. |Valid values -a|a path. If relative it is resolved from server.directories.neo4j_home +a|A path. If relative, it is resolved from server.directories.neo4j_home. |Default value m|+++run+++ |=== @@ -4227,7 +4264,7 @@ m|+++run+++ |Description a|Root location where Neo4j will store scripts for configured databases. |Valid values -a|a path. If relative it is resolved from server.directories.data +a|A path. If relative, it is resolved from server.directories.data. |Default value m|+++scripts+++ |=== @@ -4241,7 +4278,7 @@ m|+++scripts+++ |Description a|Root location where Neo4j will store transaction logs for configured databases. |Valid values -a|a path. If relative it is resolved from server.directories.data +a|A path. If relative, it is resolved from server.directories.data. |Default value m|+++transactions+++ |=== @@ -4261,11 +4298,48 @@ label:enterprise-edition[Enterprise Edition] |Description a|Enable support for running online backups. |Valid values -a|a boolean +a|A boolean. |Default value m|+++true+++ |=== +[[config_server.backup.exec_connector.command]] +=== `server.backup.exec_connector.command` + +label:enterprise-edition[Enterprise Edition] + +.server.backup.exec_connector.command +[frame="topbot", stripes=odd, grid="cols", cols="<1s,<4"] +|=== +|Description +a|Command to execute for ExecDataConnector list +|Valid values +a|A string. +|Default value +m|++++++ +|=== + +[[config_server.backup.exec_connector.command_timeout]] + +[[config_server.backup.exec_connector.scheme]] +=== `server.backup.exec_connector.scheme` + +label:enterprise-edition[Enterprise Edition] + +.server.backup.exec_connector.scheme +[frame="topbot", stripes=odd, grid="cols", cols="<1s,<4"] +|=== +|Description +a|Schemes ExecDataConnector will match on +|Valid values +a|A comma-separated list where each element is a string. +|Default value +m| +|=== + +[[config_server.backup.exec_connector.tls_ca]] + + [[config_server.backup.listen_address]] === `server.backup.listen_address` @@ -4277,7 +4351,7 @@ label:enterprise-edition[Enterprise Edition] |Description a|Network interface and port for the backup server to listen on. |Valid values -a|a socket address in the format 'hostname:port', 'hostname' or ':port' +a|A socket address in the format of `hostname:port`, `hostname`, or `:port`. |Default value m|+++127.0.0.1:6362+++ |=== @@ -4293,7 +4367,7 @@ label:enterprise-edition[Enterprise Edition] |Description a|Maximum retry time per request during store copy. Regular store files and indexes are downloaded in separate requests during store copy. This configures the maximum time failed requests are allowed to resend. |Valid values -a|a duration (Valid units are: `ns`, `μs`, `ms`, `s`, `m`, `h` and `d`; default unit is `s`) +a|A duration (Valid units are: `ns`, `μs`, `ms`, `s`, `m`, `h` and `d`; default unit is `s`). |Default value m|+++20m+++ |=== @@ -4307,7 +4381,7 @@ m|+++20m+++ |Description a|A strict configuration validation will prevent the database from starting up if unknown configuration options are specified in the neo4j settings namespace (such as dbms., cypher., etc) or if settings are declared multiple times. |Valid values -a|a boolean +a|A boolean. |Default value m|+++true+++ |=== @@ -4323,7 +4397,7 @@ label:dynamic[Dynamic] |Description a|Whether or not any database on this instance is read_only by default. If false, individual databases may be marked as read_only using server.database.read_only. If true, individual databases may be marked as writable using <>. |Valid values -a|a boolean +a|A boolean. |Default value m|+++false+++ |=== @@ -4339,7 +4413,7 @@ label:dynamic[Dynamic] |Description a|List of databases for which to prevent write queries. Databases not included in this list maybe read_only anyway depending upon the value of <>. |Valid values -a|a ',' separated set with elements of type 'A valid database name containing only alphabetic characters, numbers, dots and dashes with a length between 3 and 63 characters, starting with an alphabetic character but not with the name 'system''. which Value 'system' can't be included in read-only databases collection! +a| A comma-separated set where each element is a valid database name containing only alphabetic characters, numbers, dots, and dashes with a length between 3 and 63 characters, starting with an alphabetic character but not with the name system. |Default value m|++++++ |=== @@ -4355,7 +4429,7 @@ label:dynamic[Dynamic] |Description a|List of databases for which to allow write queries. Databases not included in this list will allow write queries anyway, unless <> is set to true. |Valid values -a|a ',' separated set with elements of type 'A valid database name containing only alphabetic characters, numbers, dots and dashes with a length between 3 and 63 characters, starting with an alphabetic character but not with the name 'system''. +a|A comma-separated set where each element is a valid database name containing only alphabetic characters, numbers, dots, and dashes with a length between 3 and 63 characters, starting with an alphabetic character but not with the name system. |Default value m|++++++ |=== @@ -4371,7 +4445,7 @@ label:enterprise-edition[Enterprise Edition] |Description a|A list of setting name patterns (comma separated) that are allowed to be dynamically changed. The list may contain both full setting names, and partial names with the wildcard `*`. If this setting is left empty all dynamic settings updates will be blocked. |Valid values -a|a ',' separated list with elements of type 'a string'. +a|A comma-separated list where each element is a string. |Default value m|+++*+++ |=== @@ -4385,7 +4459,7 @@ m|+++*+++ |Description a|Additional JVM arguments. Argument order can be significant. To use a Java commercial feature, the argument to unlock commercial features must precede the argument to enable the specific feature in the config value string. |Valid values -a|one or more jvm arguments +a|One or more jvm arguments. |Default value m| |=== @@ -4402,7 +4476,7 @@ label:enterprise-edition[Enterprise Edition] label:deprecated[Deprecated in 5.6] |Description a|The maximum number of databases. |Valid values -a|a long, which is a minimum `2` +a|A long that is minimum `2`. |Default value m|+++100+++ |Replaced by @@ -4419,11 +4493,11 @@ label:enterprise-edition[Enterprise Edition] [frame="topbot", stripes=odd, grid="cols", cols="<1s,<4"] |=== |Description -a|If there is a Database Management System Panic (an irrecoverable error) should the neo4j process shut down or continue running. Following a DbMS panic it is likely that a significant amount of functionality will be lost. Recovering full functionality will require a Neo4j restart. +a|If there is a Database Management System Panic (an irrecoverable error) should the neo4j process shut down or continue running. Following a DbMS panic it is likely that a significant amount of functionality will be lost. Recovering full functionality will require a Neo4j restart. Default is `false` except for Neo4j Enterprise Edition deployments running on Kubernetes where it is `true`. |Valid values -a|a boolean +a|A boolean. |Default value -m|`false` except for Neo4j Enterprise Edition deployments running on Kubernetes where it is `true`. +m|false |=== [[config_server.threads.worker_count]] @@ -4433,11 +4507,11 @@ m|`false` except for Neo4j Enterprise Edition deployments running on Kubernetes [frame="topbot", stripes=odd, grid="cols", cols="<1s,<4"] |=== |Description -a|Number of Neo4j worker threads. This setting is only valid for REST and does not influence bolt-server. It sets the number of worker threads for the Jetty server used by neo4j-server. This option can be tuned when you plan to execute multiple, concurrent REST requests, to get more throughput from the database. Your OS might enforce a lower limit than the maximum value specified here. +a|Number of Neo4j worker threads. This setting is only valid for REST and does not influence bolt-server. It sets the number of worker threads for the Jetty server used by neo4j-server. This option can be tuned when you plan to execute multiple, concurrent REST requests, to get more throughput from the database. Your OS might enforce a lower limit than the maximum value specified here. Number of available processors, or 500 for machines that have more than 500 processors. |Valid values -a|an integer, which is in the range `1` to `44738` +a|An integer that is in the range `1` to `44738`. |Default value -m|Number of available processors, or 500 for machines that have more than 500 processors. +m| |=== [[config_server.unmanaged_extension_classes]] @@ -4449,7 +4523,7 @@ m|Number of available processors, or 500 for machines that have more than 500 pr |Description a|Comma-separated list of = for unmanaged extensions. |Valid values -a|a ',' separated list with elements of type '= string'. +a|A comma-separated list where each element is `=` string. |Default value m|++++++ |=== @@ -4463,7 +4537,7 @@ m|++++++ |Description a|Name of the Windows Service managing Neo4j when installed using `neo4j install-service`. Only applicable on Windows OS. Note: This must be unique for each installation. |Valid values -a|a string +a|A string. |Default value m|+++neo4j+++ |=== @@ -4484,7 +4558,7 @@ label:dynamic[Dynamic] |Description a|The maximum time interval within which lock should be acquired. Zero (default) means the timeout is disabled. |Valid values -a|a duration (Valid units are: `ns`, `μs`, `ms`, `s`, `m`, `h` and `d`; default unit is `s`) +a|A duration (Valid units are: `ns`, `μs`, `ms`, `s`, `m`, `h` and `d`; default unit is `s`). |Default value m|+++0s+++ |=== @@ -4498,7 +4572,7 @@ m|+++0s+++ |Description a|The maximum amount of time to wait for running transactions to complete before allowing initiated database shutdown to continue. |Valid values -a|a duration (Valid units are: `ns`, `μs`, `ms`, `s`, `m`, `h` and `d`; default unit is `s`) +a|A duration (Valid units are: `ns`, `μs`, `ms`, `s`, `m`, `h` and `d`; default unit is `s`). |Default value m|+++10s+++ |=== @@ -4514,7 +4588,7 @@ label:dynamic[Dynamic] |Description a|The maximum amount of time to wait for the database state represented by the bookmark. |Valid values -a|a duration (Valid units are: `ns`, `μs`, `ms`, `s`, `m`, `h` and `d`; default unit is `s`) which is minimum `1s` +a|A duration (Valid units are: `ns`, `μs`, `ms`, `s`, `m`, `h` and `d`; default unit is `s`) that is minimum `1s`. |Default value m|+++30s+++ |=== @@ -4530,7 +4604,7 @@ label:dynamic[Dynamic] |Description a|The maximum number of concurrently running transactions. If set to 0, the limit is disabled. |Valid values -a|an integer +a|An integer. |Default value m|+++1000+++ |=== @@ -4544,7 +4618,7 @@ m|+++1000+++ |Description a|Configures the time interval between transaction monitor checks. Determines how often the monitor thread will check a transaction for timeout. |Valid values -a|a duration (Valid units are: `ns`, `μs`, `ms`, `s`, `m`, `h` and `d`; default unit is `s`) +a|A duration (Valid units are: `ns`, `μs`, `ms`, `s`, `m`, `h` and `d`; default unit is `s`). |Default value m|+++2s+++ |=== @@ -4560,7 +4634,7 @@ label:dynamic[Dynamic] |Description a|Transaction sampling percentage. |Valid values -a|an integer which is in the range `1` to `100` +a|An integer that is in the range `1` to `100`. |Default value m|+++5+++ |=== @@ -4576,7 +4650,7 @@ label:dynamic[Dynamic] |Description a|The maximum time interval of a transaction within which it should be completed. |Valid values -a|a duration (Valid units are: `ns`, `μs`, `ms`, `s`, `m`, `h` and `d`; default unit is `s`) +a|A duration (Valid units are: `ns`, `μs`, `ms`, `s`, `m`, `h` and `d`; default unit is `s`). |Default value m|+++0s+++ |=== @@ -4592,7 +4666,7 @@ label:dynamic[Dynamic] |Description a|Transaction creation tracing level. |Valid values -a|one of [DISABLED, SAMPLE, ALL] +a|One of [DISABLED, SAMPLE, ALL]. |Default value m|+++DISABLED+++ |=== @@ -4614,7 +4688,7 @@ See also <>. |Description a|If `true`, Neo4j will abort recovery if transaction log files are missing. Setting this to `false` will allow Neo4j to create new empty missing files for the already existing database, but the integrity of the database might be compromised. |Valid values -a|db.recovery.fail_on_missing_files, a boolean +a|A boolean. |Default value m|+++true+++ |=== @@ -4627,10 +4701,11 @@ m|+++true+++ |=== |Description a|On serialization of transaction logs, they will be temporary stored in the byte buffer that will be flushed at the end of the transaction or at any moment when the buffer will be full. +By default, the size of the byte buffer is based on the number of available CPU's with a minimal buffer size of 512KB. Every other 4 CPU's will add another 512KB into the buffer size. The maximal buffer size in this default scheme is 4MB taking into account that you can have one transaction log writer per database in multi-database env. For example, runtime with 4 CPUs will have the buffer size of 1MB; runtime with 8 CPUs will have the buffer size of 1MB 512KB; runtime with 12 CPUs will have the buffer size of 2MB. |Valid values -a|a long which is minimum `131072` +a|A long that is minimum `131072`. |Default value -m|By default, the size of the byte buffer is based on the number of available CPU's with a minimal buffer size of 512KB. Every other 4 CPU's will add another 512KB into the buffer size. The maximal buffer size in this default scheme is 4MB taking into account that you can have one transaction log writer per database in multi-database env. For example, runtime with 4 CPUs will have the buffer size of 1MB; runtime with 8 CPUs will have the buffer size of 1MB 512KB; runtime with 12 CPUs will have the buffer size of 2MB. +m| |=== [[config_db.tx_log.preallocate]] @@ -4645,7 +4720,7 @@ label:dynamic[Dynamic] a|Specify if Neo4j should try to preallocate the logical log file in advance. It optimizes file system by ensuring there is room to accommodate newly generated files and avoid file-level fragmentation. |Valid values -a|a boolean +a|A boolean. |Default value m|+++true+++ |=== @@ -4665,13 +4740,7 @@ Alternatively, `100k txs` keeps the 100k latest transactions from each database From Neo4j 5.9 onwards, you can optionally add a period-based restriction to the size of logs to keep. For example, `2 days 1G` prunes logical logs that only contain transactions older than 2 days or are larger than 1G. |Valid values -a|a string which matches the pattern, `^(true\|keep_all\|false\|keep_none\|(\\d+[KkMmGg]?( (files\|size\|txs\|entries\|hours( \\d+[KkMmGg]?)?\|days( \\d+[KkMmGg]?)?))))$` -Must be `true` or `keep_all`, `false` or `keep_none`, or of format ` `. -Valid units are `K`, `M`, and `G`. -Valid types are `files`, `size`, `txs`, `entries`, `hours`, and `days`. -Valid optional space restriction is a logical log space restriction like `1G`. -For example, `1G size` limits logical log space on the disk to 1G per database, `200K txs` limits the number of transactions kept to 200 000 per database, and `2 days 1G` limits the logical log space on the disk to 1G at most 2 days per database. + -Starting from Neo4j 5.13, the default value is changed from `2 days` to `2 days 2G`. +a| A string that matches the pattern `^(true\|keep_all\|false\|keep_none\|(\d+[KkMmGg]?( (files\|size\|txs\|entries\|hours( \d+[KkMmGg]?)?\|days( \d+[KkMmGg]?)?))))$` (Must be `true` or `keep_all`, `false` or `keep_none`, or of format ` `. Valid units are `K`, `M` and `G`. Valid types are `files`, `size`, `txs`, `entries`, `hours` and `days`. Valid optional space restriction is a logical log space restriction like 100M. For example, `100M size` will limit logical log space on disk to 100MiB per database, and `200K txs` will limit the number of transactions kept to 200 000 per database.). |Default value m|+++2 days 2G+++ |=== @@ -4687,7 +4756,7 @@ label:dynamic[Dynamic] |Description a|Specifies at which file size the logical log will auto-rotate. The minimum accepted value is 128 KiB. |Valid values -a|a byte size (valid multipliers are `B`, `KiB`, `KB`, `K`, `kB`, `kb`, `k`, `MiB`, `MB`, `M`, `mB`, `mb`, `m`, `GiB`, `GB`, `G`, `gB`, `gb`, `g`, `TiB`, `TB`, `PiB`, `PB`, `EiB`, `EB`) which is minimum `128.00KiB` +a|A byte size (valid multipliers are `B`, `KiB`, `KB`, `K`, `kB`, `kb`, `k`, `MiB`, `MB`, `M`, `mB`, `mb`, `m`, `GiB`, `GB`, `G`, `gB`, `gb`, `g`, `TiB`, `TB`, `PiB`, `PB`, `EiB`, `EB`) that is minimum `128.00KiB`. |Default value m|+++256.00MiB+++ |===