Query

deltalake.QueryBuilder

QueryBuilder(session_config: dict[str, str] | None = None)

QueryBuilder is an API which exposes Apache DataFusion SQL to Python users of the deltalake library.

qb = QueryBuilder()

Create a QueryBuilder, optionally overriding the DataFusion session config.

Example

from deltalake import QueryBuilder
qb = QueryBuilder({"datafusion.execution.batch_size": "1024"})

Parameters:

Name	Type	Description	Default
session_config	dict[str, str] | None	DataFusion configuration settings applied on top of the defaults deltalake tunes for Delta tables.	None

execute

execute(sql: str) -> RecordBatchReader

Prepares the sql query to be executed.

Example

from deltalake import DeltaTable, QueryBuilder
dt = DeltaTable("my_table")
data = QueryBuilder().register('test', dt).execute("select * from test").read_all()

register

register(table_name: str, delta_table: DeltaTable) -> QueryBuilder

Add a table to the query builder instance by name. Table DeltaTable is available in SQL queries as table_name.

Example

from deltalake import DeltaTable, QueryBuilder
dt = DeltaTable("my_table")
qb = QueryBuilder().register('test', dt)