Skip to content

Query

deltalake.QueryBuilder

QueryBuilder()

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

qb = QueryBuilder()

execute

execute(sql: str) -> RecordBatchReader

Prepares the sql query to be executed.

For example:

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

register

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

Add a table to the query builder instance by name. The table_name will be how the referenced DeltaTable can be referenced in SQL queries.

For example:

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