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
TYPE:
|
budget_policy_id
|
optional string specifying ID of the budget policy for this Lakeflow Declarative Pipeline
TYPE:
|
catalog
|
The UC catalog the event log is published under
TYPE:
|
cause
|
TYPE:
|
channel
|
optional name of the release channel for Spark version used by Lakeflow Declarative Pipeline. Supported values are:
TYPE:
|
cluster
|
TYPE:
|
cluster_id
|
TYPE:
|
configuration
|
An optional list of values to apply to the entire pipeline. Elements must be formatted as key:value pairs. *
TYPE:
|
continuous
|
A flag indicating whether to run the pipeline continuously. The default value is
TYPE:
|
creator_user_name
|
TYPE:
|
deployment
|
Deployment type of this pipeline. Supports following attributes:
TYPE:
|
development
|
A flag indicating whether to run the pipeline in development mode. The default value is
TYPE:
|
edition
|
optional name of the product edition. Supported values are:
TYPE:
|
environment
|
TYPE:
|
event_log
|
an optional block specifying a table where LDP Event Log will be stored. Consists of the following fields:
TYPE:
|
expected_last_modified
|
TYPE:
|
filters
|
Filters on which Pipeline packages to include in the deployed graph. This block consists of following attributes:
TYPE:
|
gateway_definition
|
The definition of a gateway pipeline to support CDC. Consists of following attributes:
TYPE:
|
health
|
TYPE:
|
ingestion_definition
|
TYPE:
|
last_modified
|
TYPE:
|
latest_updates
|
TYPE:
|
library
|
TYPE:
|
name
|
The table name the event log is published to in UC
TYPE:
|
notification
|
TYPE:
|
photon
|
A flag indicating whether to use Photon engine. The default value is
TYPE:
|
restart_window
|
TYPE:
|
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
TYPE:
|
run_as
|
The user or the service principal the pipeline runs as. See run_as Configuration Block below
TYPE:
|
run_as_user_name
|
TYPE:
|
schema_
|
The UC schema the event log is published under
TYPE:
|
serverless
|
An optional flag indicating if serverless compute should be used for this Lakeflow Declarative Pipeline. Requires
TYPE:
|
state
|
TYPE:
|
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
TYPE:
|
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:
|
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:
|
timeouts
|
TYPE:
|
trigger
|
TYPE:
|
url
|
URL of the Lakeflow Declarative Pipeline on the given workspace
TYPE:
|
usage_policy_id
|
TYPE:
|
| LAKTORY | DESCRIPTION |
|---|---|
access_controls
|
Pipeline access controls
TYPE:
|
name_prefix
|
Prefix added to the DLP name
TYPE:
|
name_suffix
|
Suffix added to the DLP name
TYPE:
|
| ATTRIBUTE | DESCRIPTION |
|---|---|
additional_core_resources |
TYPE:
|
additional_core_resources
property
¤
- permissions
laktory.models.resources.databricks.pipeline.PipelineCluster
¤
Bases: BaseModel
| PARAMETER | DESCRIPTION |
|---|---|
apply_policy_default_values
|
TYPE:
|
autoscale
|
TYPE:
|
aws_attributes
|
TYPE:
|
azure_attributes
|
TYPE:
|
cluster_log_conf
|
TYPE:
|
custom_tags
|
TYPE:
|
driver_instance_pool_id
|
TYPE:
|
driver_node_type_id
|
TYPE:
|
enable_local_disk_encryption
|
TYPE:
|
gcp_attributes
|
TYPE:
|
init_scripts
|
TYPE:
|
instance_pool_id
|
TYPE:
|
label
|
TYPE:
|
node_type_id
|
TYPE:
|
num_workers
|
TYPE:
|
policy_id
|
TYPE:
|
spark_conf
|
TYPE:
|
spark_env_vars
|
TYPE:
|
ssh_public_keys
|
TYPE:
|
laktory.models.resources.databricks.pipeline.PipelineClusterAutoscale
¤
Bases: BaseModel
| PARAMETER | DESCRIPTION |
|---|---|
max_workers
|
TYPE:
|
min_workers
|
TYPE:
|
mode
|
TYPE:
|
laktory.models.resources.databricks.pipeline.PipelineClusterAwsAttributes
¤
Bases: BaseModel
| PARAMETER | DESCRIPTION |
|---|---|
availability
|
TYPE:
|
ebs_volume_count
|
TYPE:
|
ebs_volume_iops
|
TYPE:
|
ebs_volume_size
|
TYPE:
|
ebs_volume_throughput
|
TYPE:
|
ebs_volume_type
|
TYPE:
|
first_on_demand
|
TYPE:
|
instance_profile_arn
|
TYPE:
|
spot_bid_price_percent
|
TYPE:
|
zone_id
|
TYPE:
|
laktory.models.resources.databricks.pipeline.PipelineClusterAzureAttributes
¤
Bases: BaseModel
| PARAMETER | DESCRIPTION |
|---|---|
availability
|
TYPE:
|
first_on_demand
|
TYPE:
|
log_analytics_info
|
TYPE:
|
spot_bid_max_price
|
TYPE:
|
laktory.models.resources.databricks.pipeline.PipelineClusterAzureAttributesLogAnalyticsInfo
¤
Bases: BaseModel
| PARAMETER | DESCRIPTION |
|---|---|
log_analytics_primary_key
|
TYPE:
|
log_analytics_workspace_id
|
TYPE:
|
laktory.models.resources.databricks.pipeline.PipelineClusterClusterLogConf
¤
Bases: BaseModel
| PARAMETER | DESCRIPTION |
|---|---|
dbfs
|
TYPE:
|
s3
|
TYPE:
|
volumes
|
TYPE:
|
laktory.models.resources.databricks.pipeline.PipelineClusterClusterLogConfDbfs
¤
laktory.models.resources.databricks.pipeline.PipelineClusterClusterLogConfS3
¤
Bases: BaseModel
| PARAMETER | DESCRIPTION |
|---|---|
canned_acl
|
TYPE:
|
destination
|
TYPE:
|
enable_encryption
|
TYPE:
|
encryption_type
|
TYPE:
|
endpoint
|
TYPE:
|
kms_key
|
TYPE:
|
region
|
TYPE:
|
laktory.models.resources.databricks.pipeline.PipelineClusterClusterLogConfVolumes
¤
laktory.models.resources.databricks.pipeline.PipelineClusterGcpAttributes
¤
Bases: BaseModel
| PARAMETER | DESCRIPTION |
|---|---|
availability
|
TYPE:
|
confidential_compute_type
|
TYPE:
|
first_on_demand
|
TYPE:
|
google_service_account
|
TYPE:
|
local_ssd_count
|
TYPE:
|
zone_id
|
TYPE:
|
laktory.models.resources.databricks.pipeline.PipelineClusterInitScripts
¤
Bases: BaseModel
| PARAMETER | DESCRIPTION |
|---|---|
abfss
|
TYPE:
|
dbfs
|
TYPE:
|
file
|
specifies path to a file in Databricks Workspace to include as source. Actual path is specified as
TYPE:
|
gcs
|
TYPE:
|
s3
|
TYPE:
|
volumes
|
TYPE:
|
workspace
|
TYPE:
|
laktory.models.resources.databricks.pipeline.PipelineClusterInitScriptsAbfss
¤
laktory.models.resources.databricks.pipeline.PipelineClusterInitScriptsDbfs
¤
laktory.models.resources.databricks.pipeline.PipelineClusterInitScriptsFile
¤
laktory.models.resources.databricks.pipeline.PipelineClusterInitScriptsGcs
¤
laktory.models.resources.databricks.pipeline.PipelineClusterInitScriptsS3
¤
Bases: BaseModel
| PARAMETER | DESCRIPTION |
|---|---|
canned_acl
|
TYPE:
|
destination
|
TYPE:
|
enable_encryption
|
TYPE:
|
encryption_type
|
TYPE:
|
endpoint
|
TYPE:
|
kms_key
|
TYPE:
|
region
|
TYPE:
|
laktory.models.resources.databricks.pipeline.PipelineClusterInitScriptsVolumes
¤
laktory.models.resources.databricks.pipeline.PipelineClusterInitScriptsWorkspace
¤
laktory.models.resources.databricks.pipeline.PipelineDeployment
¤
Bases: BaseModel
| PARAMETER | DESCRIPTION |
|---|---|
deployment_id
|
TYPE:
|
kind
|
The deployment method that manages the pipeline
TYPE:
|
metadata_file_path
|
The path to the file containing metadata about the deployment
TYPE:
|
version_id
|
TYPE:
|
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:
|
environment_version
|
TYPE:
|
laktory.models.resources.databricks.pipeline.PipelineEventLog
¤
Bases: BaseModel
| PARAMETER | DESCRIPTION |
|---|---|
catalog
|
The UC catalog the event log is published under
TYPE:
|
name
|
The table name the event log is published to in UC
TYPE:
|
schema_
|
The UC schema the event log is published under
TYPE:
|
laktory.models.resources.databricks.pipeline.PipelineFilters
¤
Bases: BaseModel
| PARAMETER | DESCRIPTION |
|---|---|
exclude
|
Paths to exclude
TYPE:
|
include
|
Paths to include
TYPE:
|
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
TYPE:
|
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:
|
connection_parameters
|
TYPE:
|
gateway_storage_catalog
|
Required, Immutable. The name of the catalog for the gateway pipeline's storage location
TYPE:
|
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:
|
gateway_storage_schema
|
Required, Immutable. The name of the schema for the gateway pipelines's storage location
TYPE:
|
laktory.models.resources.databricks.pipeline.PipelineGatewayDefinitionConnectionParameters
¤
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:
|
connector_type
|
TYPE:
|
data_staging_options
|
TYPE:
|
full_refresh_window
|
TYPE:
|
ingest_from_uc_foreign_catalog
|
TYPE:
|
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:
|
netsuite_jar_path
|
TYPE:
|
objects
|
Required. Settings specifying tables to replicate and the destination for the replicated tables
TYPE:
|
source_configurations
|
Array of objects describing top-level source configurations. See the REST API docs for reference
TYPE:
|
source_type
|
TYPE:
|
table_configuration
|
Configuration settings to control the ingestion of tables. These settings are applied to all tables in the pipeline
TYPE:
|
laktory.models.resources.databricks.pipeline.PipelineIngestionDefinitionDataStagingOptions
¤
Bases: BaseModel
| PARAMETER | DESCRIPTION |
|---|---|
catalog_name
|
TYPE:
|
schema_name
|
TYPE:
|
volume_name
|
TYPE:
|
laktory.models.resources.databricks.pipeline.PipelineIngestionDefinitionFullRefreshWindow
¤
Bases: BaseModel
| PARAMETER | DESCRIPTION |
|---|---|
days_of_week
|
TYPE:
|
start_hour
|
TYPE:
|
time_zone_id
|
TYPE:
|
laktory.models.resources.databricks.pipeline.PipelineIngestionDefinitionObjects
¤
Bases: BaseModel
| PARAMETER | DESCRIPTION |
|---|---|
report
|
TYPE:
|
schema_
|
The UC schema the event log is published under
TYPE:
|
table
|
TYPE:
|
laktory.models.resources.databricks.pipeline.PipelineIngestionDefinitionObjectsReport
¤
Bases: BaseModel
| PARAMETER | DESCRIPTION |
|---|---|
destination_catalog
|
TYPE:
|
destination_schema
|
TYPE:
|
destination_table
|
TYPE:
|
source_url
|
TYPE:
|
table_configuration
|
Configuration settings to control the ingestion of tables. These settings are applied to all tables in the pipeline
TYPE:
|
laktory.models.resources.databricks.pipeline.PipelineIngestionDefinitionObjectsReportTableConfiguration
¤
Bases: BaseModel
| PARAMETER | DESCRIPTION |
|---|---|
auto_full_refresh_policy
|
TYPE:
|
exclude_columns
|
TYPE:
|
include_columns
|
TYPE:
|
primary_keys
|
TYPE:
|
query_based_connector_config
|
TYPE:
|
row_filter
|
TYPE:
|
salesforce_include_formula_fields
|
TYPE:
|
scd_type
|
TYPE:
|
sequence_by
|
TYPE:
|
workday_report_parameters
|
TYPE:
|
laktory.models.resources.databricks.pipeline.PipelineIngestionDefinitionObjectsReportTableConfigurationAutoFullRefreshPolicy
¤
Bases: BaseModel
| PARAMETER | DESCRIPTION |
|---|---|
enabled
|
TYPE:
|
min_interval_hours
|
TYPE:
|
laktory.models.resources.databricks.pipeline.PipelineIngestionDefinitionObjectsReportTableConfigurationQueryBasedConnectorConfig
¤
Bases: BaseModel
| PARAMETER | DESCRIPTION |
|---|---|
cursor_columns
|
TYPE:
|
deletion_condition
|
TYPE:
|
hard_deletion_sync_min_interval_in_seconds
|
TYPE:
|
laktory.models.resources.databricks.pipeline.PipelineIngestionDefinitionObjectsReportTableConfigurationWorkdayReportParameters
¤
Bases: BaseModel
| PARAMETER | DESCRIPTION |
|---|---|
incremental
|
TYPE:
|
parameters
|
TYPE:
|
report_parameters
|
TYPE:
|
laktory.models.resources.databricks.pipeline.PipelineIngestionDefinitionObjectsReportTableConfigurationWorkdayReportParametersReportParameters
¤
Bases: BaseModel
| PARAMETER | DESCRIPTION |
|---|---|
key
|
TYPE:
|
value
|
TYPE:
|
laktory.models.resources.databricks.pipeline.PipelineIngestionDefinitionObjectsSchema
¤
Bases: BaseModel
| PARAMETER | DESCRIPTION |
|---|---|
connector_options
|
TYPE:
|
destination_catalog
|
TYPE:
|
destination_schema
|
TYPE:
|
source_catalog
|
TYPE:
|
source_schema
|
TYPE:
|
table_configuration
|
Configuration settings to control the ingestion of tables. These settings are applied to all tables in the pipeline
TYPE:
|
laktory.models.resources.databricks.pipeline.PipelineIngestionDefinitionObjectsSchemaConnectorOptions
¤
Bases: BaseModel
laktory.models.resources.databricks.pipeline.PipelineIngestionDefinitionObjectsSchemaConnectorOptionsConfluenceOptions
¤
Bases: BaseModel
| PARAMETER | DESCRIPTION |
|---|---|
include_confluence_spaces
|
TYPE:
|
laktory.models.resources.databricks.pipeline.PipelineIngestionDefinitionObjectsSchemaConnectorOptionsGdriveOptions
¤
Bases: BaseModel
| PARAMETER | DESCRIPTION |
|---|---|
entity_type
|
TYPE:
|
file_ingestion_options
|
TYPE:
|
url
|
URL of the Lakeflow Declarative Pipeline on the given workspace
TYPE:
|
laktory.models.resources.databricks.pipeline.PipelineIngestionDefinitionObjectsSchemaConnectorOptionsGdriveOptionsFileIngestionOptions
¤
Bases: BaseModel
| PARAMETER | DESCRIPTION |
|---|---|
corrupt_record_column
|
TYPE:
|
file_filters
|
TYPE:
|
format
|
TYPE:
|
format_options
|
TYPE:
|
ignore_corrupt_files
|
TYPE:
|
infer_column_types
|
TYPE:
|
reader_case_sensitive
|
TYPE:
|
rescued_data_column
|
TYPE:
|
schema_evolution_mode
|
TYPE:
|
schema_hints
|
TYPE:
|
single_variant_column
|
TYPE:
|
laktory.models.resources.databricks.pipeline.PipelineIngestionDefinitionObjectsSchemaConnectorOptionsGdriveOptionsFileIngestionOptionsFileFilters
¤
Bases: BaseModel
| PARAMETER | DESCRIPTION |
|---|---|
modified_after
|
TYPE:
|
modified_before
|
TYPE:
|
path_filter
|
TYPE:
|
laktory.models.resources.databricks.pipeline.PipelineIngestionDefinitionObjectsSchemaConnectorOptionsGoogleAdsOptions
¤
Bases: BaseModel
| PARAMETER | DESCRIPTION |
|---|---|
lookback_window_days
|
TYPE:
|
manager_account_id
|
TYPE:
|
sync_start_date
|
TYPE:
|
laktory.models.resources.databricks.pipeline.PipelineIngestionDefinitionObjectsSchemaConnectorOptionsJiraOptions
¤
Bases: BaseModel
| PARAMETER | DESCRIPTION |
|---|---|
include_jira_spaces
|
TYPE:
|
laktory.models.resources.databricks.pipeline.PipelineIngestionDefinitionObjectsSchemaConnectorOptionsKafkaOptions
¤
Bases: BaseModel
| PARAMETER | DESCRIPTION |
|---|---|
client_config
|
TYPE:
|
key_transformer
|
TYPE:
|
max_offsets_per_trigger
|
TYPE:
|
starting_offset
|
TYPE:
|
topic_pattern
|
TYPE:
|
topics
|
TYPE:
|
value_transformer
|
TYPE:
|
laktory.models.resources.databricks.pipeline.PipelineIngestionDefinitionObjectsSchemaConnectorOptionsKafkaOptionsKeyTransformer
¤
Bases: BaseModel
| PARAMETER | DESCRIPTION |
|---|---|
format
|
TYPE:
|
json_options
|
TYPE:
|
laktory.models.resources.databricks.pipeline.PipelineIngestionDefinitionObjectsSchemaConnectorOptionsKafkaOptionsKeyTransformerJsonOptions
¤
Bases: BaseModel
| PARAMETER | DESCRIPTION |
|---|---|
as_variant
|
TYPE:
|
schema_
|
The UC schema the event log is published under
TYPE:
|
schema_evolution_mode
|
TYPE:
|
schema_file_path
|
TYPE:
|
schema_hints
|
TYPE:
|
laktory.models.resources.databricks.pipeline.PipelineIngestionDefinitionObjectsSchemaConnectorOptionsKafkaOptionsValueTransformer
¤
Bases: BaseModel
| PARAMETER | DESCRIPTION |
|---|---|
format
|
TYPE:
|
json_options
|
TYPE:
|
laktory.models.resources.databricks.pipeline.PipelineIngestionDefinitionObjectsSchemaConnectorOptionsKafkaOptionsValueTransformerJsonOptions
¤
Bases: BaseModel
| PARAMETER | DESCRIPTION |
|---|---|
as_variant
|
TYPE:
|
schema_
|
The UC schema the event log is published under
TYPE:
|
schema_evolution_mode
|
TYPE:
|
schema_file_path
|
TYPE:
|
schema_hints
|
TYPE:
|
laktory.models.resources.databricks.pipeline.PipelineIngestionDefinitionObjectsSchemaConnectorOptionsMetaAdsOptions
¤
Bases: BaseModel
| PARAMETER | DESCRIPTION |
|---|---|
action_attribution_windows
|
TYPE:
|
action_breakdowns
|
TYPE:
|
action_report_time
|
TYPE:
|
breakdowns
|
TYPE:
|
custom_insights_lookback_window
|
TYPE:
|
level
|
TYPE:
|
start_date
|
TYPE:
|
time_increment
|
TYPE:
|
laktory.models.resources.databricks.pipeline.PipelineIngestionDefinitionObjectsSchemaConnectorOptionsOutlookOptions
¤
Bases: BaseModel
| PARAMETER | DESCRIPTION |
|---|---|
attachment_mode
|
TYPE:
|
body_format
|
TYPE:
|
folder_filter
|
TYPE:
|
include_folders
|
TYPE:
|
include_mailboxes
|
TYPE:
|
include_senders
|
TYPE:
|
include_subjects
|
TYPE:
|
sender_filter
|
TYPE:
|
start_date
|
TYPE:
|
subject_filter
|
TYPE:
|
laktory.models.resources.databricks.pipeline.PipelineIngestionDefinitionObjectsSchemaConnectorOptionsSharepointOptions
¤
Bases: BaseModel
| PARAMETER | DESCRIPTION |
|---|---|
entity_type
|
TYPE:
|
file_ingestion_options
|
TYPE:
|
url
|
URL of the Lakeflow Declarative Pipeline on the given workspace
TYPE:
|
laktory.models.resources.databricks.pipeline.PipelineIngestionDefinitionObjectsSchemaConnectorOptionsSharepointOptionsFileIngestionOptions
¤
Bases: BaseModel
| PARAMETER | DESCRIPTION |
|---|---|
corrupt_record_column
|
TYPE:
|
file_filters
|
TYPE:
|
format
|
TYPE:
|
format_options
|
TYPE:
|
ignore_corrupt_files
|
TYPE:
|
infer_column_types
|
TYPE:
|
reader_case_sensitive
|
TYPE:
|
rescued_data_column
|
TYPE:
|
schema_evolution_mode
|
TYPE:
|
schema_hints
|
TYPE:
|
single_variant_column
|
TYPE:
|
laktory.models.resources.databricks.pipeline.PipelineIngestionDefinitionObjectsSchemaConnectorOptionsSharepointOptionsFileIngestionOptionsFileFilters
¤
Bases: BaseModel
| PARAMETER | DESCRIPTION |
|---|---|
modified_after
|
TYPE:
|
modified_before
|
TYPE:
|
path_filter
|
TYPE:
|
laktory.models.resources.databricks.pipeline.PipelineIngestionDefinitionObjectsSchemaConnectorOptionsSmartsheetOptions
¤
Bases: BaseModel
| PARAMETER | DESCRIPTION |
|---|---|
enforce_schema
|
TYPE:
|
laktory.models.resources.databricks.pipeline.PipelineIngestionDefinitionObjectsSchemaConnectorOptionsTiktokAdsOptions
¤
Bases: BaseModel
| PARAMETER | DESCRIPTION |
|---|---|
data_level
|
TYPE:
|
dimensions
|
TYPE:
|
lookback_window_days
|
TYPE:
|
metrics
|
TYPE:
|
query_lifetime
|
TYPE:
|
report_type
|
TYPE:
|
sync_start_date
|
TYPE:
|
laktory.models.resources.databricks.pipeline.PipelineIngestionDefinitionObjectsSchemaConnectorOptionsZendeskSupportOptions
¤
laktory.models.resources.databricks.pipeline.PipelineIngestionDefinitionObjectsSchemaTableConfiguration
¤
Bases: BaseModel
| PARAMETER | DESCRIPTION |
|---|---|
auto_full_refresh_policy
|
TYPE:
|
exclude_columns
|
TYPE:
|
include_columns
|
TYPE:
|
primary_keys
|
TYPE:
|
query_based_connector_config
|
TYPE:
|
row_filter
|
TYPE:
|
salesforce_include_formula_fields
|
TYPE:
|
scd_type
|
TYPE:
|
sequence_by
|
TYPE:
|
workday_report_parameters
|
TYPE:
|
laktory.models.resources.databricks.pipeline.PipelineIngestionDefinitionObjectsSchemaTableConfigurationAutoFullRefreshPolicy
¤
Bases: BaseModel
| PARAMETER | DESCRIPTION |
|---|---|
enabled
|
TYPE:
|
min_interval_hours
|
TYPE:
|
laktory.models.resources.databricks.pipeline.PipelineIngestionDefinitionObjectsSchemaTableConfigurationQueryBasedConnectorConfig
¤
Bases: BaseModel
| PARAMETER | DESCRIPTION |
|---|---|
cursor_columns
|
TYPE:
|
deletion_condition
|
TYPE:
|
hard_deletion_sync_min_interval_in_seconds
|
TYPE:
|
laktory.models.resources.databricks.pipeline.PipelineIngestionDefinitionObjectsSchemaTableConfigurationWorkdayReportParameters
¤
Bases: BaseModel
| PARAMETER | DESCRIPTION |
|---|---|
incremental
|
TYPE:
|
parameters
|
TYPE:
|
report_parameters
|
TYPE:
|
laktory.models.resources.databricks.pipeline.PipelineIngestionDefinitionObjectsSchemaTableConfigurationWorkdayReportParametersReportParameters
¤
Bases: BaseModel
| PARAMETER | DESCRIPTION |
|---|---|
key
|
TYPE:
|
value
|
TYPE:
|
laktory.models.resources.databricks.pipeline.PipelineIngestionDefinitionObjectsTable
¤
Bases: BaseModel
| PARAMETER | DESCRIPTION |
|---|---|
connector_options
|
TYPE:
|
destination_catalog
|
TYPE:
|
destination_schema
|
TYPE:
|
destination_table
|
TYPE:
|
source_catalog
|
TYPE:
|
source_schema
|
TYPE:
|
source_table
|
TYPE:
|
table_configuration
|
Configuration settings to control the ingestion of tables. These settings are applied to all tables in the pipeline
TYPE:
|
laktory.models.resources.databricks.pipeline.PipelineIngestionDefinitionObjectsTableConnectorOptions
¤
Bases: BaseModel
laktory.models.resources.databricks.pipeline.PipelineIngestionDefinitionObjectsTableConnectorOptionsConfluenceOptions
¤
Bases: BaseModel
| PARAMETER | DESCRIPTION |
|---|---|
include_confluence_spaces
|
TYPE:
|
laktory.models.resources.databricks.pipeline.PipelineIngestionDefinitionObjectsTableConnectorOptionsGdriveOptions
¤
Bases: BaseModel
| PARAMETER | DESCRIPTION |
|---|---|
entity_type
|
TYPE:
|
file_ingestion_options
|
TYPE:
|
url
|
URL of the Lakeflow Declarative Pipeline on the given workspace
TYPE:
|
laktory.models.resources.databricks.pipeline.PipelineIngestionDefinitionObjectsTableConnectorOptionsGdriveOptionsFileIngestionOptions
¤
Bases: BaseModel
| PARAMETER | DESCRIPTION |
|---|---|
corrupt_record_column
|
TYPE:
|
file_filters
|
TYPE:
|
format
|
TYPE:
|
format_options
|
TYPE:
|
ignore_corrupt_files
|
TYPE:
|
infer_column_types
|
TYPE:
|
reader_case_sensitive
|
TYPE:
|
rescued_data_column
|
TYPE:
|
schema_evolution_mode
|
TYPE:
|
schema_hints
|
TYPE:
|
single_variant_column
|
TYPE:
|
laktory.models.resources.databricks.pipeline.PipelineIngestionDefinitionObjectsTableConnectorOptionsGdriveOptionsFileIngestionOptionsFileFilters
¤
Bases: BaseModel
| PARAMETER | DESCRIPTION |
|---|---|
modified_after
|
TYPE:
|
modified_before
|
TYPE:
|
path_filter
|
TYPE:
|
laktory.models.resources.databricks.pipeline.PipelineIngestionDefinitionObjectsTableConnectorOptionsGoogleAdsOptions
¤
Bases: BaseModel
| PARAMETER | DESCRIPTION |
|---|---|
lookback_window_days
|
TYPE:
|
manager_account_id
|
TYPE:
|
sync_start_date
|
TYPE:
|
laktory.models.resources.databricks.pipeline.PipelineIngestionDefinitionObjectsTableConnectorOptionsJiraOptions
¤
Bases: BaseModel
| PARAMETER | DESCRIPTION |
|---|---|
include_jira_spaces
|
TYPE:
|
laktory.models.resources.databricks.pipeline.PipelineIngestionDefinitionObjectsTableConnectorOptionsKafkaOptions
¤
Bases: BaseModel
| PARAMETER | DESCRIPTION |
|---|---|
client_config
|
TYPE:
|
key_transformer
|
TYPE:
|
max_offsets_per_trigger
|
TYPE:
|
starting_offset
|
TYPE:
|
topic_pattern
|
TYPE:
|
topics
|
TYPE:
|
value_transformer
|
TYPE:
|
laktory.models.resources.databricks.pipeline.PipelineIngestionDefinitionObjectsTableConnectorOptionsKafkaOptionsKeyTransformer
¤
Bases: BaseModel
| PARAMETER | DESCRIPTION |
|---|---|
format
|
TYPE:
|
json_options
|
TYPE:
|
laktory.models.resources.databricks.pipeline.PipelineIngestionDefinitionObjectsTableConnectorOptionsKafkaOptionsKeyTransformerJsonOptions
¤
Bases: BaseModel
| PARAMETER | DESCRIPTION |
|---|---|
as_variant
|
TYPE:
|
schema_
|
The UC schema the event log is published under
TYPE:
|
schema_evolution_mode
|
TYPE:
|
schema_file_path
|
TYPE:
|
schema_hints
|
TYPE:
|
laktory.models.resources.databricks.pipeline.PipelineIngestionDefinitionObjectsTableConnectorOptionsKafkaOptionsValueTransformer
¤
Bases: BaseModel
| PARAMETER | DESCRIPTION |
|---|---|
format
|
TYPE:
|
json_options
|
TYPE:
|
laktory.models.resources.databricks.pipeline.PipelineIngestionDefinitionObjectsTableConnectorOptionsKafkaOptionsValueTransformerJsonOptions
¤
Bases: BaseModel
| PARAMETER | DESCRIPTION |
|---|---|
as_variant
|
TYPE:
|
schema_
|
The UC schema the event log is published under
TYPE:
|
schema_evolution_mode
|
TYPE:
|
schema_file_path
|
TYPE:
|
schema_hints
|
TYPE:
|
laktory.models.resources.databricks.pipeline.PipelineIngestionDefinitionObjectsTableConnectorOptionsMetaAdsOptions
¤
Bases: BaseModel
| PARAMETER | DESCRIPTION |
|---|---|
action_attribution_windows
|
TYPE:
|
action_breakdowns
|
TYPE:
|
action_report_time
|
TYPE:
|
breakdowns
|
TYPE:
|
custom_insights_lookback_window
|
TYPE:
|
level
|
TYPE:
|
start_date
|
TYPE:
|
time_increment
|
TYPE:
|
laktory.models.resources.databricks.pipeline.PipelineIngestionDefinitionObjectsTableConnectorOptionsOutlookOptions
¤
Bases: BaseModel
| PARAMETER | DESCRIPTION |
|---|---|
attachment_mode
|
TYPE:
|
body_format
|
TYPE:
|
folder_filter
|
TYPE:
|
include_folders
|
TYPE:
|
include_mailboxes
|
TYPE:
|
include_senders
|
TYPE:
|
include_subjects
|
TYPE:
|
sender_filter
|
TYPE:
|
start_date
|
TYPE:
|
subject_filter
|
TYPE:
|
laktory.models.resources.databricks.pipeline.PipelineIngestionDefinitionObjectsTableConnectorOptionsSharepointOptions
¤
Bases: BaseModel
| PARAMETER | DESCRIPTION |
|---|---|
entity_type
|
TYPE:
|
file_ingestion_options
|
TYPE:
|
url
|
URL of the Lakeflow Declarative Pipeline on the given workspace
TYPE:
|
laktory.models.resources.databricks.pipeline.PipelineIngestionDefinitionObjectsTableConnectorOptionsSharepointOptionsFileIngestionOptions
¤
Bases: BaseModel
| PARAMETER | DESCRIPTION |
|---|---|
corrupt_record_column
|
TYPE:
|
file_filters
|
TYPE:
|
format
|
TYPE:
|
format_options
|
TYPE:
|
ignore_corrupt_files
|
TYPE:
|
infer_column_types
|
TYPE:
|
reader_case_sensitive
|
TYPE:
|
rescued_data_column
|
TYPE:
|
schema_evolution_mode
|
TYPE:
|
schema_hints
|
TYPE:
|
single_variant_column
|
TYPE:
|
laktory.models.resources.databricks.pipeline.PipelineIngestionDefinitionObjectsTableConnectorOptionsSharepointOptionsFileIngestionOptionsFileFilters
¤
Bases: BaseModel
| PARAMETER | DESCRIPTION |
|---|---|
modified_after
|
TYPE:
|
modified_before
|
TYPE:
|
path_filter
|
TYPE:
|
laktory.models.resources.databricks.pipeline.PipelineIngestionDefinitionObjectsTableConnectorOptionsSmartsheetOptions
¤
Bases: BaseModel
| PARAMETER | DESCRIPTION |
|---|---|
enforce_schema
|
TYPE:
|
laktory.models.resources.databricks.pipeline.PipelineIngestionDefinitionObjectsTableConnectorOptionsTiktokAdsOptions
¤
Bases: BaseModel
| PARAMETER | DESCRIPTION |
|---|---|
data_level
|
TYPE:
|
dimensions
|
TYPE:
|
lookback_window_days
|
TYPE:
|
metrics
|
TYPE:
|
query_lifetime
|
TYPE:
|
report_type
|
TYPE:
|
sync_start_date
|
TYPE:
|
laktory.models.resources.databricks.pipeline.PipelineIngestionDefinitionObjectsTableConnectorOptionsZendeskSupportOptions
¤
laktory.models.resources.databricks.pipeline.PipelineIngestionDefinitionObjectsTableTableConfiguration
¤
Bases: BaseModel
| PARAMETER | DESCRIPTION |
|---|---|
auto_full_refresh_policy
|
TYPE:
|
exclude_columns
|
TYPE:
|
include_columns
|
TYPE:
|
primary_keys
|
TYPE:
|
query_based_connector_config
|
TYPE:
|
row_filter
|
TYPE:
|
salesforce_include_formula_fields
|
TYPE:
|
scd_type
|
TYPE:
|
sequence_by
|
TYPE:
|
workday_report_parameters
|
TYPE:
|
laktory.models.resources.databricks.pipeline.PipelineIngestionDefinitionObjectsTableTableConfigurationAutoFullRefreshPolicy
¤
Bases: BaseModel
| PARAMETER | DESCRIPTION |
|---|---|
enabled
|
TYPE:
|
min_interval_hours
|
TYPE:
|
laktory.models.resources.databricks.pipeline.PipelineIngestionDefinitionObjectsTableTableConfigurationQueryBasedConnectorConfig
¤
Bases: BaseModel
| PARAMETER | DESCRIPTION |
|---|---|
cursor_columns
|
TYPE:
|
deletion_condition
|
TYPE:
|
hard_deletion_sync_min_interval_in_seconds
|
TYPE:
|
laktory.models.resources.databricks.pipeline.PipelineIngestionDefinitionObjectsTableTableConfigurationWorkdayReportParameters
¤
Bases: BaseModel
| PARAMETER | DESCRIPTION |
|---|---|
incremental
|
TYPE:
|
parameters
|
TYPE:
|
report_parameters
|
TYPE:
|
laktory.models.resources.databricks.pipeline.PipelineIngestionDefinitionObjectsTableTableConfigurationWorkdayReportParametersReportParameters
¤
Bases: BaseModel
| PARAMETER | DESCRIPTION |
|---|---|
key
|
TYPE:
|
value
|
TYPE:
|
laktory.models.resources.databricks.pipeline.PipelineIngestionDefinitionSourceConfigurations
¤
Bases: BaseModel
| PARAMETER | DESCRIPTION |
|---|---|
catalog
|
The UC catalog the event log is published under
TYPE:
|
google_ads_config
|
TYPE:
|
laktory.models.resources.databricks.pipeline.PipelineIngestionDefinitionSourceConfigurationsCatalog
¤
Bases: BaseModel
| PARAMETER | DESCRIPTION |
|---|---|
postgres
|
TYPE:
|
source_catalog
|
TYPE:
|
laktory.models.resources.databricks.pipeline.PipelineIngestionDefinitionSourceConfigurationsCatalogPostgres
¤
Bases: BaseModel
| PARAMETER | DESCRIPTION |
|---|---|
slot_config
|
TYPE:
|
laktory.models.resources.databricks.pipeline.PipelineIngestionDefinitionSourceConfigurationsCatalogPostgresSlotConfig
¤
Bases: BaseModel
| PARAMETER | DESCRIPTION |
|---|---|
publication_name
|
TYPE:
|
slot_name
|
TYPE:
|
laktory.models.resources.databricks.pipeline.PipelineIngestionDefinitionSourceConfigurationsGoogleAdsConfig
¤
Bases: BaseModel
| PARAMETER | DESCRIPTION |
|---|---|
manager_account_id
|
TYPE:
|
laktory.models.resources.databricks.pipeline.PipelineIngestionDefinitionTableConfiguration
¤
Bases: BaseModel
| PARAMETER | DESCRIPTION |
|---|---|
auto_full_refresh_policy
|
TYPE:
|
exclude_columns
|
TYPE:
|
include_columns
|
TYPE:
|
primary_keys
|
TYPE:
|
query_based_connector_config
|
TYPE:
|
row_filter
|
TYPE:
|
salesforce_include_formula_fields
|
TYPE:
|
scd_type
|
TYPE:
|
sequence_by
|
TYPE:
|
workday_report_parameters
|
TYPE:
|
laktory.models.resources.databricks.pipeline.PipelineIngestionDefinitionTableConfigurationAutoFullRefreshPolicy
¤
Bases: BaseModel
| PARAMETER | DESCRIPTION |
|---|---|
enabled
|
TYPE:
|
min_interval_hours
|
TYPE:
|
laktory.models.resources.databricks.pipeline.PipelineIngestionDefinitionTableConfigurationQueryBasedConnectorConfig
¤
Bases: BaseModel
| PARAMETER | DESCRIPTION |
|---|---|
cursor_columns
|
TYPE:
|
deletion_condition
|
TYPE:
|
hard_deletion_sync_min_interval_in_seconds
|
TYPE:
|
laktory.models.resources.databricks.pipeline.PipelineIngestionDefinitionTableConfigurationWorkdayReportParameters
¤
Bases: BaseModel
| PARAMETER | DESCRIPTION |
|---|---|
incremental
|
TYPE:
|
parameters
|
TYPE:
|
report_parameters
|
TYPE:
|
laktory.models.resources.databricks.pipeline.PipelineIngestionDefinitionTableConfigurationWorkdayReportParametersReportParameters
¤
Bases: BaseModel
| PARAMETER | DESCRIPTION |
|---|---|
key
|
TYPE:
|
value
|
TYPE:
|
laktory.models.resources.databricks.pipeline.PipelineLatestUpdates
¤
Bases: BaseModel
| PARAMETER | DESCRIPTION |
|---|---|
creation_time
|
TYPE:
|
state
|
TYPE:
|
update_id
|
TYPE:
|
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
TYPE:
|
glob
|
The unified field to include source code. Each entry should have the
TYPE:
|
jar
|
TYPE:
|
maven
|
TYPE:
|
notebook
|
specifies path to a Databricks Notebook to include as source. Actual path is specified as
TYPE:
|
whl
|
TYPE:
|
laktory.models.resources.databricks.pipeline.PipelineLibraryFile
¤
laktory.models.resources.databricks.pipeline.PipelineLibraryGlob
¤
laktory.models.resources.databricks.pipeline.PipelineLibraryMaven
¤
Bases: BaseModel
| PARAMETER | DESCRIPTION |
|---|---|
coordinates
|
TYPE:
|
exclusions
|
TYPE:
|
repo
|
TYPE:
|
laktory.models.resources.databricks.pipeline.PipelineLibraryNotebook
¤
laktory.models.resources.databricks.pipeline.PipelineLookup
¤
laktory.models.resources.databricks.pipeline.PipelineNotification
¤
Bases: BaseModel
| PARAMETER | DESCRIPTION |
|---|---|
alerts
|
TYPE:
|
email_recipients
|
TYPE:
|
laktory.models.resources.databricks.pipeline.PipelineRestartWindow
¤
Bases: BaseModel
| PARAMETER | DESCRIPTION |
|---|---|
days_of_week
|
TYPE:
|
start_hour
|
TYPE:
|
time_zone_id
|
TYPE:
|
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
TYPE:
|
user_name
|
The email of an active workspace user. Non-admin users can only set this field to their own email
TYPE:
|
laktory.models.resources.databricks.pipeline.PipelineTimeouts
¤
laktory.models.resources.databricks.pipeline.PipelineTrigger
¤
Bases: BaseModel
| PARAMETER | DESCRIPTION |
|---|---|
cron
|
TYPE:
|
manual
|
TYPE:
|
laktory.models.resources.databricks.pipeline.PipelineTriggerCron
¤
Bases: BaseModel
| PARAMETER | DESCRIPTION |
|---|---|
quartz_cron_schedule
|
TYPE:
|
timezone_id
|
TYPE:
|