Skip to content

Pipeline

laktory.models.resources.databricks.Pipeline ¤

Bases: PipelineBase

Databricks Lakeflow Declarative Pipeline (formerly Delta Live Tables)

Examples:

Assuming the configuration yaml file

import io

from laktory import models

# Define pipeline
pipeline_yaml = '''
name: pl-stock-prices

catalog: dev
schema: finance

clusters:
  - node_type_id: Standard_DS3_v2
    autoscale:
      min_workers: 1
      max_workers: 2

libraries:
  - notebook:
      path: /pipelines/laktory_dlp.py
  - notebook:
      path: /pipelines/dlt_gld_stock_performances.py

access_controls:
  - group_name: account users
    permission_level: CAN_VIEW
  - group_name: role-engineers
    permission_level: CAN_RUN

'''
pipeline = models.resources.databricks.Pipeline.model_validate_yaml(
    io.StringIO(pipeline_yaml)
)
References
BASE DESCRIPTION
allow_duplicate_names

Optional boolean flag. If false, deployment will fail if name conflicts with that of another pipeline. default is false

TYPE: bool | None | VariableType DEFAULT: None

budget_policy_id

optional string specifying ID of the budget policy for this Lakeflow Declarative Pipeline

TYPE: str | None | VariableType DEFAULT: None

catalog

The UC catalog the event log is published under

TYPE: str | None | VariableType DEFAULT: None

cause

TYPE: str | None | VariableType DEFAULT: None

channel

optional name of the release channel for Spark version used by Lakeflow Declarative Pipeline. Supported values are: CURRENT (default) and PREVIEW

TYPE: str | None | VariableType DEFAULT: None

cluster

TYPE: list[PipelineCluster] | None | VariableType DEFAULT: None

cluster_id

TYPE: str | None | VariableType DEFAULT: None

configuration

An optional list of values to apply to the entire pipeline. Elements must be formatted as key:value pairs. * library blocks - Specifies pipeline code

TYPE: dict[str, str] | None | VariableType DEFAULT: None

continuous

A flag indicating whether to run the pipeline continuously. The default value is false

TYPE: bool | None | VariableType DEFAULT: None

creator_user_name

TYPE: str | None | VariableType DEFAULT: None

deployment

Deployment type of this pipeline. Supports following attributes:

TYPE: PipelineDeployment | None | VariableType DEFAULT: None

development

A flag indicating whether to run the pipeline in development mode. The default value is false

TYPE: bool | None | VariableType DEFAULT: None

edition

optional name of the product edition. Supported values are: CORE, PRO, ADVANCED (default). Not required when serverless is set to true

TYPE: str | None | VariableType DEFAULT: None

environment

TYPE: PipelineEnvironment | None | VariableType DEFAULT: None

event_log

an optional block specifying a table where LDP Event Log will be stored. Consists of the following fields:

TYPE: PipelineEventLog | None | VariableType DEFAULT: None

expected_last_modified

TYPE: int | None | VariableType DEFAULT: None

filters

Filters on which Pipeline packages to include in the deployed graph. This block consists of following attributes:

TYPE: PipelineFilters | None | VariableType DEFAULT: None

gateway_definition

The definition of a gateway pipeline to support CDC. Consists of following attributes:

TYPE: PipelineGatewayDefinition | None | VariableType DEFAULT: None

health

TYPE: str | None | VariableType DEFAULT: None

ingestion_definition

TYPE: PipelineIngestionDefinition | None | VariableType DEFAULT: None

last_modified

TYPE: int | None | VariableType DEFAULT: None

latest_updates

TYPE: list[PipelineLatestUpdates] | None | VariableType DEFAULT: None

library

TYPE: list[PipelineLibrary] | None | VariableType DEFAULT: None

name

The table name the event log is published to in UC

TYPE: str | None | VariableType DEFAULT: None

notification

TYPE: list[PipelineNotification] | None | VariableType DEFAULT: None

photon

A flag indicating whether to use Photon engine. The default value is false

TYPE: bool | None | VariableType DEFAULT: None

restart_window

TYPE: PipelineRestartWindow | None | VariableType DEFAULT: None

root_path

An optional string specifying the root path for this pipeline. This is used as the root directory when editing the pipeline in the Databricks user interface and it is added to sys.path when executing Python sources during pipeline execution. * cluster blocks - Clusters to run the pipeline. If none is specified, pipelines will automatically select a default cluster configuration for the pipeline. Please note that Lakeflow Declarative Pipeline clusters are supporting only subset of attributes as described in documentation. Also, note that autoscale block is extended with the mode parameter that controls the autoscaling algorithm (possible values are ENHANCED for new, enhanced autoscaling algorithm, or LEGACY for old algorithm)

TYPE: str | None | VariableType DEFAULT: None

run_as

The user or the service principal the pipeline runs as. See run_as Configuration Block below

TYPE: PipelineRunAs | None | VariableType DEFAULT: None

run_as_user_name

TYPE: str | None | VariableType DEFAULT: None

schema_

The UC schema the event log is published under

TYPE: str | None | VariableType DEFAULT: None

serverless

An optional flag indicating if serverless compute should be used for this Lakeflow Declarative Pipeline. Requires catalog to be set, as it could be used only with Unity Catalog

TYPE: bool | None | VariableType DEFAULT: None

state

TYPE: str | None | VariableType DEFAULT: None

storage

A location on cloud storage where output data and metadata required for pipeline execution are stored. By default, tables are stored in a subdirectory of this location. Change of this parameter forces recreation of the pipeline. (Conflicts with catalog)

TYPE: str | None | VariableType DEFAULT: None

tags

A map of tags associated with the pipeline. These are forwarded to the cluster as cluster tags, and are therefore subject to the same limitations. A maximum of 25 tags can be added to the pipeline

TYPE: dict[str, str] | None | VariableType DEFAULT: None

target

The name of a database (in either the Hive metastore or in a UC catalog) for persisting pipeline output data. Configuring the target setting allows you to view and query the pipeline output data from the Databricks UI

TYPE: str | None | VariableType DEFAULT: None

timeouts

TYPE: PipelineTimeouts | None | VariableType DEFAULT: None

trigger

TYPE: PipelineTrigger | None | VariableType DEFAULT: None

url

URL of the Lakeflow Declarative Pipeline on the given workspace

TYPE: str | None | VariableType DEFAULT: None

usage_policy_id

TYPE: str | None | VariableType DEFAULT: None

LAKTORY DESCRIPTION
access_controls

Pipeline access controls

TYPE: list[AccessControl | VariableType] | VariableType DEFAULT: []

name_prefix

Prefix added to the DLP name

TYPE: str | VariableType DEFAULT: None

name_suffix

Suffix added to the DLP name

TYPE: str | VariableType DEFAULT: None

ATTRIBUTE DESCRIPTION
additional_core_resources
  • permissions

TYPE: list

additional_core_resources property ¤

  • permissions

laktory.models.resources.databricks.pipeline.PipelineCluster ¤

Bases: BaseModel

PARAMETER DESCRIPTION
apply_policy_default_values

TYPE: bool | None | VariableType DEFAULT: None

autoscale

TYPE: PipelineClusterAutoscale | None | VariableType DEFAULT: None

aws_attributes

TYPE: PipelineClusterAwsAttributes | None | VariableType DEFAULT: None

azure_attributes

TYPE: PipelineClusterAzureAttributes | None | VariableType DEFAULT: None

cluster_log_conf

TYPE: PipelineClusterClusterLogConf | None | VariableType DEFAULT: None

custom_tags

TYPE: dict[str, str] | None | VariableType DEFAULT: None

driver_instance_pool_id

TYPE: str | None | VariableType DEFAULT: None

driver_node_type_id

TYPE: str | None | VariableType DEFAULT: None

enable_local_disk_encryption

TYPE: bool | None | VariableType DEFAULT: None

gcp_attributes

TYPE: PipelineClusterGcpAttributes | None | VariableType DEFAULT: None

init_scripts

TYPE: list[PipelineClusterInitScripts] | None | VariableType DEFAULT: None

instance_pool_id

TYPE: str | None | VariableType DEFAULT: None

label

TYPE: str | None | VariableType DEFAULT: None

node_type_id

TYPE: str | None | VariableType DEFAULT: None

num_workers

TYPE: int | None | VariableType DEFAULT: None

policy_id

TYPE: str | None | VariableType DEFAULT: None

spark_conf

TYPE: dict[str, str] | None | VariableType DEFAULT: None

spark_env_vars

TYPE: dict[str, str] | None | VariableType DEFAULT: None

ssh_public_keys

TYPE: list[str] | None | VariableType DEFAULT: None


laktory.models.resources.databricks.pipeline.PipelineClusterAutoscale ¤

Bases: BaseModel

PARAMETER DESCRIPTION
max_workers

TYPE: int | VariableType

min_workers

TYPE: int | VariableType

mode

TYPE: str | None | VariableType DEFAULT: None


laktory.models.resources.databricks.pipeline.PipelineClusterAwsAttributes ¤

Bases: BaseModel

PARAMETER DESCRIPTION
availability

TYPE: str | None | VariableType DEFAULT: None

ebs_volume_count

TYPE: int | None | VariableType DEFAULT: None

ebs_volume_iops

TYPE: int | None | VariableType DEFAULT: None

ebs_volume_size

TYPE: int | None | VariableType DEFAULT: None

ebs_volume_throughput

TYPE: int | None | VariableType DEFAULT: None

ebs_volume_type

TYPE: str | None | VariableType DEFAULT: None

first_on_demand

TYPE: int | None | VariableType DEFAULT: None

instance_profile_arn

TYPE: str | None | VariableType DEFAULT: None

spot_bid_price_percent

TYPE: int | None | VariableType DEFAULT: None

zone_id

TYPE: str | None | VariableType DEFAULT: None


laktory.models.resources.databricks.pipeline.PipelineClusterAzureAttributes ¤

Bases: BaseModel

PARAMETER DESCRIPTION
availability

TYPE: str | None | VariableType DEFAULT: None

first_on_demand

TYPE: int | None | VariableType DEFAULT: None

log_analytics_info

TYPE: PipelineClusterAzureAttributesLogAnalyticsInfo | None | VariableType DEFAULT: None

spot_bid_max_price

TYPE: float | None | VariableType DEFAULT: None


laktory.models.resources.databricks.pipeline.PipelineClusterAzureAttributesLogAnalyticsInfo ¤

Bases: BaseModel

PARAMETER DESCRIPTION
log_analytics_primary_key

TYPE: str | None | VariableType DEFAULT: None

log_analytics_workspace_id

TYPE: str | None | VariableType DEFAULT: None


laktory.models.resources.databricks.pipeline.PipelineClusterClusterLogConf ¤

Bases: BaseModel

PARAMETER DESCRIPTION
dbfs

TYPE: PipelineClusterClusterLogConfDbfs | None | VariableType DEFAULT: None

s3

TYPE: PipelineClusterClusterLogConfS3 | None | VariableType DEFAULT: None

volumes

TYPE: PipelineClusterClusterLogConfVolumes | None | VariableType DEFAULT: None


laktory.models.resources.databricks.pipeline.PipelineClusterClusterLogConfDbfs ¤

Bases: BaseModel

PARAMETER DESCRIPTION
destination

TYPE: str | VariableType


laktory.models.resources.databricks.pipeline.PipelineClusterClusterLogConfS3 ¤

Bases: BaseModel

PARAMETER DESCRIPTION
canned_acl

TYPE: str | None | VariableType DEFAULT: None

destination

TYPE: str | VariableType

enable_encryption

TYPE: bool | None | VariableType DEFAULT: None

encryption_type

TYPE: str | None | VariableType DEFAULT: None

endpoint

TYPE: str | None | VariableType DEFAULT: None

kms_key

TYPE: str | None | VariableType DEFAULT: None

region

TYPE: str | None | VariableType DEFAULT: None


laktory.models.resources.databricks.pipeline.PipelineClusterClusterLogConfVolumes ¤

Bases: BaseModel

PARAMETER DESCRIPTION
destination

TYPE: str | VariableType


laktory.models.resources.databricks.pipeline.PipelineClusterGcpAttributes ¤

Bases: BaseModel

PARAMETER DESCRIPTION
availability

TYPE: str | None | VariableType DEFAULT: None

confidential_compute_type

TYPE: str | None | VariableType DEFAULT: None

first_on_demand

TYPE: int | None | VariableType DEFAULT: None

google_service_account

TYPE: str | None | VariableType DEFAULT: None

local_ssd_count

TYPE: int | None | VariableType DEFAULT: None

zone_id

TYPE: str | None | VariableType DEFAULT: None


laktory.models.resources.databricks.pipeline.PipelineClusterInitScripts ¤

Bases: BaseModel

PARAMETER DESCRIPTION
abfss

TYPE: PipelineClusterInitScriptsAbfss | None | VariableType DEFAULT: None

dbfs

TYPE: PipelineClusterInitScriptsDbfs | None | VariableType DEFAULT: None

file

specifies path to a file in Databricks Workspace to include as source. Actual path is specified as path attribute inside the block

TYPE: PipelineClusterInitScriptsFile | None | VariableType DEFAULT: None

gcs

TYPE: PipelineClusterInitScriptsGcs | None | VariableType DEFAULT: None

s3

TYPE: PipelineClusterInitScriptsS3 | None | VariableType DEFAULT: None

volumes

TYPE: PipelineClusterInitScriptsVolumes | None | VariableType DEFAULT: None

workspace

TYPE: PipelineClusterInitScriptsWorkspace | None | VariableType DEFAULT: None


laktory.models.resources.databricks.pipeline.PipelineClusterInitScriptsAbfss ¤

Bases: BaseModel

PARAMETER DESCRIPTION
destination

TYPE: str | VariableType


laktory.models.resources.databricks.pipeline.PipelineClusterInitScriptsDbfs ¤

Bases: BaseModel

PARAMETER DESCRIPTION
destination

TYPE: str | VariableType


laktory.models.resources.databricks.pipeline.PipelineClusterInitScriptsFile ¤

Bases: BaseModel

PARAMETER DESCRIPTION
destination

TYPE: str | VariableType


laktory.models.resources.databricks.pipeline.PipelineClusterInitScriptsGcs ¤

Bases: BaseModel

PARAMETER DESCRIPTION
destination

TYPE: str | VariableType


laktory.models.resources.databricks.pipeline.PipelineClusterInitScriptsS3 ¤

Bases: BaseModel

PARAMETER DESCRIPTION
canned_acl

TYPE: str | None | VariableType DEFAULT: None

destination

TYPE: str | VariableType

enable_encryption

TYPE: bool | None | VariableType DEFAULT: None

encryption_type

TYPE: str | None | VariableType DEFAULT: None

endpoint

TYPE: str | None | VariableType DEFAULT: None

kms_key

TYPE: str | None | VariableType DEFAULT: None

region

TYPE: str | None | VariableType DEFAULT: None


laktory.models.resources.databricks.pipeline.PipelineClusterInitScriptsVolumes ¤

Bases: BaseModel

PARAMETER DESCRIPTION
destination

TYPE: str | VariableType


laktory.models.resources.databricks.pipeline.PipelineClusterInitScriptsWorkspace ¤

Bases: BaseModel

PARAMETER DESCRIPTION
destination

TYPE: str | VariableType


laktory.models.resources.databricks.pipeline.PipelineDeployment ¤

Bases: BaseModel

PARAMETER DESCRIPTION
deployment_id

TYPE: str | None | VariableType DEFAULT: None

kind

The deployment method that manages the pipeline

TYPE: str | VariableType

metadata_file_path

The path to the file containing metadata about the deployment

TYPE: str | None | VariableType DEFAULT: None

version_id

TYPE: str | None | VariableType DEFAULT: None


laktory.models.resources.databricks.pipeline.PipelineEnvironment ¤

Bases: BaseModel

PARAMETER DESCRIPTION
dependencies

a list of pip dependencies, as supported by the version of pip in this environment. Each dependency is a pip requirement file line. See API docs for more information

TYPE: list[str] | None | VariableType DEFAULT: None

environment_version

TYPE: str | None | VariableType DEFAULT: None


laktory.models.resources.databricks.pipeline.PipelineEventLog ¤

Bases: BaseModel

PARAMETER DESCRIPTION
catalog

The UC catalog the event log is published under

TYPE: str | None | VariableType DEFAULT: None

name

The table name the event log is published to in UC

TYPE: str | VariableType

schema_

The UC schema the event log is published under

TYPE: str | None | VariableType DEFAULT: None


laktory.models.resources.databricks.pipeline.PipelineFilters ¤

Bases: BaseModel

PARAMETER DESCRIPTION
exclude

Paths to exclude

TYPE: list[str] | None | VariableType DEFAULT: None

include

Paths to include

TYPE: list[str] | None | VariableType DEFAULT: None


laktory.models.resources.databricks.pipeline.PipelineGatewayDefinition ¤

Bases: BaseModel

PARAMETER DESCRIPTION
connection_id

Deprecated, Immutable. The Unity Catalog connection this gateway pipeline uses to communicate with the source. Use connection_name instead!

TYPE: str | None | VariableType DEFAULT: None

connection_name

Immutable. The Unity Catalog connection this ingestion pipeline uses to communicate with the source. Specify either ingestion_gateway_id or connection_name

TYPE: str | VariableType

connection_parameters

TYPE: PipelineGatewayDefinitionConnectionParameters | None | VariableType DEFAULT: None

gateway_storage_catalog

Required, Immutable. The name of the catalog for the gateway pipeline's storage location

TYPE: str | VariableType

gateway_storage_name

Required. The Unity Catalog-compatible naming for the gateway storage location. This is the destination to use for the data that is extracted by the gateway. Lakeflow Declarative Pipelines system will automatically create the storage location under the catalog and schema

TYPE: str | None | VariableType DEFAULT: None

gateway_storage_schema

Required, Immutable. The name of the schema for the gateway pipelines's storage location

TYPE: str | VariableType


laktory.models.resources.databricks.pipeline.PipelineGatewayDefinitionConnectionParameters ¤

Bases: BaseModel

PARAMETER DESCRIPTION
source_catalog

TYPE: str | None | VariableType DEFAULT: None


laktory.models.resources.databricks.pipeline.PipelineIngestionDefinition ¤

Bases: BaseModel

PARAMETER DESCRIPTION
connection_name

Immutable. The Unity Catalog connection this ingestion pipeline uses to communicate with the source. Specify either ingestion_gateway_id or connection_name

TYPE: str | None | VariableType DEFAULT: None

connector_type

TYPE: str | None | VariableType DEFAULT: None

data_staging_options

TYPE: PipelineIngestionDefinitionDataStagingOptions | None | VariableType DEFAULT: None

full_refresh_window

TYPE: PipelineIngestionDefinitionFullRefreshWindow | None | VariableType DEFAULT: None

ingest_from_uc_foreign_catalog

TYPE: bool | None | VariableType DEFAULT: None

ingestion_gateway_id

Immutable. Identifier for the ingestion gateway used by this ingestion pipeline to communicate with the source. Specify either ingestion_gateway_id or connection_name

TYPE: str | None | VariableType DEFAULT: None

netsuite_jar_path

TYPE: str | None | VariableType DEFAULT: None

objects

Required. Settings specifying tables to replicate and the destination for the replicated tables

TYPE: list[PipelineIngestionDefinitionObjects] | None | VariableType DEFAULT: None

source_configurations

Array of objects describing top-level source configurations. See the REST API docs for reference

TYPE: list[PipelineIngestionDefinitionSourceConfigurations] | None | VariableType DEFAULT: None

source_type

TYPE: str | None | VariableType DEFAULT: None

table_configuration

Configuration settings to control the ingestion of tables. These settings are applied to all tables in the pipeline

TYPE: PipelineIngestionDefinitionTableConfiguration | None | VariableType DEFAULT: None


laktory.models.resources.databricks.pipeline.PipelineIngestionDefinitionDataStagingOptions ¤

Bases: BaseModel

PARAMETER DESCRIPTION
catalog_name

TYPE: str | VariableType

schema_name

TYPE: str | VariableType

volume_name

TYPE: str | None | VariableType DEFAULT: None


laktory.models.resources.databricks.pipeline.PipelineIngestionDefinitionFullRefreshWindow ¤

Bases: BaseModel

PARAMETER DESCRIPTION
days_of_week

TYPE: list[str] | None | VariableType DEFAULT: None

start_hour

TYPE: int | VariableType

time_zone_id

TYPE: str | None | VariableType DEFAULT: None


laktory.models.resources.databricks.pipeline.PipelineIngestionDefinitionObjects ¤

Bases: BaseModel

PARAMETER DESCRIPTION
report

TYPE: PipelineIngestionDefinitionObjectsReport | None | VariableType DEFAULT: None

schema_

The UC schema the event log is published under

TYPE: PipelineIngestionDefinitionObjectsSchema | None | VariableType DEFAULT: None

table

TYPE: PipelineIngestionDefinitionObjectsTable | None | VariableType DEFAULT: None


laktory.models.resources.databricks.pipeline.PipelineIngestionDefinitionObjectsReport ¤

Bases: BaseModel

PARAMETER DESCRIPTION
destination_catalog

TYPE: str | VariableType

destination_schema

TYPE: str | VariableType

destination_table

TYPE: str | None | VariableType DEFAULT: None

source_url

TYPE: str | VariableType

table_configuration

Configuration settings to control the ingestion of tables. These settings are applied to all tables in the pipeline

TYPE: PipelineIngestionDefinitionObjectsReportTableConfiguration | None | VariableType DEFAULT: None


laktory.models.resources.databricks.pipeline.PipelineIngestionDefinitionObjectsReportTableConfiguration ¤

Bases: BaseModel

PARAMETER DESCRIPTION
auto_full_refresh_policy

TYPE: PipelineIngestionDefinitionObjectsReportTableConfigurationAutoFullRefreshPolicy | None | VariableType DEFAULT: None

exclude_columns

TYPE: list[str] | None | VariableType DEFAULT: None

include_columns

TYPE: list[str] | None | VariableType DEFAULT: None

primary_keys

TYPE: list[str] | None | VariableType DEFAULT: None

query_based_connector_config

TYPE: PipelineIngestionDefinitionObjectsReportTableConfigurationQueryBasedConnectorConfig | None | VariableType DEFAULT: None

row_filter

TYPE: str | None | VariableType DEFAULT: None

salesforce_include_formula_fields

TYPE: bool | None | VariableType DEFAULT: None

scd_type

TYPE: str | None | VariableType DEFAULT: None

sequence_by

TYPE: list[str] | None | VariableType DEFAULT: None

workday_report_parameters

TYPE: PipelineIngestionDefinitionObjectsReportTableConfigurationWorkdayReportParameters | None | VariableType DEFAULT: None


laktory.models.resources.databricks.pipeline.PipelineIngestionDefinitionObjectsReportTableConfigurationAutoFullRefreshPolicy ¤

Bases: BaseModel

PARAMETER DESCRIPTION
enabled

TYPE: bool | VariableType

min_interval_hours

TYPE: int | None | VariableType DEFAULT: None


laktory.models.resources.databricks.pipeline.PipelineIngestionDefinitionObjectsReportTableConfigurationQueryBasedConnectorConfig ¤

Bases: BaseModel

PARAMETER DESCRIPTION
cursor_columns

TYPE: list[str] | None | VariableType DEFAULT: None

deletion_condition

TYPE: str | None | VariableType DEFAULT: None

hard_deletion_sync_min_interval_in_seconds

TYPE: int | None | VariableType DEFAULT: None


laktory.models.resources.databricks.pipeline.PipelineIngestionDefinitionObjectsReportTableConfigurationWorkdayReportParameters ¤

Bases: BaseModel

PARAMETER DESCRIPTION
incremental

TYPE: bool | None | VariableType DEFAULT: None

parameters

TYPE: dict[str, str] | None | VariableType DEFAULT: None

report_parameters

TYPE: list[PipelineIngestionDefinitionObjectsReportTableConfigurationWorkdayReportParametersReportParameters] | None | VariableType DEFAULT: None


laktory.models.resources.databricks.pipeline.PipelineIngestionDefinitionObjectsReportTableConfigurationWorkdayReportParametersReportParameters ¤

Bases: BaseModel

PARAMETER DESCRIPTION
key

TYPE: str | None | VariableType DEFAULT: None

value

TYPE: str | None | VariableType DEFAULT: None


laktory.models.resources.databricks.pipeline.PipelineIngestionDefinitionObjectsSchema ¤

Bases: BaseModel

PARAMETER DESCRIPTION
connector_options

TYPE: PipelineIngestionDefinitionObjectsSchemaConnectorOptions | None | VariableType DEFAULT: None

destination_catalog

TYPE: str | VariableType

destination_schema

TYPE: str | VariableType

source_catalog

TYPE: str | None | VariableType DEFAULT: None

source_schema

TYPE: str | VariableType

table_configuration

Configuration settings to control the ingestion of tables. These settings are applied to all tables in the pipeline

TYPE: PipelineIngestionDefinitionObjectsSchemaTableConfiguration | None | VariableType DEFAULT: None


laktory.models.resources.databricks.pipeline.PipelineIngestionDefinitionObjectsSchemaConnectorOptions ¤


laktory.models.resources.databricks.pipeline.PipelineIngestionDefinitionObjectsSchemaConnectorOptionsConfluenceOptions ¤

Bases: BaseModel

PARAMETER DESCRIPTION
include_confluence_spaces

TYPE: list[str] | None | VariableType DEFAULT: None


laktory.models.resources.databricks.pipeline.PipelineIngestionDefinitionObjectsSchemaConnectorOptionsGdriveOptions ¤

Bases: BaseModel

PARAMETER DESCRIPTION
entity_type

TYPE: str | None | VariableType DEFAULT: None

file_ingestion_options

TYPE: PipelineIngestionDefinitionObjectsSchemaConnectorOptionsGdriveOptionsFileIngestionOptions | None | VariableType DEFAULT: None

url

URL of the Lakeflow Declarative Pipeline on the given workspace

TYPE: str | None | VariableType DEFAULT: None


laktory.models.resources.databricks.pipeline.PipelineIngestionDefinitionObjectsSchemaConnectorOptionsGdriveOptionsFileIngestionOptions ¤

Bases: BaseModel

PARAMETER DESCRIPTION
corrupt_record_column

TYPE: str | None | VariableType DEFAULT: None

file_filters

TYPE: list[PipelineIngestionDefinitionObjectsSchemaConnectorOptionsGdriveOptionsFileIngestionOptionsFileFilters] | None | VariableType DEFAULT: None

format

TYPE: str | None | VariableType DEFAULT: None

format_options

TYPE: dict[str, str] | None | VariableType DEFAULT: None

ignore_corrupt_files

TYPE: bool | None | VariableType DEFAULT: None

infer_column_types

TYPE: bool | None | VariableType DEFAULT: None

reader_case_sensitive

TYPE: bool | None | VariableType DEFAULT: None

rescued_data_column

TYPE: str | None | VariableType DEFAULT: None

schema_evolution_mode

TYPE: str | None | VariableType DEFAULT: None

schema_hints

TYPE: str | None | VariableType DEFAULT: None

single_variant_column

TYPE: str | None | VariableType DEFAULT: None


laktory.models.resources.databricks.pipeline.PipelineIngestionDefinitionObjectsSchemaConnectorOptionsGdriveOptionsFileIngestionOptionsFileFilters ¤

Bases: BaseModel

PARAMETER DESCRIPTION
modified_after

TYPE: str | None | VariableType DEFAULT: None

modified_before

TYPE: str | None | VariableType DEFAULT: None

path_filter

TYPE: str | None | VariableType DEFAULT: None


laktory.models.resources.databricks.pipeline.PipelineIngestionDefinitionObjectsSchemaConnectorOptionsGoogleAdsOptions ¤

Bases: BaseModel

PARAMETER DESCRIPTION
lookback_window_days

TYPE: int | None | VariableType DEFAULT: None

manager_account_id

TYPE: str | VariableType

sync_start_date

TYPE: str | None | VariableType DEFAULT: None


laktory.models.resources.databricks.pipeline.PipelineIngestionDefinitionObjectsSchemaConnectorOptionsJiraOptions ¤

Bases: BaseModel

PARAMETER DESCRIPTION
include_jira_spaces

TYPE: list[str] | None | VariableType DEFAULT: None


laktory.models.resources.databricks.pipeline.PipelineIngestionDefinitionObjectsSchemaConnectorOptionsKafkaOptions ¤

Bases: BaseModel

PARAMETER DESCRIPTION
client_config

TYPE: dict[str, str] | None | VariableType DEFAULT: None

key_transformer

TYPE: PipelineIngestionDefinitionObjectsSchemaConnectorOptionsKafkaOptionsKeyTransformer | None | VariableType DEFAULT: None

max_offsets_per_trigger

TYPE: int | None | VariableType DEFAULT: None

starting_offset

TYPE: str | None | VariableType DEFAULT: None

topic_pattern

TYPE: str | None | VariableType DEFAULT: None

topics

TYPE: list[str] | None | VariableType DEFAULT: None

value_transformer

TYPE: PipelineIngestionDefinitionObjectsSchemaConnectorOptionsKafkaOptionsValueTransformer | None | VariableType DEFAULT: None


laktory.models.resources.databricks.pipeline.PipelineIngestionDefinitionObjectsSchemaConnectorOptionsKafkaOptionsKeyTransformer ¤

Bases: BaseModel

PARAMETER DESCRIPTION
format

TYPE: str | None | VariableType DEFAULT: None

json_options

TYPE: PipelineIngestionDefinitionObjectsSchemaConnectorOptionsKafkaOptionsKeyTransformerJsonOptions | None | VariableType DEFAULT: None


laktory.models.resources.databricks.pipeline.PipelineIngestionDefinitionObjectsSchemaConnectorOptionsKafkaOptionsKeyTransformerJsonOptions ¤

Bases: BaseModel

PARAMETER DESCRIPTION
as_variant

TYPE: bool | None | VariableType DEFAULT: None

schema_

The UC schema the event log is published under

TYPE: str | None | VariableType DEFAULT: None

schema_evolution_mode

TYPE: str | None | VariableType DEFAULT: None

schema_file_path

TYPE: str | None | VariableType DEFAULT: None

schema_hints

TYPE: str | None | VariableType DEFAULT: None


laktory.models.resources.databricks.pipeline.PipelineIngestionDefinitionObjectsSchemaConnectorOptionsKafkaOptionsValueTransformer ¤

Bases: BaseModel

PARAMETER DESCRIPTION
format

TYPE: str | None | VariableType DEFAULT: None

json_options

TYPE: PipelineIngestionDefinitionObjectsSchemaConnectorOptionsKafkaOptionsValueTransformerJsonOptions | None | VariableType DEFAULT: None


laktory.models.resources.databricks.pipeline.PipelineIngestionDefinitionObjectsSchemaConnectorOptionsKafkaOptionsValueTransformerJsonOptions ¤

Bases: BaseModel

PARAMETER DESCRIPTION
as_variant

TYPE: bool | None | VariableType DEFAULT: None

schema_

The UC schema the event log is published under

TYPE: str | None | VariableType DEFAULT: None

schema_evolution_mode

TYPE: str | None | VariableType DEFAULT: None

schema_file_path

TYPE: str | None | VariableType DEFAULT: None

schema_hints

TYPE: str | None | VariableType DEFAULT: None


laktory.models.resources.databricks.pipeline.PipelineIngestionDefinitionObjectsSchemaConnectorOptionsMetaAdsOptions ¤

Bases: BaseModel

PARAMETER DESCRIPTION
action_attribution_windows

TYPE: list[str] | None | VariableType DEFAULT: None

action_breakdowns

TYPE: list[str] | None | VariableType DEFAULT: None

action_report_time

TYPE: str | None | VariableType DEFAULT: None

breakdowns

TYPE: list[str] | None | VariableType DEFAULT: None

custom_insights_lookback_window

TYPE: int | None | VariableType DEFAULT: None

level

TYPE: str | None | VariableType DEFAULT: None

start_date

TYPE: str | None | VariableType DEFAULT: None

time_increment

TYPE: str | None | VariableType DEFAULT: None


laktory.models.resources.databricks.pipeline.PipelineIngestionDefinitionObjectsSchemaConnectorOptionsOutlookOptions ¤

Bases: BaseModel

PARAMETER DESCRIPTION
attachment_mode

TYPE: str | None | VariableType DEFAULT: None

body_format

TYPE: str | None | VariableType DEFAULT: None

folder_filter

TYPE: list[str] | None | VariableType DEFAULT: None

include_folders

TYPE: list[str] | None | VariableType DEFAULT: None

include_mailboxes

TYPE: list[str] | None | VariableType DEFAULT: None

include_senders

TYPE: list[str] | None | VariableType DEFAULT: None

include_subjects

TYPE: list[str] | None | VariableType DEFAULT: None

sender_filter

TYPE: list[str] | None | VariableType DEFAULT: None

start_date

TYPE: str | None | VariableType DEFAULT: None

subject_filter

TYPE: list[str] | None | VariableType DEFAULT: None


laktory.models.resources.databricks.pipeline.PipelineIngestionDefinitionObjectsSchemaConnectorOptionsSharepointOptions ¤

Bases: BaseModel

PARAMETER DESCRIPTION
entity_type

TYPE: str | None | VariableType DEFAULT: None

file_ingestion_options

TYPE: PipelineIngestionDefinitionObjectsSchemaConnectorOptionsSharepointOptionsFileIngestionOptions | None | VariableType DEFAULT: None

url

URL of the Lakeflow Declarative Pipeline on the given workspace

TYPE: str | None | VariableType DEFAULT: None


laktory.models.resources.databricks.pipeline.PipelineIngestionDefinitionObjectsSchemaConnectorOptionsSharepointOptionsFileIngestionOptions ¤

Bases: BaseModel

PARAMETER DESCRIPTION
corrupt_record_column

TYPE: str | None | VariableType DEFAULT: None

file_filters

TYPE: list[PipelineIngestionDefinitionObjectsSchemaConnectorOptionsSharepointOptionsFileIngestionOptionsFileFilters] | None | VariableType DEFAULT: None

format

TYPE: str | None | VariableType DEFAULT: None

format_options

TYPE: dict[str, str] | None | VariableType DEFAULT: None

ignore_corrupt_files

TYPE: bool | None | VariableType DEFAULT: None

infer_column_types

TYPE: bool | None | VariableType DEFAULT: None

reader_case_sensitive

TYPE: bool | None | VariableType DEFAULT: None

rescued_data_column

TYPE: str | None | VariableType DEFAULT: None

schema_evolution_mode

TYPE: str | None | VariableType DEFAULT: None

schema_hints

TYPE: str | None | VariableType DEFAULT: None

single_variant_column

TYPE: str | None | VariableType DEFAULT: None


laktory.models.resources.databricks.pipeline.PipelineIngestionDefinitionObjectsSchemaConnectorOptionsSharepointOptionsFileIngestionOptionsFileFilters ¤

Bases: BaseModel

PARAMETER DESCRIPTION
modified_after

TYPE: str | None | VariableType DEFAULT: None

modified_before

TYPE: str | None | VariableType DEFAULT: None

path_filter

TYPE: str | None | VariableType DEFAULT: None


laktory.models.resources.databricks.pipeline.PipelineIngestionDefinitionObjectsSchemaConnectorOptionsSmartsheetOptions ¤

Bases: BaseModel

PARAMETER DESCRIPTION
enforce_schema

TYPE: bool | None | VariableType DEFAULT: None


laktory.models.resources.databricks.pipeline.PipelineIngestionDefinitionObjectsSchemaConnectorOptionsTiktokAdsOptions ¤

Bases: BaseModel

PARAMETER DESCRIPTION
data_level

TYPE: str | None | VariableType DEFAULT: None

dimensions

TYPE: list[str] | None | VariableType DEFAULT: None

lookback_window_days

TYPE: int | None | VariableType DEFAULT: None

metrics

TYPE: list[str] | None | VariableType DEFAULT: None

query_lifetime

TYPE: bool | None | VariableType DEFAULT: None

report_type

TYPE: str | None | VariableType DEFAULT: None

sync_start_date

TYPE: str | None | VariableType DEFAULT: None


laktory.models.resources.databricks.pipeline.PipelineIngestionDefinitionObjectsSchemaConnectorOptionsZendeskSupportOptions ¤

Bases: BaseModel

PARAMETER DESCRIPTION
start_date

TYPE: str | None | VariableType DEFAULT: None


laktory.models.resources.databricks.pipeline.PipelineIngestionDefinitionObjectsSchemaTableConfiguration ¤

Bases: BaseModel

PARAMETER DESCRIPTION
auto_full_refresh_policy

TYPE: PipelineIngestionDefinitionObjectsSchemaTableConfigurationAutoFullRefreshPolicy | None | VariableType DEFAULT: None

exclude_columns

TYPE: list[str] | None | VariableType DEFAULT: None

include_columns

TYPE: list[str] | None | VariableType DEFAULT: None

primary_keys

TYPE: list[str] | None | VariableType DEFAULT: None

query_based_connector_config

TYPE: PipelineIngestionDefinitionObjectsSchemaTableConfigurationQueryBasedConnectorConfig | None | VariableType DEFAULT: None

row_filter

TYPE: str | None | VariableType DEFAULT: None

salesforce_include_formula_fields

TYPE: bool | None | VariableType DEFAULT: None

scd_type

TYPE: str | None | VariableType DEFAULT: None

sequence_by

TYPE: list[str] | None | VariableType DEFAULT: None

workday_report_parameters

TYPE: PipelineIngestionDefinitionObjectsSchemaTableConfigurationWorkdayReportParameters | None | VariableType DEFAULT: None


laktory.models.resources.databricks.pipeline.PipelineIngestionDefinitionObjectsSchemaTableConfigurationAutoFullRefreshPolicy ¤

Bases: BaseModel

PARAMETER DESCRIPTION
enabled

TYPE: bool | VariableType

min_interval_hours

TYPE: int | None | VariableType DEFAULT: None


laktory.models.resources.databricks.pipeline.PipelineIngestionDefinitionObjectsSchemaTableConfigurationQueryBasedConnectorConfig ¤

Bases: BaseModel

PARAMETER DESCRIPTION
cursor_columns

TYPE: list[str] | None | VariableType DEFAULT: None

deletion_condition

TYPE: str | None | VariableType DEFAULT: None

hard_deletion_sync_min_interval_in_seconds

TYPE: int | None | VariableType DEFAULT: None


laktory.models.resources.databricks.pipeline.PipelineIngestionDefinitionObjectsSchemaTableConfigurationWorkdayReportParameters ¤

Bases: BaseModel

PARAMETER DESCRIPTION
incremental

TYPE: bool | None | VariableType DEFAULT: None

parameters

TYPE: dict[str, str] | None | VariableType DEFAULT: None

report_parameters

TYPE: list[PipelineIngestionDefinitionObjectsSchemaTableConfigurationWorkdayReportParametersReportParameters] | None | VariableType DEFAULT: None


laktory.models.resources.databricks.pipeline.PipelineIngestionDefinitionObjectsSchemaTableConfigurationWorkdayReportParametersReportParameters ¤

Bases: BaseModel

PARAMETER DESCRIPTION
key

TYPE: str | None | VariableType DEFAULT: None

value

TYPE: str | None | VariableType DEFAULT: None


laktory.models.resources.databricks.pipeline.PipelineIngestionDefinitionObjectsTable ¤

Bases: BaseModel

PARAMETER DESCRIPTION
connector_options

TYPE: PipelineIngestionDefinitionObjectsTableConnectorOptions | None | VariableType DEFAULT: None

destination_catalog

TYPE: str | VariableType

destination_schema

TYPE: str | VariableType

destination_table

TYPE: str | None | VariableType DEFAULT: None

source_catalog

TYPE: str | None | VariableType DEFAULT: None

source_schema

TYPE: str | None | VariableType DEFAULT: None

source_table

TYPE: str | VariableType

table_configuration

Configuration settings to control the ingestion of tables. These settings are applied to all tables in the pipeline

TYPE: PipelineIngestionDefinitionObjectsTableTableConfiguration | None | VariableType DEFAULT: None


laktory.models.resources.databricks.pipeline.PipelineIngestionDefinitionObjectsTableConnectorOptions ¤


laktory.models.resources.databricks.pipeline.PipelineIngestionDefinitionObjectsTableConnectorOptionsConfluenceOptions ¤

Bases: BaseModel

PARAMETER DESCRIPTION
include_confluence_spaces

TYPE: list[str] | None | VariableType DEFAULT: None


laktory.models.resources.databricks.pipeline.PipelineIngestionDefinitionObjectsTableConnectorOptionsGdriveOptions ¤

Bases: BaseModel

PARAMETER DESCRIPTION
entity_type

TYPE: str | None | VariableType DEFAULT: None

file_ingestion_options

TYPE: PipelineIngestionDefinitionObjectsTableConnectorOptionsGdriveOptionsFileIngestionOptions | None | VariableType DEFAULT: None

url

URL of the Lakeflow Declarative Pipeline on the given workspace

TYPE: str | None | VariableType DEFAULT: None


laktory.models.resources.databricks.pipeline.PipelineIngestionDefinitionObjectsTableConnectorOptionsGdriveOptionsFileIngestionOptions ¤

Bases: BaseModel

PARAMETER DESCRIPTION
corrupt_record_column

TYPE: str | None | VariableType DEFAULT: None

file_filters

TYPE: list[PipelineIngestionDefinitionObjectsTableConnectorOptionsGdriveOptionsFileIngestionOptionsFileFilters] | None | VariableType DEFAULT: None

format

TYPE: str | None | VariableType DEFAULT: None

format_options

TYPE: dict[str, str] | None | VariableType DEFAULT: None

ignore_corrupt_files

TYPE: bool | None | VariableType DEFAULT: None

infer_column_types

TYPE: bool | None | VariableType DEFAULT: None

reader_case_sensitive

TYPE: bool | None | VariableType DEFAULT: None

rescued_data_column

TYPE: str | None | VariableType DEFAULT: None

schema_evolution_mode

TYPE: str | None | VariableType DEFAULT: None

schema_hints

TYPE: str | None | VariableType DEFAULT: None

single_variant_column

TYPE: str | None | VariableType DEFAULT: None


laktory.models.resources.databricks.pipeline.PipelineIngestionDefinitionObjectsTableConnectorOptionsGdriveOptionsFileIngestionOptionsFileFilters ¤

Bases: BaseModel

PARAMETER DESCRIPTION
modified_after

TYPE: str | None | VariableType DEFAULT: None

modified_before

TYPE: str | None | VariableType DEFAULT: None

path_filter

TYPE: str | None | VariableType DEFAULT: None


laktory.models.resources.databricks.pipeline.PipelineIngestionDefinitionObjectsTableConnectorOptionsGoogleAdsOptions ¤

Bases: BaseModel

PARAMETER DESCRIPTION
lookback_window_days

TYPE: int | None | VariableType DEFAULT: None

manager_account_id

TYPE: str | VariableType

sync_start_date

TYPE: str | None | VariableType DEFAULT: None


laktory.models.resources.databricks.pipeline.PipelineIngestionDefinitionObjectsTableConnectorOptionsJiraOptions ¤

Bases: BaseModel

PARAMETER DESCRIPTION
include_jira_spaces

TYPE: list[str] | None | VariableType DEFAULT: None


laktory.models.resources.databricks.pipeline.PipelineIngestionDefinitionObjectsTableConnectorOptionsKafkaOptions ¤

Bases: BaseModel

PARAMETER DESCRIPTION
client_config

TYPE: dict[str, str] | None | VariableType DEFAULT: None

key_transformer

TYPE: PipelineIngestionDefinitionObjectsTableConnectorOptionsKafkaOptionsKeyTransformer | None | VariableType DEFAULT: None

max_offsets_per_trigger

TYPE: int | None | VariableType DEFAULT: None

starting_offset

TYPE: str | None | VariableType DEFAULT: None

topic_pattern

TYPE: str | None | VariableType DEFAULT: None

topics

TYPE: list[str] | None | VariableType DEFAULT: None

value_transformer

TYPE: PipelineIngestionDefinitionObjectsTableConnectorOptionsKafkaOptionsValueTransformer | None | VariableType DEFAULT: None


laktory.models.resources.databricks.pipeline.PipelineIngestionDefinitionObjectsTableConnectorOptionsKafkaOptionsKeyTransformer ¤

Bases: BaseModel

PARAMETER DESCRIPTION
format

TYPE: str | None | VariableType DEFAULT: None

json_options

TYPE: PipelineIngestionDefinitionObjectsTableConnectorOptionsKafkaOptionsKeyTransformerJsonOptions | None | VariableType DEFAULT: None


laktory.models.resources.databricks.pipeline.PipelineIngestionDefinitionObjectsTableConnectorOptionsKafkaOptionsKeyTransformerJsonOptions ¤

Bases: BaseModel

PARAMETER DESCRIPTION
as_variant

TYPE: bool | None | VariableType DEFAULT: None

schema_

The UC schema the event log is published under

TYPE: str | None | VariableType DEFAULT: None

schema_evolution_mode

TYPE: str | None | VariableType DEFAULT: None

schema_file_path

TYPE: str | None | VariableType DEFAULT: None

schema_hints

TYPE: str | None | VariableType DEFAULT: None


laktory.models.resources.databricks.pipeline.PipelineIngestionDefinitionObjectsTableConnectorOptionsKafkaOptionsValueTransformer ¤

Bases: BaseModel

PARAMETER DESCRIPTION
format

TYPE: str | None | VariableType DEFAULT: None

json_options

TYPE: PipelineIngestionDefinitionObjectsTableConnectorOptionsKafkaOptionsValueTransformerJsonOptions | None | VariableType DEFAULT: None


laktory.models.resources.databricks.pipeline.PipelineIngestionDefinitionObjectsTableConnectorOptionsKafkaOptionsValueTransformerJsonOptions ¤

Bases: BaseModel

PARAMETER DESCRIPTION
as_variant

TYPE: bool | None | VariableType DEFAULT: None

schema_

The UC schema the event log is published under

TYPE: str | None | VariableType DEFAULT: None

schema_evolution_mode

TYPE: str | None | VariableType DEFAULT: None

schema_file_path

TYPE: str | None | VariableType DEFAULT: None

schema_hints

TYPE: str | None | VariableType DEFAULT: None


laktory.models.resources.databricks.pipeline.PipelineIngestionDefinitionObjectsTableConnectorOptionsMetaAdsOptions ¤

Bases: BaseModel

PARAMETER DESCRIPTION
action_attribution_windows

TYPE: list[str] | None | VariableType DEFAULT: None

action_breakdowns

TYPE: list[str] | None | VariableType DEFAULT: None

action_report_time

TYPE: str | None | VariableType DEFAULT: None

breakdowns

TYPE: list[str] | None | VariableType DEFAULT: None

custom_insights_lookback_window

TYPE: int | None | VariableType DEFAULT: None

level

TYPE: str | None | VariableType DEFAULT: None

start_date

TYPE: str | None | VariableType DEFAULT: None

time_increment

TYPE: str | None | VariableType DEFAULT: None


laktory.models.resources.databricks.pipeline.PipelineIngestionDefinitionObjectsTableConnectorOptionsOutlookOptions ¤

Bases: BaseModel

PARAMETER DESCRIPTION
attachment_mode

TYPE: str | None | VariableType DEFAULT: None

body_format

TYPE: str | None | VariableType DEFAULT: None

folder_filter

TYPE: list[str] | None | VariableType DEFAULT: None

include_folders

TYPE: list[str] | None | VariableType DEFAULT: None

include_mailboxes

TYPE: list[str] | None | VariableType DEFAULT: None

include_senders

TYPE: list[str] | None | VariableType DEFAULT: None

include_subjects

TYPE: list[str] | None | VariableType DEFAULT: None

sender_filter

TYPE: list[str] | None | VariableType DEFAULT: None

start_date

TYPE: str | None | VariableType DEFAULT: None

subject_filter

TYPE: list[str] | None | VariableType DEFAULT: None


laktory.models.resources.databricks.pipeline.PipelineIngestionDefinitionObjectsTableConnectorOptionsSharepointOptions ¤

Bases: BaseModel

PARAMETER DESCRIPTION
entity_type

TYPE: str | None | VariableType DEFAULT: None

file_ingestion_options

TYPE: PipelineIngestionDefinitionObjectsTableConnectorOptionsSharepointOptionsFileIngestionOptions | None | VariableType DEFAULT: None

url

URL of the Lakeflow Declarative Pipeline on the given workspace

TYPE: str | None | VariableType DEFAULT: None


laktory.models.resources.databricks.pipeline.PipelineIngestionDefinitionObjectsTableConnectorOptionsSharepointOptionsFileIngestionOptions ¤

Bases: BaseModel

PARAMETER DESCRIPTION
corrupt_record_column

TYPE: str | None | VariableType DEFAULT: None

file_filters

TYPE: list[PipelineIngestionDefinitionObjectsTableConnectorOptionsSharepointOptionsFileIngestionOptionsFileFilters] | None | VariableType DEFAULT: None

format

TYPE: str | None | VariableType DEFAULT: None

format_options

TYPE: dict[str, str] | None | VariableType DEFAULT: None

ignore_corrupt_files

TYPE: bool | None | VariableType DEFAULT: None

infer_column_types

TYPE: bool | None | VariableType DEFAULT: None

reader_case_sensitive

TYPE: bool | None | VariableType DEFAULT: None

rescued_data_column

TYPE: str | None | VariableType DEFAULT: None

schema_evolution_mode

TYPE: str | None | VariableType DEFAULT: None

schema_hints

TYPE: str | None | VariableType DEFAULT: None

single_variant_column

TYPE: str | None | VariableType DEFAULT: None


laktory.models.resources.databricks.pipeline.PipelineIngestionDefinitionObjectsTableConnectorOptionsSharepointOptionsFileIngestionOptionsFileFilters ¤

Bases: BaseModel

PARAMETER DESCRIPTION
modified_after

TYPE: str | None | VariableType DEFAULT: None

modified_before

TYPE: str | None | VariableType DEFAULT: None

path_filter

TYPE: str | None | VariableType DEFAULT: None


laktory.models.resources.databricks.pipeline.PipelineIngestionDefinitionObjectsTableConnectorOptionsSmartsheetOptions ¤

Bases: BaseModel

PARAMETER DESCRIPTION
enforce_schema

TYPE: bool | None | VariableType DEFAULT: None


laktory.models.resources.databricks.pipeline.PipelineIngestionDefinitionObjectsTableConnectorOptionsTiktokAdsOptions ¤

Bases: BaseModel

PARAMETER DESCRIPTION
data_level

TYPE: str | None | VariableType DEFAULT: None

dimensions

TYPE: list[str] | None | VariableType DEFAULT: None

lookback_window_days

TYPE: int | None | VariableType DEFAULT: None

metrics

TYPE: list[str] | None | VariableType DEFAULT: None

query_lifetime

TYPE: bool | None | VariableType DEFAULT: None

report_type

TYPE: str | None | VariableType DEFAULT: None

sync_start_date

TYPE: str | None | VariableType DEFAULT: None


laktory.models.resources.databricks.pipeline.PipelineIngestionDefinitionObjectsTableConnectorOptionsZendeskSupportOptions ¤

Bases: BaseModel

PARAMETER DESCRIPTION
start_date

TYPE: str | None | VariableType DEFAULT: None


laktory.models.resources.databricks.pipeline.PipelineIngestionDefinitionObjectsTableTableConfiguration ¤

Bases: BaseModel

PARAMETER DESCRIPTION
auto_full_refresh_policy

TYPE: PipelineIngestionDefinitionObjectsTableTableConfigurationAutoFullRefreshPolicy | None | VariableType DEFAULT: None

exclude_columns

TYPE: list[str] | None | VariableType DEFAULT: None

include_columns

TYPE: list[str] | None | VariableType DEFAULT: None

primary_keys

TYPE: list[str] | None | VariableType DEFAULT: None

query_based_connector_config

TYPE: PipelineIngestionDefinitionObjectsTableTableConfigurationQueryBasedConnectorConfig | None | VariableType DEFAULT: None

row_filter

TYPE: str | None | VariableType DEFAULT: None

salesforce_include_formula_fields

TYPE: bool | None | VariableType DEFAULT: None

scd_type

TYPE: str | None | VariableType DEFAULT: None

sequence_by

TYPE: list[str] | None | VariableType DEFAULT: None

workday_report_parameters

TYPE: PipelineIngestionDefinitionObjectsTableTableConfigurationWorkdayReportParameters | None | VariableType DEFAULT: None


laktory.models.resources.databricks.pipeline.PipelineIngestionDefinitionObjectsTableTableConfigurationAutoFullRefreshPolicy ¤

Bases: BaseModel

PARAMETER DESCRIPTION
enabled

TYPE: bool | VariableType

min_interval_hours

TYPE: int | None | VariableType DEFAULT: None


laktory.models.resources.databricks.pipeline.PipelineIngestionDefinitionObjectsTableTableConfigurationQueryBasedConnectorConfig ¤

Bases: BaseModel

PARAMETER DESCRIPTION
cursor_columns

TYPE: list[str] | None | VariableType DEFAULT: None

deletion_condition

TYPE: str | None | VariableType DEFAULT: None

hard_deletion_sync_min_interval_in_seconds

TYPE: int | None | VariableType DEFAULT: None


laktory.models.resources.databricks.pipeline.PipelineIngestionDefinitionObjectsTableTableConfigurationWorkdayReportParameters ¤

Bases: BaseModel

PARAMETER DESCRIPTION
incremental

TYPE: bool | None | VariableType DEFAULT: None

parameters

TYPE: dict[str, str] | None | VariableType DEFAULT: None

report_parameters

TYPE: list[PipelineIngestionDefinitionObjectsTableTableConfigurationWorkdayReportParametersReportParameters] | None | VariableType DEFAULT: None


laktory.models.resources.databricks.pipeline.PipelineIngestionDefinitionObjectsTableTableConfigurationWorkdayReportParametersReportParameters ¤

Bases: BaseModel

PARAMETER DESCRIPTION
key

TYPE: str | None | VariableType DEFAULT: None

value

TYPE: str | None | VariableType DEFAULT: None


laktory.models.resources.databricks.pipeline.PipelineIngestionDefinitionSourceConfigurations ¤

Bases: BaseModel

PARAMETER DESCRIPTION
catalog

The UC catalog the event log is published under

TYPE: PipelineIngestionDefinitionSourceConfigurationsCatalog | None | VariableType DEFAULT: None

google_ads_config

TYPE: PipelineIngestionDefinitionSourceConfigurationsGoogleAdsConfig | None | VariableType DEFAULT: None


laktory.models.resources.databricks.pipeline.PipelineIngestionDefinitionSourceConfigurationsCatalog ¤

Bases: BaseModel

PARAMETER DESCRIPTION
postgres

TYPE: PipelineIngestionDefinitionSourceConfigurationsCatalogPostgres | None | VariableType DEFAULT: None

source_catalog

TYPE: str | None | VariableType DEFAULT: None


laktory.models.resources.databricks.pipeline.PipelineIngestionDefinitionSourceConfigurationsCatalogPostgres ¤

Bases: BaseModel

PARAMETER DESCRIPTION
slot_config

TYPE: PipelineIngestionDefinitionSourceConfigurationsCatalogPostgresSlotConfig | None | VariableType DEFAULT: None


laktory.models.resources.databricks.pipeline.PipelineIngestionDefinitionSourceConfigurationsCatalogPostgresSlotConfig ¤

Bases: BaseModel

PARAMETER DESCRIPTION
publication_name

TYPE: str | None | VariableType DEFAULT: None

slot_name

TYPE: str | None | VariableType DEFAULT: None


laktory.models.resources.databricks.pipeline.PipelineIngestionDefinitionSourceConfigurationsGoogleAdsConfig ¤

Bases: BaseModel

PARAMETER DESCRIPTION
manager_account_id

TYPE: str | None | VariableType DEFAULT: None


laktory.models.resources.databricks.pipeline.PipelineIngestionDefinitionTableConfiguration ¤

Bases: BaseModel

PARAMETER DESCRIPTION
auto_full_refresh_policy

TYPE: PipelineIngestionDefinitionTableConfigurationAutoFullRefreshPolicy | None | VariableType DEFAULT: None

exclude_columns

TYPE: list[str] | None | VariableType DEFAULT: None

include_columns

TYPE: list[str] | None | VariableType DEFAULT: None

primary_keys

TYPE: list[str] | None | VariableType DEFAULT: None

query_based_connector_config

TYPE: PipelineIngestionDefinitionTableConfigurationQueryBasedConnectorConfig | None | VariableType DEFAULT: None

row_filter

TYPE: str | None | VariableType DEFAULT: None

salesforce_include_formula_fields

TYPE: bool | None | VariableType DEFAULT: None

scd_type

TYPE: str | None | VariableType DEFAULT: None

sequence_by

TYPE: list[str] | None | VariableType DEFAULT: None

workday_report_parameters

TYPE: PipelineIngestionDefinitionTableConfigurationWorkdayReportParameters | None | VariableType DEFAULT: None


laktory.models.resources.databricks.pipeline.PipelineIngestionDefinitionTableConfigurationAutoFullRefreshPolicy ¤

Bases: BaseModel

PARAMETER DESCRIPTION
enabled

TYPE: bool | VariableType

min_interval_hours

TYPE: int | None | VariableType DEFAULT: None


laktory.models.resources.databricks.pipeline.PipelineIngestionDefinitionTableConfigurationQueryBasedConnectorConfig ¤

Bases: BaseModel

PARAMETER DESCRIPTION
cursor_columns

TYPE: list[str] | None | VariableType DEFAULT: None

deletion_condition

TYPE: str | None | VariableType DEFAULT: None

hard_deletion_sync_min_interval_in_seconds

TYPE: int | None | VariableType DEFAULT: None


laktory.models.resources.databricks.pipeline.PipelineIngestionDefinitionTableConfigurationWorkdayReportParameters ¤

Bases: BaseModel

PARAMETER DESCRIPTION
incremental

TYPE: bool | None | VariableType DEFAULT: None

parameters

TYPE: dict[str, str] | None | VariableType DEFAULT: None

report_parameters

TYPE: list[PipelineIngestionDefinitionTableConfigurationWorkdayReportParametersReportParameters] | None | VariableType DEFAULT: None


laktory.models.resources.databricks.pipeline.PipelineIngestionDefinitionTableConfigurationWorkdayReportParametersReportParameters ¤

Bases: BaseModel

PARAMETER DESCRIPTION
key

TYPE: str | None | VariableType DEFAULT: None

value

TYPE: str | None | VariableType DEFAULT: None


laktory.models.resources.databricks.pipeline.PipelineLatestUpdates ¤

Bases: BaseModel

PARAMETER DESCRIPTION
creation_time

TYPE: str | None | VariableType DEFAULT: None

state

TYPE: str | None | VariableType DEFAULT: None

update_id

TYPE: str | None | VariableType DEFAULT: None


laktory.models.resources.databricks.pipeline.PipelineLibrary ¤

Bases: BaseModel

PARAMETER DESCRIPTION
file

specifies path to a file in Databricks Workspace to include as source. Actual path is specified as path attribute inside the block

TYPE: PipelineLibraryFile | None | VariableType DEFAULT: None

glob

The unified field to include source code. Each entry should have the include attribute that can specify a notebook path, a file path, or a folder path that ends /** (to include everything from that folder). This field cannot be used together with notebook or file

TYPE: PipelineLibraryGlob | None | VariableType DEFAULT: None

jar

TYPE: str | None | VariableType DEFAULT: None

maven

TYPE: PipelineLibraryMaven | None | VariableType DEFAULT: None

notebook

specifies path to a Databricks Notebook to include as source. Actual path is specified as path attribute inside the block

TYPE: PipelineLibraryNotebook | None | VariableType DEFAULT: None

whl

TYPE: str | None | VariableType DEFAULT: None


laktory.models.resources.databricks.pipeline.PipelineLibraryFile ¤

Bases: BaseModel

PARAMETER DESCRIPTION
path

TYPE: str | VariableType


laktory.models.resources.databricks.pipeline.PipelineLibraryGlob ¤

Bases: BaseModel

PARAMETER DESCRIPTION
include

Paths to include

TYPE: str | VariableType


laktory.models.resources.databricks.pipeline.PipelineLibraryMaven ¤

Bases: BaseModel

PARAMETER DESCRIPTION
coordinates

TYPE: str | VariableType

exclusions

TYPE: list[str] | None | VariableType DEFAULT: None

repo

TYPE: str | None | VariableType DEFAULT: None


laktory.models.resources.databricks.pipeline.PipelineLibraryNotebook ¤

Bases: BaseModel

PARAMETER DESCRIPTION
path

TYPE: str | VariableType


laktory.models.resources.databricks.pipeline.PipelineLookup ¤

Bases: ResourceLookup

PARAMETER DESCRIPTION
pipeline_id

ID of the pipeline

TYPE: str | VariableType


laktory.models.resources.databricks.pipeline.PipelineNotification ¤

Bases: BaseModel

PARAMETER DESCRIPTION
alerts

TYPE: list[str] | None | VariableType DEFAULT: None

email_recipients

TYPE: list[str] | None | VariableType DEFAULT: None


laktory.models.resources.databricks.pipeline.PipelineRestartWindow ¤

Bases: BaseModel

PARAMETER DESCRIPTION
days_of_week

TYPE: list[str] | None | VariableType DEFAULT: None

start_hour

TYPE: int | VariableType

time_zone_id

TYPE: str | None | VariableType DEFAULT: None


laktory.models.resources.databricks.pipeline.PipelineRunAs ¤

Bases: BaseModel

PARAMETER DESCRIPTION
service_principal_name

The application ID of an active service principal. Setting this field requires the servicePrincipal/user role

TYPE: str | None | VariableType DEFAULT: None

user_name

The email of an active workspace user. Non-admin users can only set this field to their own email

TYPE: str | None | VariableType DEFAULT: None


laktory.models.resources.databricks.pipeline.PipelineTimeouts ¤

Bases: BaseModel

PARAMETER DESCRIPTION
default

TYPE: str | None | VariableType DEFAULT: None


laktory.models.resources.databricks.pipeline.PipelineTrigger ¤

Bases: BaseModel

PARAMETER DESCRIPTION
cron

TYPE: PipelineTriggerCron | None | VariableType DEFAULT: None

manual

TYPE: PipelineTriggerManual | None | VariableType DEFAULT: None


laktory.models.resources.databricks.pipeline.PipelineTriggerCron ¤

Bases: BaseModel

PARAMETER DESCRIPTION
quartz_cron_schedule

TYPE: str | None | VariableType DEFAULT: None

timezone_id

TYPE: str | None | VariableType DEFAULT: None


laktory.models.resources.databricks.pipeline.PipelineTriggerManual ¤

Bases: BaseModel