db_config.h

Go to the documentation of this file.

#pragma once
 
#include <string>
 
#include "value.h"
 
namespace kuzu {
namespace common {
class Value;
enum class LogicalTypeID : uint8_t;
} // namespace common
 
namespace main {
 
class ClientContext;
struct SystemConfig;
 
typedef void (*set_context)(ClientContext* context, const common::Value& parameter);
typedef common::Value (*get_setting)(const ClientContext* context);
 
enum class OptionType : uint8_t { CONFIGURATION = 0, EXTENSION = 1 };
 
struct Option {
 std::string name;
 common::LogicalTypeID parameterType;
 OptionType optionType;
 
 Option(std::string name, common::LogicalTypeID parameterType, OptionType optionType)
 : name{std::move(name)}, parameterType{std::move(parameterType)}, optionType{optionType} {}
 
 virtual ~Option() = default;
};
 
struct ConfigurationOption final : Option {
 set_context setContext;
 get_setting getSetting;
 
 ConfigurationOption(std::string name, common::LogicalTypeID parameterType,
 set_context setContext, get_setting getSetting)
 : Option{std::move(name), parameterType, OptionType::CONFIGURATION}, setContext{setContext},
 getSetting{getSetting} {}
};
 
struct ExtensionOption final : Option {
 common::Value defaultValue;
 
 ExtensionOption(std::string name, common::LogicalTypeID parameterType,
 common::Value defaultValue)
 : Option{std::move(name), parameterType, OptionType::EXTENSION},
 defaultValue{std::move(defaultValue)} {}
};
 
struct DBConfig {
 uint64_t bufferPoolSize;
 uint64_t maxNumThreads;
 bool enableCompression;
 bool readOnly;
 uint64_t maxDBSize;
 bool enableMultiWrites;
 bool autoCheckpoint;
 uint64_t checkpointThreshold;
 bool forceCheckpointOnClose;
 
 explicit DBConfig(const SystemConfig& systemConfig);
 
 static ConfigurationOption* getOptionByName(const std::string& optionName);
 KUZU_API static bool isDBPathInMemory(const std::string& dbPath);
};
 
} // namespace main
} // namespace kuzu