client_config.h

Go to the documentation of this file.

#pragma once
 
#include <cstdint>
#include <string>
 
#include "path_semantic.h"
 
namespace kuzu {
namespace main {
 
struct ClientConfig {
 // System home directory.
 std::string homeDirectory;
 // File search path.
 std::string fileSearchPath;
 // If using semi mask in join.
 bool enableSemiMask;
 // If using zone map in scan.
 bool enableZoneMap;
 // Number of threads for execution.
 uint64_t numThreads;
 // Timeout (milliseconds).
 uint64_t timeoutInMS;
 // Variable length maximum depth.
 uint32_t varLengthMaxDepth;
 // If using progress bar.
 bool enableProgressBar;
 // time before displaying progress bar
 uint64_t showProgressAfter;
 // Semantic for recursive pattern, can be either WALK, TRAIL, ACYCLIC
 common::PathSemantic recursivePatternSemantic;
 // Scale factor for recursive pattern cardinality estimation.
 uint32_t recursivePatternCardinalityScaleFactor;
 bool disableMapKeyCheck;
};
 
struct ClientConfigDefault {
 // 0 means timeout is disabled by default.
 static constexpr uint64_t TIMEOUT_IN_MS = 0;
 static constexpr uint32_t VAR_LENGTH_MAX_DEPTH = 30;
 static constexpr bool ENABLE_SEMI_MASK = true;
 static constexpr bool ENABLE_ZONE_MAP = false;
 static constexpr bool ENABLE_PROGRESS_BAR = false;
 static constexpr uint64_t SHOW_PROGRESS_AFTER = 1000;
 static constexpr common::PathSemantic RECURSIVE_PATTERN_SEMANTIC = common::PathSemantic::WALK;
 static constexpr uint32_t RECURSIVE_PATTERN_FACTOR = 1;
 static constexpr bool DISABLE_MAP_KEY_CHECK = true;
};
 
} // namespace main
} // namespace kuzu