DataStore の設定 - ClickHouse Documentation

DataStore では、実行エンジンの選択、互換性モード、ログ、キャッシュ、プロファイリング、Dtype correction に関する包括的な設定オプションを利用できます。

クイックリファレンス

from chdb.datastore.config import config

# Quick setup presets
config.enable_debug()           # Enable verbose logging
config.use_chdb()               # Force ClickHouse engine
config.use_pandas()             # Force pandas engine
config.use_auto()               # Auto-select engine (default)
config.use_performance_mode()   # SQL-first, max throughput
config.use_pandas_compat()      # Full pandas compatibility (default)
config.enable_profiling()       # Enable performance profiling

すべての設定オプション

カテゴリ	オプション	値	デフォルト	説明
ロギング	`log_level`	DEBUG/INFO/WARNING/ERROR	WARNING	ログの詳細レベル
	`log_format`	”simple”, “verbose"	"simple”	ログメッセージのフォーマット
cache	`cache_enabled`	True/False	True	結果のcacheを有効化
	`cache_ttl`	float (seconds)	0.0	cacheの有効期限 (TTL)
エンジン	`execution_engine`	”auto”, “chdb”, “pandas"	"auto”	実行エンジン
	`cross_datastore_engine`	”auto”, “chdb”, “pandas"	"auto”	Cross-DataStore 操作
互換性	`compat_mode`	”pandas”, “performance"	"pandas”	pandas 互換性と SQL 優先のスループット
プロファイリング	`profiling_enabled`	True/False	False	プロファイリングを有効化
Dtype	`correction_level`	NONE/CRITICAL/HIGH/MEDIUM/ALL	HIGH	Dtype 補正レベル

設定方法

ロギング設定

from chdb.datastore.config import config
import logging

# Set log level
config.set_log_level(logging.DEBUG)
config.set_log_level(logging.INFO)
config.set_log_level(logging.WARNING)  # Default
config.set_log_level(logging.ERROR)

# Set log format
config.set_log_format("simple")   # Default
config.set_log_format("verbose")  # More details

# Quick enable debug mode
config.enable_debug()  # Sets DEBUG level + verbose format

詳細についてはロギングを参照してください。

cache の設定

# Enable/disable caching
config.set_cache_enabled(True)   # Default
config.set_cache_enabled(False)  # Disable caching

# Set cache TTL (time-to-live)
config.set_cache_ttl(60.0)  # Cache expires after 60 seconds
config.set_cache_ttl(0.0)   # No expiration (default)

# Check current settings
print(config.cache_enabled)
print(config.cache_ttl)

エンジン設定

# Set execution engine
config.set_execution_engine('auto')    # Auto-select (default)
config.set_execution_engine('chdb')    # Force ClickHouse
config.set_execution_engine('pandas')  # Force pandas

# Quick presets
config.use_auto()     # Auto-select
config.use_chdb()     # Force ClickHouse
config.use_pandas()   # Force pandas

# Cross-DataStore engine (for operations between different DataStores)
config.set_cross_datastore_engine('auto')
config.set_cross_datastore_engine('chdb')
config.set_cross_datastore_engine('pandas')

# Check current engine
print(config.execution_engine)

詳細については、実行エンジンを参照してください。

互換性モード

# Performance mode: SQL-first, no pandas compatibility overhead
config.use_performance_mode()
# or: config.set_compat_mode('performance')

# Pandas compatibility mode (default)
config.use_pandas_compat()
# or: config.set_compat_mode('pandas')

# Check current mode
print(config.compat_mode)  # 'pandas' or 'performance'

詳しくは、パフォーマンスモードを参照してください。

プロファイリング設定

# Enable profiling
config.enable_profiling()
config.set_profiling_enabled(True)

# Disable profiling
config.set_profiling_enabled(False)

# Check if profiling is enabled
print(config.profiling_enabled)

詳細については、プロファイリングを参照してください。

Dtype補正

from chdb.datastore.dtype_correction.config import CorrectionLevel

# Set correction level
config.set_correction_level(CorrectionLevel.NONE)      # No correction
config.set_correction_level(CorrectionLevel.CRITICAL)  # Critical types only
config.set_correction_level(CorrectionLevel.HIGH)      # Default
config.set_correction_level(CorrectionLevel.MEDIUM)    # More corrections
config.set_correction_level(CorrectionLevel.ALL)       # All corrections

`config` オブジェクトの使用

config オブジェクトは、すべての設定を管理するシングルトンです：

from chdb.datastore.config import config

# Read settings
print(config.log_level)
print(config.execution_engine)
print(config.cache_enabled)
print(config.profiling_enabled)

# Modify settings
config.set_log_level(logging.DEBUG)
config.set_execution_engine('chdb')
config.set_cache_enabled(False)
config.enable_profiling()

コードによる設定

スクリプトごとの設定

from chdb import datastore as pd
from chdb.datastore.config import config

# Configure at script start
config.enable_debug()
config.use_chdb()
config.enable_profiling()

# Your DataStore code
ds = pd.read_csv("data.csv")
result = ds.filter(ds['age'] > 25).groupby('city').agg({'salary': 'mean'})

コンテキストマネージャー (今後対応予定)

# Planned feature: temporary configuration
with config.override(execution_engine='pandas'):
    result = ds.process()
# Original settings restored

一般的な設定パターン

開発/デバッグ

from chdb.datastore.config import config

config.enable_debug()        # Verbose logging
config.enable_profiling()    # Performance tracking
config.set_cache_enabled(False)  # Disable caching for fresh results

本番環境

from chdb.datastore.config import config
import logging

config.set_log_level(logging.WARNING)  # Minimal logging
config.set_execution_engine('auto')    # Optimal engine selection
config.set_cache_enabled(True)         # Enable caching
config.set_profiling_enabled(False)    # Disable profiling overhead

最大スループット

from chdb.datastore.config import config

config.use_performance_mode()    # SQL-first, no pandas overhead
config.set_cache_enabled(False)  # Disable cache for streaming

パフォーマンステスト

from chdb.datastore.config import config

config.use_chdb()            # Force ClickHouse for benchmarks
config.enable_profiling()    # Track performance
config.set_cache_enabled(False)  # Disable cache for accurate timing

Pandas互換性の検証

from chdb.datastore.config import config

config.use_pandas()          # Force pandas engine
config.enable_debug()        # See what operations are used

実行エンジン - エンジン選択の詳細
パフォーマンスモード - 最大スループットを実現する SQL 優先モード
関数設定 - 関数ごとのエンジン設定
ロギング - ロギング設定
プロファイリング - パフォーマンスプロファイリング

​クイックリファレンス

​すべての設定オプション

​設定方法

​ロギング設定

​cache の設定

​エンジン設定

​互換性モード

​プロファイリング設定

​Dtype補正

​config オブジェクトの使用

​コードによる設定

​スクリプトごとの設定

​コンテキストマネージャー (今後対応予定)

​一般的な設定パターン

​開発/デバッグ

​本番環境

​最大スループット

​パフォーマンステスト

​Pandas互換性の検証

​関連ドキュメント