On this page

Delta table (delta)

YAML location: an entry in a flowgroup’s actions list. Source selector: source.type: delta.

Reads a Delta table into a temporary view. Fields live under source:.

Minimal example

Add this entry to the actions list in your flowgroup.

- name: load_customers
  type: load
  source:
    type: delta
    catalog: "${catalog}"
    schema: "${bronze_schema}"
    table: customers
  readMode: batch
  target: v_customers

Source fields

Field

Type

Required

Default

Description

type

string

Yes

—

Must be delta.

catalog

string

Yes

—

Catalog of the source table.

schema

string

Yes

—

Schema of the source table.

table

string

Yes

—

Source table name.

options

mapping

No

—

Delta reader options (values must be non-empty). CDC and time-travel keys go here.

where_clause

list[string]

No

[]

Filter expressions applied with .where(...).

select_columns

list[string]

No

—

Column projection applied with .select(...).

readMode defaults to batch and accepts batch or stream. options.readChangeFeed: "true" requires readMode: stream, or a startingVersion/startingTimestamp bound in batch mode.

Read mode placement

Prefer action-level readMode alongside source and target. The generator also accepts source.readMode as a fallback. An action-level value takes precedence when both are supplied.

Action-level fields

These fields apply to every load sub-type. name, type, source and target are required.

Field

Type

Required

Default

Description

name

string

Yes

—

Unique action name within the flowgroup.

type

string

Yes

—

Always load.

source

mapping

Yes

—

Source configuration. source.type selects the sub-type. Use a mapping for every load type, including SQL.

target

string

Yes

—

Name of the temporary view this action creates.

readMode

string

No

sub-type

batch or stream; selects spark.read vs spark.readStream. Default and constraints vary by sub-type (below). Ignored by sql, python, and jdbc. The view this action creates is a stream or a batch view, and later actions in the flowgroup must read it the same way (LHP-VAL-070); see Read mode.

description

string

No

auto

Docstring for the generated view function.

operational_metadata

bool or list[string]

No

—

Explicit column names to add; action-level false disables inherited selection. true alone adds no columns. See Operational metadata.

depends_on

list[string]

No

—

Extra upstream table or view references added to the dependency graph. See Dependency analysis reference.

See the worked guide or choose another load source.