méthode explain()

Consultez les plans d’exécution de DataStore avec la méthode explain()

La méthode explain() affiche le plan d’exécution d’une requête DataStore afin de vous aider à comprendre les opérations qui seront effectuées et le SQL qui sera généré.

​

Utilisation de base

from pathlib import Path
Path("sales.csv").write_text("""\
region,product,category,amount,quantity,price,date,order_id
East,Widget,Electronics,5200,10,120,2024-01-15,1001
West,Gadget,Electronics,800,5,160,2024-02-20,1002
East,Gizmo,Home,6500,3,100,2024-03-10,1003
North,Widget,Electronics,4500,6,150,2024-06-18,1004
West,Gadget,Electronics,2000,8,250,2024-09-14,1005
""")

from chdb import datastore as pd

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

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

# View execution plan
query.explain()

​

Syntaxe

explain(verbose=False) -> None

Paramètres :

Paramètre	Type	Valeur par défaut	Description
verbose	bool	False	Affiche des métadonnées supplémentaires

​

Format de sortie

​

Sortie standard

================================================================================
Execution Plan (in execution order)
================================================================================

 [1] 📊 Data Source: file('sales.csv', 'csv')

Operations:
────────────────────────────────────────────────────────────────────────────────
    ️  Segment 1 [chDB] (from source): Operations 2-5
    ️  Note: SQL operations after Pandas ops use Python() table function

 [2] 🚀 [chDB] WHERE: "amount" > 1000
 [3] 🚀 [chDB] GROUP BY: region
 [4] 🚀 [chDB] AGGREGATE: sum(amount), avg(amount)
 [5] 🚀 [chDB] ORDER BY: sum DESC

────────────────────────────────────────────────────────────────────────────────
Final State: 📊 Pending (lazy, not yet executed)
             └─> Will execute when print(), .to_df(), .execute() is called

────────────────────────────────────────────────────────────────────────────────
Generated SQL Query:
────────────────────────────────────────────────────────────────────────────────

SELECT region, SUM(amount) AS sum, AVG(amount) AS mean
FROM file('sales.csv', 'csv')
WHERE "amount" > 1000
GROUP BY region
ORDER BY sum DESC

================================================================================

​

Légende des icônes

Icône	Signification
📊	Source de données
🚀	Opération chDB (SQL)
🐼	Opération pandas

​

Sortie verbose

query.explain(verbose=True)

Le mode verbose affiche des détails supplémentaires pour chaque opération, y compris la requête SQL complète avec les mécanismes internes de suivi de l’ordre des lignes.

---

​

Trois phases d’exécution

La sortie d’EXPLAIN présente les opérations en trois phases :

​

Phase 1 : Construction de requêtes SQL (différée)

Opérations compilées en SQL :

  1. Source: file('sales.csv', 'CSVWithNames')
  2. Filter: amount > 1000      
  3. GroupBy: region
  4. Aggregate: sum(amount)

​

Phase 2 : Moment de l’exécution

Lorsqu’un déclencheur intervient :

  5. Execute SQL -> DataFrame
     Trigger: to_df() called

​

Phase 3 : opérations sur les DataFrames

Opérations après l’exécution :

  6. [pandas] pivot_table(...)
  7. [pandas] apply(custom_func)

---

​

Comprendre le plan d’exécution

​

Informations sur la source

Source: file('sales.csv', 'CSVWithNames')

• file() - fonction de table file() de ClickHouse
• 'CSVWithNames' - format de fichier avec en-tête

Autres types de sources :

Source: s3('bucket/data.parquet', ...)
Source: mysql('host', 'db', 'table', ...)
Source: __dataframe__  (pandas DataFrame input)

​

Opérations de filtrage

Filter: amount > 1000 AND status = 'active'

Affiche la clause WHERE qui sera appliquée.

​

GroupBy et agrégation

GroupBy: region, category
Aggregate: sum(amount), avg(amount), count(id)

Affiche les colonnes de GROUP BY et les fonctions d’agrégation.

​

Opérations de tri

Sort: sum DESC, region ASC

Affiche la clause ORDER BY.

​

Opérations LIMIT

Limit: 10
Offset: 100

Affiche LIMIT et OFFSET.

---

​

Informations sur le moteur

En mode verbose, vous pouvez voir quel moteur sera utilisé :

Filter: amount > 1000
  - Engine: chdb
  - Pushdown: Yes

Apply: custom_function
  - Engine: pandas
  - Pushdown: No

​

Pushdown

• Oui : l’opération sera exécutée directement dans la source de données (SQL)
• Non : l’opération nécessite une exécution dans pandas

---

​

Exemples

​

Requête simple

from pathlib import Path
Path("data.csv").write_text("""\
name,age,city,salary,department
Alice,25,NYC,55000,Engineering
Bob,30,LA,65000,Product
Charlie,35,NYC,80000,Engineering
Diana,28,SF,70000,Design
Eve,42,NYC,95000,Product
""")

ds = pd.read_csv("data.csv")
ds.filter(ds['age'] > 25).explain()

================================================================================
Execution Plan (in execution order)
================================================================================

 [1] 📊 Data Source: file('data.csv', 'csv')

Operations:
────────────────────────────────────────────────────────────────────────────────
    ️  Segment 1 [chDB] (from source): Operations 2-2

 [2] 🚀 [chDB] WHERE: "age" > 25

────────────────────────────────────────────────────────────────────────────────
Generated SQL Query:
────────────────────────────────────────────────────────────────────────────────

SELECT * FROM file('data.csv', 'csv') WHERE "age" > 25

================================================================================

​

Agrégation complexe

query = (ds
    .filter(ds['date'] >= '2024-01-01')
    .filter(ds['amount'] > 100)
    .select('region', 'category', 'amount')
    .groupby('region', 'category')
    .agg({
        'amount': ['sum', 'mean', 'count']
    })
    .sort('sum', ascending=False)
    .limit(20)
)
query.explain()

================================================================================
Execution Plan (in execution order)
================================================================================

 [1] 📊 Data Source: file('sales.csv', 'csv')

Operations:
────────────────────────────────────────────────────────────────────────────────
    ️  Segment 1 [chDB] (from source): Operations 2-8

 [2] 🚀 [chDB] WHERE: "date" >= '2024-01-01'
 [3] 🚀 [chDB] WHERE: "amount" > 100
 [4] 🚀 [chDB] SELECT: region, category, amount
 [5] 🚀 [chDB] GROUP BY: region, category
 [6] 🚀 [chDB] AGGREGATE: sum(amount), avg(amount), count(amount)
 [7] 🚀 [chDB] ORDER BY: sum DESC
 [8] 🚀 [chDB] LIMIT: 20

────────────────────────────────────────────────────────────────────────────────
Generated SQL Query:
────────────────────────────────────────────────────────────────────────────────

SELECT region, category, 
       SUM(amount) AS sum, 
       AVG(amount) AS mean, 
       COUNT(amount) AS count
FROM file('sales.csv', 'csv')
WHERE "date" >= '2024-01-01' AND "amount" > 100
GROUP BY region, category
ORDER BY sum DESC
LIMIT 20

================================================================================

​

SQL et pandas combinés

Lorsque les opérations ne peuvent pas être entièrement déléguées à SQL, le plan affiche plusieurs segments :

query = (ds
    .filter(ds['age'] > 25)           # SQL
    .groupby('city')                   # SQL
    .agg({'salary': 'mean'})           # SQL
    .apply(lambda x: x * 1.1)          # pandas (triggers segment split)
    .filter(ds['mean'] > 50000)        # SQL (new segment)
)
query.explain()

================================================================================
Execution Plan (in execution order)
================================================================================

 [1] 📊 Data Source: file('data.csv', 'csv')

Operations:
────────────────────────────────────────────────────────────────────────────────
    ️  Segment 1 [chDB] (from source): Operations 2-4
    ️  Segment 2 [Pandas] (on DataFrame): Operation 5
    ️  Segment 3 [chDB] (on DataFrame): Operation 6
    ️  Note: SQL operations after Pandas ops use Python() table function

 [2] 🚀 [chDB] WHERE: "age" > 25
 [3] 🚀 [chDB] GROUP BY: city
 [4] 🚀 [chDB] AGGREGATE: avg(salary)
 [5] 🐼 [Pandas] APPLY: lambda
 [6] 🚀 [chDB] WHERE: "mean" > 50000

================================================================================

---

​

Débogage avec explain()

​

Vérifier la logique de filtrage

# Verify your filter is correct
query = ds.filter((ds['age'] > 25) & (ds['city'] == 'NYC'))
query.explain()
# Output shows: Filter: age > 25 AND city = 'NYC'

​

Vérifier la sélection des colonnes

# Check column pruning
query = ds.select('name', 'age').filter(ds['age'] > 25)
query.explain()
# Output shows: SELECT name, age FROM ... WHERE age > 25

​

Comprendre l’agrégation

# Check aggregation functions
query = ds.groupby('dept').agg({'salary': ['sum', 'mean', 'std']})
query.explain()
# Output shows: SELECT dept, SUM(salary), AVG(salary), stddevPop(salary)

---

​

Bonnes pratiques

​

1. Vérifiez avant d’exécuter des requêtes volumineuses

# Always explain first for large data
query = ds.complex_pipeline()
query.explain()  # Check plan

# If plan looks correct
result = query.to_df()  # Execute

​

2. Utilisez Verbose pour le débogage

# When something seems wrong
query.explain(verbose=True)
# Shows engine selection and pushdown info

​

3. Comparer avec to_sql()

# explain() shows the plan
query.explain()

# to_sql() shows just the SQL
print(query.to_sql())

# Both useful for different purposes

​

4. Vérifier l’état du pushdown

# Verbose mode shows if operations are pushed down
query.explain(verbose=True)

# If Pushdown: No, operation runs in pandas
# Consider restructuring query for better performance