Skip to main content
Version: 24.11.01

Allowed configurations

Server configuration

Environment variable

Valid values

Default value

Description

db.checkpoint

neo4j_db_checkpoint

One of [PERIODIC, VOLUME]PERIODICConfigures the general policy for when checkpoints should occur. Possible values are: PERIODIC (default) - it runs a checkpoint as per the interval specified by db.checkpoint.interval.tx and db.checkpoint.interval.time. VOLUME - it runs a checkpoint when the size of the transaction logs reaches the value specified by the db.checkpoint.interval.volume setting. By default, it is set to 250.00MiB.

db.checkpoint.interval.time

neo4j_db_checkpoint_interval_time

A duration (Valid units are: ns, μs, ms, s, m, h and d; default unit is s)15mConfigures the time interval between checkpoints. The database does not checkpoint more often than the specified interval (unless checkpointing is triggered by a different event) but might checkpoint less often if performing a checkpoint takes longer time than the configured interval. A checkpoint is a point in the transaction logs from which recovery starts. Longer checkpoint intervals typically mean that recovery takes 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.

db.checkpoint.interval.volume

neo4j_db_checkpoint_interval_volume

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.250.00MiBConfigures the volume of transaction logs between checkpoints. The database does not checkpoint more often than the specified interval (unless checkpointing is triggered by a different event) but might checkpoint less often 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 takes 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.

server.bolt.thread_pool_keep_alive

neo4j_server_bolt_thread_pool_keep_alive

A duration (Valid units are: ns, μs, ms, s, m, h and d; default unit is s)5mThe maximum time an idle thread in the thread pool bound to this connector waits for new tasks.

server.bolt.thread_pool_max_size

neo4j_server_bolt_thread_pool_max_size

An integer400The maximum number of threads allowed in the thread pool bound to this connector.

server.bolt.thread_pool_min_size

neo4j_server_bolt_thread_pool_min_size

An integer5The number of threads, including idle, to keep in the thread pool bound to this connector.

dbms.cypher.planner

neo4j_dbms_cypher_planner

One of [DEFAULT, COST]DEFAULTSet this to specify the default planner for the default language version.

db.filewatcher.enabled

neo4j_db_filewatcher_enabled

A booleanTRUEAllows the enabling or disabling of the file watcher service. This is an auxiliary service but should be left enabled in almost all cases.

db.import.csv.buffer_size

neo4j_db_import_csv_buffer_size

A long that is minimum 12097152The 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.

db.index.fulltext.eventually_consistent

neo4j_db_index_fulltext_eventually_consistent

A booleanFALSEWhether or not full-text indexes should be eventually consistent by default or not.

db.index_sampling.background_enabled

neo4j_db_index_sampling_background_enabled

A booleanTRUEEnable or disable background index sampling.

db.index_sampling.sample_size_limit

neo4j_db_index_sampling_sample_size_limit

An integer that is in the range 1048576 to 2147483647.8388608Index sampling chunk size limit.

db.index_sampling.update_percentage

neo4j_db_index_sampling_update_percentage

An integer that is minimum 0.5Percentage of index updates of total index size required before sampling of a given index is triggered.

db.logs.query.parameter_logging_enabled

neo4j_db_logs_query_parameter_logging_enabled

A booleanTRUELog parameters for the executed queries being logged.

db.logs.query.plan_description_enabled

neo4j_db_logs_query_plan_description_enabled

A booleanFALSELog query plan description table, useful for debugging purposes.

db.logs.query.threshold

neo4j_db_logs_query_threshold

A duration (Valid units are: ns, μs, ms, s, m, h and d; default unit is s)0sIf 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.

server.logs.gc.rotation.keep_number

neo4j_server_logs_gc_rotation_keep_number

An integer5Number of GC logs to keep.

server.logs.gc.rotation.size

neo4j_server_logs_gc_rotation_size

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).20.00MiBSize of each GC log that is kept.

server.memory.heap.initial_size

neo4j_server_memory_heap_initial_size

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).Auto assigned by Neo4jInitial heap size. By default it is calculated based on available system resources.

server.memory.heap.max_size

neo4j_server_memory_heap_max_size

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).Auto assigned by Neo4jMaximum heap size. By default it is calculated based on available system resources.

dbms.security.auth_max_failed_attempts

neo4j_dbms_security_auth_max_failed_attempts

An integer that is minimum 0.3The maximum number of unsuccessful authentication attempts before imposing a user lock for the configured amount of time, as defined by dbms.security.auth_lock_time. The locked out user will not be able to log in until the lock period expires, even if correct credentials are provided.

server.threads.worker_count

neo4j_server_threads_worker_count

An integer that is in the range 1 to 44738.Auto assigned by Neo4jNumber 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.

db.transaction.concurrent.maximum

neo4j_db_transaction_concurrent_maximum

An integer1000The maximum number of concurrently running transactions. If set to 0, the limit is disabled.

db.transaction.sampling.percentage

neo4j_db_transaction_sampling_percentage

An integer that is in the range 1 to 100.5Transaction sampling percentage.

db.transaction.tracing.level

neo4j_db_transaction_tracing_level

One of [DISABLED, SAMPLE, ALL]DISABLEDTransaction creation tracing level.
Was this page helpful?