Depuração do DataStore - ClickHouse Documentation

O DataStore oferece um conjunto abrangente de ferramentas de depuração para entender e otimizar seus pipelines de dados.

Visão geral das ferramentas de depuração

Ferramenta	Finalidade	Quando usar
`explain()`	Ver o plano de execução	Entender qual SQL será executado
Profiler	Medir o desempenho	Encontrar operações lentas
Logging	Ver detalhes da execução	Depurar comportamentos inesperados

Matriz de decisão rápida

Necessidade	Ferramenta	Comando
Ver o plano de execução	`explain()`	`ds.explain()`
Medir o desempenho	Profiler	`config.enable_profiling()`
Depurar consultas SQL	Logging	`config.enable_debug()`
Tudo isso	Combinação	Veja abaixo

Configuração rápida

Habilitar toda a depuração

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

# Enable all debugging
config.enable_debug()        # Verbose logging
config.enable_profiling()    # Performance tracking

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

# View execution plan
result.explain()

# Get profiler report
from chdb.datastore.config import get_profiler
profiler = get_profiler()
profiler.report()

Método `explain()`

Veja o plano de execução antes de executar uma consulta.

Query

ds = pd.read_csv("data.csv")

query = (ds
    .filter(ds['amount'] > 1000)
    .groupby('region')
    .agg({'amount': ['sum', 'mean']})
)

# View plan
query.explain()

Response

Pipeline:
  Source: file('data.csv', 'CSVWithNames')
  Filter: amount > 1000
  GroupBy: region
  Aggregate: sum(amount), avg(amount)

Generated SQL:
SELECT region, SUM(amount) AS sum, AVG(amount) AS mean
FROM file('data.csv', 'CSVWithNames')
WHERE amount > 1000
GROUP BY region

Consulte a documentação do explain() para mais detalhes.

Profiling

Meça o tempo de execução de cada operação.

Query

from chdb.datastore.config import config, get_profiler

# Enable profiling
config.enable_profiling()

# Run operations
ds = pd.read_csv("large_data.csv")
result = (ds
    .filter(ds['amount'] > 100)
    .groupby('category')
    .agg({'amount': 'sum'})
    .sort('sum', ascending=False)
    .head(10)
    .to_df()
)

# View report
profiler = get_profiler()
profiler.report(min_duration_ms=0.1)

Response

Performance Report
==================
Step                          Duration    Calls
----                          --------    -----
read_csv                      1.234s      1
filter                        0.002s      1
groupby                       0.001s      1
agg                           0.089s      1
sort                          0.045s      1
head                          0.001s      1
to_df (SQL execution)         0.567s      1
----                          --------    -----
Total                         1.939s      7

Consulte o Guia de profiling para mais detalhes.

Logging

Veja logs detalhados de execução.

from chdb.datastore.config import config

# Enable debug logging
config.enable_debug()

# Run operations - logs will show:
# - SQL queries generated
# - Execution engine used
# - Cache hits/misses
# - Timing information

Exemplo de saída de log:

DEBUG - DataStore: Creating from file 'data.csv'
DEBUG - Query: SELECT region, SUM(amount) FROM ... WHERE amount > 1000 GROUP BY region
DEBUG - Engine: Using chdb for aggregation
DEBUG - Execution time: 0.089s
DEBUG - Cache: Storing result (key: abc123)

Consulte Configuração de logging para detalhes.

Cenários comuns de depuração

1. Consulta não retorna os resultados esperados

# Step 1: View the execution plan
query = ds.filter(ds['age'] > 25).groupby('city').sum()
query.explain(verbose=True)

# Step 2: Enable logging to see SQL
config.enable_debug()

# Step 3: Run and check logs
result = query.to_df()

2. Consulta lenta

# Step 1: Enable profiling
config.enable_profiling()

# Step 2: Run your query
result = process_data()

# Step 3: Check profiler report
profiler = get_profiler()
profiler.report()

# Step 4: Identify slow operations and optimize

3. Entendendo a escolha da engine

# Enable verbose logging
config.enable_debug()

# Run operations
result = ds.filter(ds['x'] > 10).apply(custom_func)

# Logs will show which engine was used for each operation:
# DEBUG - filter: Using chdb engine
# DEBUG - apply: Using pandas engine (custom function)

4. Depuração de problemas de cache

# Enable debug to see cache operations
config.enable_debug()

# First run
result1 = ds.filter(ds['x'] > 10).to_df()
# LOG: Cache miss, executing query

# Second run (should use cache)
result2 = ds.filter(ds['x'] > 10).to_df()
# LOG: Cache hit, returning cached result

# If not caching when expected, check:
# - Are operations identical?
# - Is cache enabled? config.cache_enabled

Boas práticas

1. Faça a depuração em Development, não em produção

# Development
config.enable_debug()
config.enable_profiling()

# Production
config.set_log_level(logging.WARNING)
config.set_profiling_enabled(False)

2. Use explain() antes de executar consultas grandes

# Build query
query = ds.filter(...).groupby(...).agg(...)

# Check plan first
query.explain()

# If plan looks good, execute
result = query.to_df()

3. Analise o desempenho antes de otimizar

# Don't guess what's slow - measure it
config.enable_profiling()
result = your_pipeline()
get_profiler().report()

4. Verifique o SQL quando os resultados estiverem incorretos

# View generated SQL
print(query.to_sql())

# Compare with expected SQL
# Run SQL directly in ClickHouse to verify

Resumo das ferramentas de depuração

Ferramenta	Comando	Saída
Explicar plano de execução	`ds.explain()`	Etapas de execução + SQL
Explicação detalhada	`ds.explain(verbose=True)`	+ metadados
Visualizar SQL	`ds.to_sql()`	String da consulta SQL
Ativar debug	`config.enable_debug()`	Logs detalhados
Ativar profiling	`config.enable_profiling()`	Dados de temporização
Relatório do Profiler	`get_profiler().report()`	Resumo de desempenho
Limpar Profiler	`get_profiler().reset()`	Limpa os dados de temporização

Próximos passos

Método explain() - Documentação detalhada do plano de execução
Guia de profiling - Medição de desempenho
Configuração de logging - Configuração de nível de log e formato

​Visão geral das ferramentas de depuração

​Matriz de decisão rápida

​Configuração rápida

​Habilitar toda a depuração

​Método explain()

​Profiling

​Logging

​Cenários comuns de depuração

​1. Consulta não retorna os resultados esperados

​2. Consulta lenta

​3. Entendendo a escolha da engine

​4. Depuração de problemas de cache

​Boas práticas

​1. Faça a depuração em Development, não em produção

​2. Use explain() antes de executar consultas grandes

​3. Analise o desempenho antes de otimizar

​4. Verifique o SQL quando os resultados estiverem incorretos

​Resumo das ferramentas de depuração

​Próximos passos