use crate::adapters::contract::models::{ChangeApply, TableName};
use crate::adapters::dispatch::main::dialect::sql_adapter::sql_adapter;
use crate::cdc::constants::{
BATCH_INTERVAL, CDC_FILES_PROBLEM, CDC_TARGETS_PROBLEM, FILES_BATCH_INTERVAL,
};
use crate::column_types::main::parse_type::parse_type;
use crate::column_types::models::{ColumnType, Warehouse};
use crate::loader::_helpers::resolve::ResolvedTarget;
use crate::loader::models::{CdcSpec, CursorSpec, SettingOrigin, TableSpec};
use crate::masking::models::MaskRules;
use crate::postgres_source::models::SourceTable;
use crate::project::models::{
CdcDeletes, CdcMode, MaskMethod, SourceConfig, SourceKind, StateMode, TableOverride,
TableSettings, WriteStrategy,
};
use crate::similar_names::main::nearest_name::nearest_name;
use globset::{Glob, GlobMatcher, GlobSet, GlobSetBuilder};
use std::collections::BTreeMap;
pub(crate) struct SourceContext<'a> {
pub(crate) name: &'a str,
pub(crate) source: &'a SourceConfig,
pub(crate) target: &'a ResolvedTarget,
}
pub(crate) struct ColumnChoices {
pub(crate) excluded: Vec<(String, String)>,
pub(crate) pinned: BTreeMap<String, ColumnType>,
}
pub(crate) fn column_selection(
context: &SourceContext<'_>,
table: &SourceTable,
overrides: &TableOverride,
) -> Result<ColumnSelection, String> {
let source = context.source;
let rules = ColumnRules {
exclude: [
source.exclude_columns.clone(),
overrides.exclude_columns.clone(),
]
.concat(),
allow: [
source.allow_columns.clone(),
overrides.allow_columns.clone(),
]
.concat(),
skip_tables_with: source.skip_tables_with_columns.clone(),
};
let selection = apply_column_rules(table, &rules)?;
Ok(match selection {
ColumnSelection::Keep(excluded) => ColumnSelection::Keep(
excluded
.into_iter()
.filter(|(column, _)| !overrides.mask.contains_key(column))
.collect(),
),
skip => skip,
})
}
pub(crate) fn pinned_types(
overrides: &TableOverride,
warehouse: Warehouse,
) -> Result<BTreeMap<String, ColumnType>, Vec<String>> {
let mut pinned: BTreeMap<String, ColumnType> = BTreeMap::new();
let mut problems: Vec<String> = Vec::new();
for (column, text) in &overrides.columns {
match parse_type(text, &[warehouse]) {
Ok(parsed) => {
pinned.insert(column.clone(), parsed.column_type);
}
Err(error) => problems.push(format!("column {column}: {error}")),
}
}
for column in overrides.mask.keys() {
pinned.insert(column.clone(), ColumnType::Text);
}
match problems.is_empty() {
true => Ok(pinned),
false => Err(problems),
}
}
fn column_reference_problems(table: &SourceTable, overrides: &TableOverride) -> Vec<String> {
let names: Vec<&str> = table
.columns
.iter()
.map(|column| column.name.as_str())
.collect();
let keys = overrides
.columns
.keys()
.map(|key| ("columns", key))
.chain(overrides.mask.keys().map(|key| ("mask", key)));
keys.filter(|(_, key)| !names.contains(&key.as_str()))
.map(|(setting, key)| unknown_column(setting, key, &names))
.collect()
}
fn unknown_column(setting: &str, key: &str, names: &[&str]) -> String {
let hint = match nearest_name(key, names.iter().copied()) {
Some(nearest) => format!("; did you mean {nearest:?}?"),
None => String::new(),
};
format!(
"{setting} {key:?} is not a column of the source table (names are case-sensitive){hint}"
)
}
pub(crate) fn build_spec(
context: &SourceContext<'_>,
table: &SourceTable,
overrides: &TableOverride,
columns: ColumnChoices,
) -> Result<TableSpec, Vec<String>> {
let settings = &overrides.settings;
let defaults = &context.source.defaults;
let cursor = cursor(settings, defaults);
let unique_key = layered(&settings.unique_key, &defaults.unique_key)
.map_or_else(|| table.primary_key.clone(), |(key, _)| key);
let (strategy, strategy_origin) = layered(&settings.write_strategy, &defaults.write_strategy)
.unwrap_or_else(|| {
(
default_strategy(cursor.as_ref(), !unique_key.is_empty()),
SettingOrigin::Default,
)
});
let cdc = cdc_spec(context);
let (strategy, mut problems) = match &cdc {
Some(cdc) if !sql_adapter(context.target.warehouse).captures_changes(cdc.apply) => (
WriteStrategy::Append,
vec![
match sql_adapter(context.target.warehouse).runs_sql() {
true => CDC_TARGETS_PROBLEM,
false => CDC_FILES_PROBLEM,
}
.to_owned(),
],
),
Some(_) => (WriteStrategy::Append, cdc_key_problems(table, &unique_key)),
None => (
strategy,
strategy_problems(strategy, &unique_key, cursor.as_ref()),
),
};
problems.extend(column_reference_problems(table, overrides));
let batch = layered(&settings.batch_size, &defaults.batch_size).map(|(value, _)| value);
let uses_key = strategy == WriteStrategy::Merge;
problems.extend(overrides.mask.keys().filter_map(|masked| {
let is_cursor = cursor.as_ref().is_some_and(|cursor| cursor.column == *masked);
let is_key = uses_key && unique_key.contains(masked);
(is_cursor || is_key).then(|| {
format!("mask {masked}: a masked column cannot be the cursor_column or part of the unique_key")
})
}));
if context.source.mask_key.is_none()
&& overrides
.mask
.values()
.any(|method| *method == MaskMethod::Hmac)
{
problems.push("mask uses \"hmac\" but the source sets no mask_key (for example mask_key = \"${ENV:MASK_KEY}\")".to_owned());
}
let files_description = match context.source.kind {
SourceKind::Files => context.source.description.as_deref(),
_ => None,
};
let description = overrides
.description
.as_deref()
.or(files_description)
.or(table.comment.as_deref())
.map(str::trim)
.filter(|text| !text.is_empty());
if !overrides.flatten.is_empty() && context.source.kind != SourceKind::Python {
problems.push(
"flatten applies to Python tables; nested values from this source stay JSON".to_owned(),
);
}
problems.extend(flatten_problems(context, overrides));
if !problems.is_empty() {
return Err(problems);
}
let name = table_name(
(context.name, context.source),
overrides.name.as_deref(),
table,
);
Ok(TableSpec {
source_name: context.name.to_owned(),
source_table: table.clone(),
target: context.target.name.clone(),
destination: TableName {
database: context.target.database.clone(),
schema: context.target.schema.clone(),
table: name,
},
description: description.unwrap_or_default().to_owned(),
warehouse: context.target.warehouse,
strategy,
strategy_origin,
unique_key,
cursor,
batch,
#[cfg(feature = "container-tests")]
test_loader_route: layered(&settings.test_loader_route, &defaults.test_loader_route)
.is_some_and(|(value, _)| value),
#[cfg(not(feature = "container-tests"))]
test_loader_route: false,
source_end: None,
pinned: columns.pinned,
excluded_columns: columns.excluded,
masked: MaskRules {
columns: overrides.mask.clone(),
key: context.source.mask_key.clone(),
},
contract: layered(&settings.contract, &defaults.contract)
.map(|(value, _)| value)
.unwrap_or_default(),
on_schema_change: layered(&settings.on_schema_change, &defaults.on_schema_change)
.map(|(value, _)| value)
.unwrap_or_default(),
auto_widen: layered(&settings.auto_widen, &defaults.auto_widen)
.is_some_and(|(value, _)| value),
type_change_rebuild: layered(&settings.type_change_rebuild, &defaults.type_change_rebuild)
.map(|(value, _)| value)
.unwrap_or_default(),
flatten: overrides.flatten.clone(),
allow_empty: layered(&settings.allow_empty, &defaults.allow_empty)
.is_some_and(|(value, _)| value),
logged: layered(&settings.state, &defaults.state)
.is_some_and(|(value, _)| value == StateMode::Logged),
approved: false,
new_tables: context.source.new_tables,
files: None,
destination_path: context.target.path.as_ref().map(|target_path| {
overrides
.destination_path
.clone()
.or_else(|| context.source.destination_path.clone())
.unwrap_or_else(|| target_path.clone())
}),
python: None,
cdc,
})
}
fn cdc_spec(context: &SourceContext<'_>) -> Option<CdcSpec> {
let source = context.source;
(source.kind == SourceKind::PostgresCdc).then(|| {
let default_name = format!("sqlload_{}", context.name.to_lowercase());
CdcSpec {
apply: match (source.cdc_mode, source.deletes) {
(CdcMode::Changelog, _) => ChangeApply::Changelog,
(CdcMode::Merge, CdcDeletes::Soft) => ChangeApply::SoftDeletes,
(CdcMode::Merge, CdcDeletes::Hard) => ChangeApply::HardDeletes,
},
slot: source.slot.clone().unwrap_or_else(|| default_name.clone()),
publication: source.publication.clone().unwrap_or(default_name),
batch_interval: source.batch_interval.unwrap_or(
match sql_adapter(context.target.warehouse).runs_sql() {
true => BATCH_INTERVAL,
false => FILES_BATCH_INTERVAL,
},
),
}
})
}
fn cdc_key_problems(table: &SourceTable, unique_key: &[String]) -> Vec<String> {
let qualified = table.qualified_name();
if table.primary_key.is_empty() {
return vec![format!(
"{qualified} has no primary key; kind = \"postgres_cdc\" captures tables with one in this release (publishing a table without a replica identity makes Postgres refuse its updates and deletes); add a primary key, or exclude it"
)];
}
let outside: Vec<&str> = unique_key
.iter()
.filter(|column| !table.primary_key.contains(column))
.map(String::as_str)
.collect();
match outside.is_empty() {
true => Vec::new(),
false => vec![format!(
"{qualified}: unique_key column {} is not in the primary key, and Postgres sends only the primary key with a delete, so deletes could not find their rows; kind = \"postgres_cdc\" merges on the primary key in this release, so drop unique_key",
outside.join(", ")
)],
}
}
pub(crate) fn missing_description(
source_name: &str,
source: &SourceConfig,
table: &SourceTable,
) -> Option<String> {
let qualified = table.qualified_name();
let entry = source.tables.get(&qualified);
let written =
!source.reads_postgres() || entry.is_some() || source.include.contains(&qualified);
let described = [
entry.and_then(|entry| entry.description.as_deref()),
source
.description
.as_deref()
.filter(|_| source.kind == SourceKind::Files),
]
.into_iter()
.flatten()
.any(|text| !text.trim().is_empty());
let fix = match source.kind {
SourceKind::Python => {
"no description; add description=\"...\" to its table declaration, or a docstring to its function".to_owned()
}
SourceKind::Files => {
format!("no description; add description = \"...\" under [sources.{source_name}]")
}
SourceKind::Postgres | SourceKind::PostgresCdc => format!(
"no description; add description = \"...\" under [sources.{source_name}.tables.\"{qualified}\"]"
),
};
(written && !described).then_some(fix)
}
fn glob(pattern: &str) -> Result<Glob, String> {
Glob::new(pattern).map_err(|error| format!("invalid column pattern {pattern:?}: {error}"))
}
fn column_matcher(patterns: &[String]) -> Result<GlobSet, String> {
let mut builder = GlobSetBuilder::new();
for pattern in patterns {
builder.add(glob(pattern)?);
}
builder.build().map_err(|error| error.to_string())
}
#[derive(Debug, Default)]
pub(crate) struct ColumnRules {
pub(crate) exclude: Vec<String>,
pub(crate) allow: Vec<String>,
pub(crate) skip_tables_with: Vec<String>,
}
fn flatten_problems(context: &SourceContext<'_>, overrides: &TableOverride) -> Vec<String> {
let exclude: Vec<String> = [
context.source.exclude_columns.clone(),
overrides.exclude_columns.clone(),
]
.concat();
overrides
.flatten
.iter()
.filter_map(|object| {
let excluded = excluding_pattern(object, &exclude);
let setting = match (excluded, overrides.mask.contains_key(object), overrides.columns.contains_key(object)) {
_ if object.contains('.') => {
return Some(format!(
"flatten {object}: flatten names top-level objects, not paths; list {} instead (its nested values stay JSON)",
object.split('.').next().unwrap_or_default()
));
}
(Some(pattern), _, _) => format!("exclude_columns {pattern}"),
(None, true, _) => "mask".to_owned(),
(None, false, true) => "columns".to_owned(),
(None, false, false) => return None,
};
Some(format!(
"flatten {object}: {setting} also names {object}, which flattening replaces with {object}__<key> columns; name those columns instead, or leave {object} unflattened"
))
})
.collect()
}
fn excluding_pattern<'a>(name: &str, exclude: &'a [String]) -> Option<&'a String> {
let keys = format!("{name}__");
exclude.iter().find(|pattern| {
glob(pattern).is_ok_and(|glob| {
let matcher = glob.compile_matcher();
matcher.is_match(name) && !matcher.is_match(&keys)
})
})
}
#[derive(Debug, PartialEq, Eq)]
pub(crate) enum ColumnSelection {
Keep(Vec<(String, String)>),
Skip(String),
}
pub(crate) fn apply_column_rules(
table: &SourceTable,
rules: &ColumnRules,
) -> Result<ColumnSelection, String> {
let allow = column_matcher(&rules.allow)?;
let skip = column_matcher(&rules.skip_tables_with)?;
let exclude: Vec<(&String, GlobMatcher)> = rules
.exclude
.iter()
.map(|pattern| Ok((pattern, glob(pattern)?.compile_matcher())))
.collect::<Result<_, String>>()?;
let names: Vec<&str> = table
.columns
.iter()
.map(|column| column.name.as_str())
.filter(|name| !allow.is_match(name))
.collect();
if let Some(column) = names.iter().find(|name| skip.is_match(name)) {
return Ok(ColumnSelection::Skip(format!(
"has column {column}, which matches skip_tables_with_columns"
)));
}
let excluded: Vec<(String, String)> = names
.iter()
.filter_map(|name| excluded_by(name, &exclude))
.collect();
Ok(ColumnSelection::Keep(excluded))
}
fn excluded_by(name: &str, exclude: &[(&String, GlobMatcher)]) -> Option<(String, String)> {
let (pattern, _) = exclude.iter().find(|(_, matcher)| matcher.is_match(name))?;
Some((name.to_owned(), format!("exclude_columns {pattern}")))
}
pub(crate) fn table_name(
(source_name, source): (&str, &SourceConfig),
name: Option<&str>,
table: &SourceTable,
) -> String {
match name {
Some(name) if !name.contains('{') => name.to_owned(),
_ => destination_name(
name.unwrap_or(source.table_name_template()),
source_name,
table,
),
}
}
pub(crate) fn destination_name(template: &str, source: &str, table: &SourceTable) -> String {
template
.replace("{source}", source)
.replace("{schema}", &table.schema)
.replace("{table}", &table.name)
.to_ascii_lowercase()
}
pub(crate) fn layered<T: Clone>(
table: &Option<T>,
source: &Option<T>,
) -> Option<(T, SettingOrigin)> {
match (table, source) {
(Some(value), _) => Some((value.clone(), SettingOrigin::Table)),
(None, Some(value)) => Some((value.clone(), SettingOrigin::Source)),
(None, None) => None,
}
}
pub(crate) fn cursor(table: &TableSettings, source: &TableSettings) -> Option<CursorSpec> {
let (column, _) = layered(&table.cursor_column, &source.cursor_column)?;
Some(CursorSpec {
column,
start: layered(&table.cursor_start, &source.cursor_start).map(|(value, _)| value),
lookback: layered(&table.lookback, &source.lookback).map(|(value, _)| value),
inclusive: layered(
&table.append_cursor_inclusive,
&source.append_cursor_inclusive,
)
.is_some_and(|(value, _)| value),
})
}
pub(crate) fn default_strategy(cursor: Option<&CursorSpec>, has_key: bool) -> WriteStrategy {
match (cursor, has_key) {
(None, _) => WriteStrategy::Replace,
(Some(_), true) => WriteStrategy::Merge,
(Some(_), false) => WriteStrategy::DeleteInsert,
}
}
pub(crate) fn strategy_problems(
strategy: WriteStrategy,
unique_key: &[String],
cursor: Option<&CursorSpec>,
) -> Vec<String> {
let mut problems: Vec<String> = Vec::new();
match (strategy, cursor) {
(WriteStrategy::Merge, _) if unique_key.is_empty() => problems.push(
"write_strategy = \"merge\" needs a unique_key (the table has no primary key)".to_owned(),
),
(WriteStrategy::Append, Some(cursor)) if cursor.lookback.is_some() => problems.push(
"lookback re-inserts the window on every run with append; use delete_insert (no key needed) or merge"
.to_owned(),
),
(WriteStrategy::Replace, Some(_)) => problems.push(
"write_strategy = \"replace\" reloads the whole table, so it takes no cursor_column".to_owned(),
),
(WriteStrategy::DeleteInsert, None) => problems.push(
"write_strategy = \"delete_insert\" replaces a cursor range, so it needs a cursor_column".to_owned(),
),
_ => {}
}
problems
}