Lakeflow Declarative Pipelines Python language reference

This section has details for the Lakeflow Declarative Pipelines Python programming interface.

• For conceptual information and an overview of using Python for Lakeflow Declarative Pipelines, see Develop pipeline code with Python.
• For SQL reference, see the Lakeflow Declarative Pipelines SQL language reference.
• For details specific to configuring Auto Loader, see What is Auto Loader?.

dlt module overview

Lakeflow Declarative Pipelines Python functions are defined in the dlt module. Your pipelines implemented with the Python API must import this module:

import dlt

Functions for dataset definitions

Lakeflow Declarative Pipelines uses Python decorator for defining datasets such as materialized views and streaming tables. See Functions to define datasets.

API reference

• append_flow
• create_auto_cdc_flow
• create_auto_cdc_from_snapshot_flow
• create_sink
• create_streaming_table
• Expectations
• table
• view

Considerations for Python Lakeflow Declarative Pipelines

The following are important considerations when you implement pipelines with the Lakeflow Declarative Pipelines Python interface:

• Lakeflow Declarative Pipelines evaluates the code that defines a pipeline multiple times during planning and pipeline runs. Python functions that define datasets should include only the code required to define the table or view. Arbitrary Python logic included in dataset definitions might lead to unexpected behavior.
• Do not try to implement custom monitoring logic in your dataset definitions. See Define custom monitoring of Lakeflow Declarative Pipelines with event hooks.
• The function used to define a dataset must return a Spark DataFrame. Do not include logic in your dataset definitions that does not relate to a returned DataFrame.
• Never use methods that save or write to files or tables as part of your Lakeflow Declarative Pipelines dataset code.

Examples of Apache Spark operations that should never be used in Lakeflow Declarative Pipelines code:

• collect()
• count()
• toPandas()
• save()
• saveAsTable()
• start()
• toTable()