Skip to content
Closed
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
85 changes: 60 additions & 25 deletions configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,30 +63,31 @@ GRAPH.CONFIG GET *

Values set using `GRAPH.CONFIG SET` are not persisted after server restart.

## FalkorDB configuration parameters

The following table summarizes which configuration parameters can be set at module load-time and which can also be set at run-time:

| Configuration Parameter | Load-time| Run-time|
| :------- | :-----| :-----|
| [THREAD_COUNT](#thread_count) | V | X |
| [CACHE_SIZE](#cache_size) | V | X |
| [OMP_THREAD_COUNT](#omp_thread_count) | V | X |
| [NODE_CREATION_BUFFER](#node_creation_buffer) | V | X |
| [BOLT_PORT](#bolt_port) | V | X |
| [MAX_QUEUED_QUERIES](#max_queued_queries) | V | V |
| [TIMEOUT](#timeout) (deprecated in v2.10) | V | V |
| [TIMEOUT_MAX](#timeout_max) (since v2.10) | V | V |
| [TIMEOUT_DEFAULT](#timeout_default) (since v2.10) | V | V |
| [RESULTSET_SIZE](#resultset_size) | V | V |
| [QUERY_MEM_CAPACITY](#query_mem_capacity) | V | V |
| [VKEY_MAX_ENTITY_COUNT](#vkey_max_entity_count) | V | V |
| [EFFECTS_THRESHOLD](#effects_threshold) | V | V |
| [CMD_INFO](#cmd_info) | V | V |
| [MAX_INFO_QUERIES](#max_info_queries) | V | V |
| [IMPORT_FOLDER](#import_folder) | V | X |

---
## FalkorDB Configuration Parameters

FalkorDB supports various configuration parameters that can be set at **load-time** (module initialization) and/or **run-time** (during operation). The table below uses `✓` for supported settings and `✗` for unsupported settings.

| Configuration Parameter | Load-time | Run-time |
|:------------------------------------------------------|:---------:|:--------:|
| [THREAD_COUNT](#thread_count) | ✓ | ✗ |
| [CACHE_SIZE](#cache_size) | ✓ | ✗ |
| [OMP_THREAD_COUNT](#omp_thread_count) | ✓ | ✗ |
| [NODE_CREATION_BUFFER](#node_creation_buffer) | ✓ | ✗ |
| [BOLT_PORT](#bolt_port) | ✓ | ✗ |
| [MAX_QUEUED_QUERIES](#max_queued_queries) | ✓ | ✓ |
| [TIMEOUT](#timeout) | ✓ | ✓ |
| [TIMEOUT_MAX](#timeout_max) | ✓ | ✓ |
| [TIMEOUT_DEFAULT](#timeout_default) | ✓ | ✓ |
| [RESULTSET_SIZE](#resultset_size) | ✓ | ✓ |
| [QUERY_MEM_CAPACITY](#query_mem_capacity) | ✓ | ✓ |
| [VKEY_MAX_ENTITY_COUNT](#vkey_max_entity_count) | ✓ | ✓ |
| [EFFECTS_THRESHOLD](#effects_threshold) | ✓ | ✓ |
| [CMD_INFO](#cmd_info) | ✓ | ✓ |
| [MAX_INFO_QUERIES](#max_info_queries) | ✓ | ✓ |
| [IMPORT_FOLDER](#import_folder) | ✓ | ✗ |
| [DELAY_INDEXING](#delay_indexing) | ✓ | ✗ |
| [DELTA_MAX_PENDING_CHANGES](#delta_max_pending_changes)| ✓ | ✗ |
| [ASYNC_DELETE](#async_delete) | ✓ | ✗ |

### THREAD_COUNT

Expand Down Expand Up @@ -197,7 +198,7 @@ $ redis-cli GRAPH.CONFIG SET MAX_QUEUED_QUERIES 500

### TIMEOUT

(Deprecated in FalkorDB v2.10 It is recommended to use `TIMEOUT_MAX` and `TIMEOUT_DEFAULT` instead)
(**Deprecated**. It is recommended to use `TIMEOUT_MAX` and `TIMEOUT_DEFAULT` instead)

The `TIMEOUT` configuration parameter specifies the default maximal execution time for read queries, in milliseconds. Write queries do not timeout.

Expand Down Expand Up @@ -389,3 +390,37 @@ The import folder configuration specifies an absolute path to a folder from whic
FalkorDB is allowed to load CSV files.

Defaults to: `/var/lib/FalkorDB/import/`

---

### DELAY_INDEXING

Delay indexing configuration if set to `yes` will delay index construction during
database load, speeding up the overall loading time, indexes will be constructed
asynchronously once the DB is fully loaded, during construction time the database
is fully functional.

Defaults to: `no`

---

### DELTA_MAX_PENDING_CHANGES

Delta max pending changes determines the number of creations & deletions held
by delta matrices before a matrix flush is required, setting this value too low
will result in frequent matrix flush which will hurt performance, setting this value
too high will also effect performance as
intermediate delta matrices will incur a large number of changes.

Defaults to: `10000`

---

### ASYNC_DELETE

Controls how graphs are discarded, when set to `yes` graph are freed on a dedicated thread
leaving the server's main thread free,
otherwise graphs are freed on the server's main thread.

Defaults to `yes`