Skip to main content

create_streaming_table

Use the create_streaming_table() function to create a target table for records output by streaming operations, including apply_changes(), apply_changes_from_snapshot(), and @append_flow output records.

note

The create_target_table() and create_streaming_live_table() functions are deprecated. Databricks recommends updating existing code to use the create_streaming_table() function.

Syntax

Python
import dlt

dlt.create_streaming_table(
name = "<table-name>",
comment = "<comment>",
spark_conf={"<key>" : "<value", "<key" : "<value>"},
table_properties={"<key>" : "<value>", "<key>" : "<value>"},
path="<storage-location-path>",
partition_cols=["<partition-column>", "<partition-column>"],
cluster_by = ["<clustering-column>", "<clustering-column>"],
schema="schema-definition",
expect_all = {"<key>" : "<value", "<key" : "<value>"},
expect_all_or_drop = {"<key>" : "<value", "<key" : "<value>"},
expect_all_or_fail = {"<key>" : "<value", "<key" : "<value>"},
row_filter = "row-filter-clause"
)

Parameters

Parameter

Type

Description

name

str

Required. The table name.

comment

str

A description for the table.

spark_conf

dict

A list of Spark configurations for the execution of this query

table_properties

dict

A dict of table properties for the table.

path

str

A storage location for table data. If not set, use the managed storage location for the schema containing the table.

partition_cols

list

A list of one or more columns to use for partitioning the table.

cluster_by

list

Enable liquid clustering on the table and define the columns to use as clustering keys. See Use liquid clustering for Delta tables.

schema

str or StructType

A schema definition for the table. Schemas can be defined as a SQL DDL string or with a Python StructType.

expect_all, expect_all_or_drop, expect_all_or_fail

dict

Data quality constraints for the table. Provides the same behavior and uses the same syntax as expectation decorator functions, but implemented as a parameter. See Expectations.

row_filter

str

(Public Preview) A row filter clause for the table. See Publish tables with row filters and column masks.