Stores runtime configuration for creating or opening a Database.
More...
#include <database.h>
Stores runtime configuration for creating or opening a Database.
◆ SystemConfig()
| kuzu::main::SystemConfig::SystemConfig |
( |
uint64_t | bufferPoolSize = -1u, |
|
|
uint64_t | maxNumThreads = 0, |
|
|
bool | enableCompression = true, |
|
|
bool | readOnly = false, |
|
|
uint64_t | maxDBSize = -1u, |
|
|
bool | autoCheckpoint = true, |
|
|
uint64_t | checkpointThreshold = 16777216 ) |
|
explicit |
Creates a SystemConfig object.
- Parameters
-
| bufferPoolSize | Max size of the buffer pool in bytes. The larger the buffer pool, the more data from the database files is kept in memory, reducing the amount of File I/O |
| maxNumThreads | The maximum number of threads to use during query execution |
| enableCompression | Whether or not to compress data on-disk for supported types |
| readOnly | If true, the database is opened read-only. No write transaction is allowed on the Database object. Multiple read-only Database objects can be created with the same database path. If false, the database is opened read-write. Under this mode, there must not be multiple Database objects created with the same database path. |
| maxDBSize | The maximum size of the database in bytes. Note that this is introduced temporarily for now to get around with the default 8TB mmap address space limit some environment. This will be removed once we implemente a better solution later. The value is default to 1 << 43 (8TB) under 64-bit environment and 1GB under 32-bit one (see DEFAULT_VM_REGION_MAX_SIZE). |
| autoCheckpoint | If true, the database will automatically checkpoint when the size of the WAL file exceeds the checkpoint threshold. |
| checkpointThreshold | The threshold of the WAL file size in bytes. When the size of the WAL file exceeds this threshold, the database will checkpoint if autoCheckpoint is true. |
◆ autoCheckpoint
| bool kuzu::main::SystemConfig::autoCheckpoint |
◆ bufferPoolSize
| uint64_t kuzu::main::SystemConfig::bufferPoolSize |
◆ checkpointThreshold
| uint64_t kuzu::main::SystemConfig::checkpointThreshold |
◆ enableCompression
| bool kuzu::main::SystemConfig::enableCompression |
◆ maxDBSize
| uint64_t kuzu::main::SystemConfig::maxDBSize |
◆ maxNumThreads
| uint64_t kuzu::main::SystemConfig::maxNumThreads |
◆ readOnly
| bool kuzu::main::SystemConfig::readOnly |
The documentation for this struct was generated from the following file:
1.12.0