1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402
// Copyright Materialize, Inc. and contributors. All rights reserved.
//
// Use of this software is governed by the Business Source License
// included in the LICENSE file.
//
// As of the Change Date specified in that file, in accordance with
// the Business Source License, use of this software will be governed
// by the Apache License, Version 2.0.
//! Types related to source envelopes
use anyhow::{anyhow, bail};
use mz_proto::{IntoRustIfSome, ProtoType, RustType, TryFromProtoError};
use mz_repr::{ColumnType, RelationDesc, RelationType, ScalarType};
use proptest::prelude::any;
use proptest_derive::Arbitrary;
use serde::{Deserialize, Serialize};
include!(concat!(
env!("OUT_DIR"),
"/mz_storage_types.sources.envelope.rs"
));
/// `SourceEnvelope`s describe how to turn a stream of messages from `SourceDesc`s
/// into a _differential stream_, that is, a stream of (data, time, diff)
/// triples.
///
/// PostgreSQL sources skip any explicit envelope handling, effectively
/// asserting that `SourceEnvelope` is `None` with `KeyEnvelope::None`.
#[derive(Arbitrary, Clone, Debug, Serialize, Deserialize, Eq, PartialEq)]
pub enum SourceEnvelope {
/// The most trivial version is `None`, which typically produces triples where the diff
/// is `1`. However, some sources are able to produce values with more exotic diff's,
/// such as the posgres source. Currently, this is the only variant usable with
/// those sources.
///
/// If the `KeyEnvelope` is present,
/// include the key columns as an output column of the source with the given properties.
None(NoneEnvelope),
/// `Upsert` holds onto previously seen values and produces `1` or `-1` diffs depending on
/// whether or not the required _key_ outputed by the source has been seen before. This also
/// supports a `Debezium` mode.
Upsert(UpsertEnvelope),
/// `CdcV2` requires sources output messages in a strict form that requires a upstream-provided
/// timeline.
CdcV2,
}
impl RustType<ProtoSourceEnvelope> for SourceEnvelope {
fn into_proto(&self) -> ProtoSourceEnvelope {
use proto_source_envelope::Kind;
ProtoSourceEnvelope {
kind: Some(match self {
SourceEnvelope::None(e) => Kind::None(e.into_proto()),
SourceEnvelope::Upsert(e) => Kind::Upsert(e.into_proto()),
SourceEnvelope::CdcV2 => Kind::CdcV2(()),
}),
}
}
fn from_proto(proto: ProtoSourceEnvelope) -> Result<Self, TryFromProtoError> {
use proto_source_envelope::Kind;
let kind = proto
.kind
.ok_or_else(|| TryFromProtoError::missing_field("ProtoSourceEnvelope::kind"))?;
Ok(match kind {
Kind::None(e) => SourceEnvelope::None(e.into_rust()?),
Kind::Upsert(e) => SourceEnvelope::Upsert(e.into_rust()?),
Kind::CdcV2(()) => SourceEnvelope::CdcV2,
})
}
}
/// `UnplannedSourceEnvelope` is a `SourceEnvelope` missing some information. This information
/// is obtained in `UnplannedSourceEnvelope::desc`, where
/// `UnplannedSourceEnvelope::into_source_envelope`
/// creates a full `SourceEnvelope`
#[derive(Clone, Debug, Serialize, Deserialize, Eq, PartialEq)]
pub enum UnplannedSourceEnvelope {
None(KeyEnvelope),
Upsert { style: UpsertStyle },
CdcV2,
}
#[derive(Arbitrary, Clone, Debug, Serialize, Deserialize, Eq, PartialEq)]
pub struct NoneEnvelope {
pub key_envelope: KeyEnvelope,
pub key_arity: usize,
}
impl RustType<ProtoNoneEnvelope> for NoneEnvelope {
fn into_proto(&self) -> ProtoNoneEnvelope {
ProtoNoneEnvelope {
key_envelope: Some(self.key_envelope.into_proto()),
key_arity: self.key_arity.into_proto(),
}
}
fn from_proto(proto: ProtoNoneEnvelope) -> Result<Self, TryFromProtoError> {
Ok(NoneEnvelope {
key_envelope: proto
.key_envelope
.into_rust_if_some("ProtoNoneEnvelope::key_envelope")?,
key_arity: proto.key_arity.into_rust()?,
})
}
}
#[derive(Clone, Debug, Serialize, Deserialize, Eq, PartialEq, Arbitrary)]
pub struct UpsertEnvelope {
/// Full arity, including the key columns
pub source_arity: usize,
/// What style of Upsert we are using
pub style: UpsertStyle,
/// The indices of the keys in the full value row, used
/// to deduplicate data in `upsert_core`
#[proptest(strategy = "proptest::collection::vec(any::<usize>(), 0..4)")]
pub key_indices: Vec<usize>,
}
impl RustType<ProtoUpsertEnvelope> for UpsertEnvelope {
fn into_proto(&self) -> ProtoUpsertEnvelope {
ProtoUpsertEnvelope {
source_arity: self.source_arity.into_proto(),
style: Some(self.style.into_proto()),
key_indices: self.key_indices.into_proto(),
}
}
fn from_proto(proto: ProtoUpsertEnvelope) -> Result<Self, TryFromProtoError> {
Ok(UpsertEnvelope {
source_arity: proto.source_arity.into_rust()?,
style: proto
.style
.into_rust_if_some("ProtoUpsertEnvelope::style")?,
key_indices: proto.key_indices.into_rust()?,
})
}
}
#[derive(Arbitrary, Clone, Debug, Serialize, Deserialize, Eq, PartialEq)]
pub enum UpsertStyle {
/// `ENVELOPE UPSERT`, where the key shape depends on the independent
/// `KeyEnvelope`
Default(KeyEnvelope),
/// `ENVELOPE DEBEZIUM UPSERT`
Debezium { after_idx: usize },
}
impl RustType<ProtoUpsertStyle> for UpsertStyle {
fn into_proto(&self) -> ProtoUpsertStyle {
use proto_upsert_style::{Kind, ProtoDebezium};
ProtoUpsertStyle {
kind: Some(match self {
UpsertStyle::Default(e) => Kind::Default(e.into_proto()),
UpsertStyle::Debezium { after_idx } => Kind::Debezium(ProtoDebezium {
after_idx: after_idx.into_proto(),
}),
}),
}
}
fn from_proto(proto: ProtoUpsertStyle) -> Result<Self, TryFromProtoError> {
use proto_upsert_style::Kind;
let kind = proto
.kind
.ok_or_else(|| TryFromProtoError::missing_field("ProtoUpsertStyle::kind"))?;
Ok(match kind {
Kind::Default(e) => UpsertStyle::Default(e.into_rust()?),
Kind::Debezium(d) => UpsertStyle::Debezium {
after_idx: d.after_idx.into_rust()?,
},
})
}
}
/// Computes the indices of the value's relation description that appear in the key.
///
/// Returns an error if it detects a common columns between the two relations that has the same
/// name but a different type, if a key column is missing from the value, and if the key relation
/// has a column with no name.
fn match_key_indices(
key_desc: &RelationDesc,
value_desc: &RelationDesc,
) -> anyhow::Result<Vec<usize>> {
let mut indices = Vec::new();
for (name, key_type) in key_desc.iter() {
let (index, value_type) = value_desc
.get_by_name(name)
.ok_or_else(|| anyhow!("Value schema missing primary key column: {}", name))?;
if key_type == value_type {
indices.push(index);
} else {
bail!(
"key and value column types do not match: key {:?} vs. value {:?}",
key_type,
value_type
);
}
}
Ok(indices)
}
impl UnplannedSourceEnvelope {
/// Transforms an `UnplannedSourceEnvelope` into a `SourceEnvelope`
///
/// Panics if the input envelope is `UnplannedSourceEnvelope::Upsert` and
/// key is not passed as `Some`
// TODO(petrosagg): This API looks very error prone. Can we statically enforce it somehow?
fn into_source_envelope(
self,
key: Option<Vec<usize>>,
key_arity: Option<usize>,
source_arity: Option<usize>,
) -> SourceEnvelope {
match self {
UnplannedSourceEnvelope::Upsert {
style: upsert_style,
} => SourceEnvelope::Upsert(UpsertEnvelope {
style: upsert_style,
key_indices: key.expect(
"into_source_envelope to be passed \
correct parameters for UnplannedSourceEnvelope::Upsert",
),
source_arity: source_arity.expect(
"into_source_envelope to be passed \
correct parameters for UnplannedSourceEnvelope::Upsert",
),
}),
UnplannedSourceEnvelope::None(key_envelope) => SourceEnvelope::None(NoneEnvelope {
key_envelope,
key_arity: key_arity.unwrap_or(0),
}),
UnplannedSourceEnvelope::CdcV2 => SourceEnvelope::CdcV2,
}
}
/// Computes the output relation of this envelope when applied on top of the decoded key and
/// value relation desc
pub fn desc(
self,
key_desc: Option<RelationDesc>,
value_desc: RelationDesc,
metadata_desc: RelationDesc,
) -> anyhow::Result<(SourceEnvelope, RelationDesc)> {
Ok(match &self {
UnplannedSourceEnvelope::None(key_envelope)
| UnplannedSourceEnvelope::Upsert {
style: UpsertStyle::Default(key_envelope),
..
} => {
let key_desc = match key_desc {
Some(desc) if !desc.is_empty() => desc,
_ => {
return Ok((
self.into_source_envelope(None, None, None),
value_desc.concat(metadata_desc),
))
}
};
let key_arity = key_desc.arity();
let (keyed, key) = match key_envelope {
KeyEnvelope::None => (value_desc, None),
KeyEnvelope::Flattened => {
// Add the key columns as a key.
let key_indices: Vec<usize> = (0..key_desc.arity()).collect();
let key_desc = key_desc.with_key(key_indices.clone());
(key_desc.concat(value_desc), Some(key_indices))
}
KeyEnvelope::Named(key_name) => {
let key_desc = {
// if the key has multiple objects, nest them as a record inside of a single name
if key_desc.arity() > 1 {
let key_type = key_desc.typ();
let key_as_record = RelationType::new(vec![ColumnType {
nullable: false,
scalar_type: ScalarType::Record {
fields: key_desc
.iter_names()
.zip(key_type.column_types.iter())
.map(|(name, ty)| (name.clone(), ty.clone()))
.collect(),
custom_id: None,
},
}]);
RelationDesc::new(key_as_record, [key_name.to_string()])
} else {
key_desc.with_names([key_name.to_string()])
}
};
let (key_desc, key) = match self {
UnplannedSourceEnvelope::None(_) => (key_desc, None),
// If we're applying the upsert logic the key column will be unique
UnplannedSourceEnvelope::Upsert { .. } => {
(key_desc.with_key(vec![0]), Some(vec![0]))
}
_ => unreachable!(),
};
(key_desc.concat(value_desc), key)
}
};
let desc = keyed.concat(metadata_desc);
(
self.into_source_envelope(key, Some(key_arity), Some(desc.arity())),
desc,
)
}
UnplannedSourceEnvelope::Upsert {
style: UpsertStyle::Debezium { after_idx },
..
} => match &value_desc.typ().column_types[*after_idx].scalar_type {
ScalarType::Record { fields, .. } => {
let mut desc = RelationDesc::from_names_and_types(fields.clone());
let key = key_desc.map(|k| match_key_indices(&k, &desc)).transpose()?;
if let Some(key) = key.clone() {
desc = desc.with_key(key);
}
let desc = match self {
UnplannedSourceEnvelope::Upsert { .. } => desc.concat(metadata_desc),
_ => desc,
};
(
self.into_source_envelope(key, None, Some(desc.arity())),
desc,
)
}
ty => bail!(
"Incorrect type for Debezium value, expected Record, got {:?}",
ty
),
},
UnplannedSourceEnvelope::CdcV2 => {
// the correct types
// CdcV2 row data are in a record in a record in a list
match &value_desc.typ().column_types[0].scalar_type {
ScalarType::List { element_type, .. } => match &**element_type {
ScalarType::Record { fields, .. } => {
// TODO maybe check this by name
match &fields[0].1.scalar_type {
ScalarType::Record { fields, .. } => (
self.into_source_envelope(None, None, None),
RelationDesc::from_names_and_types(fields.clone()),
),
ty => {
bail!("Unexpected type for MATERIALIZE envelope: {:?}", ty)
}
}
}
ty => bail!("Unexpected type for MATERIALIZE envelope: {:?}", ty),
},
ty => bail!("Unexpected type for MATERIALIZE envelope: {:?}", ty),
}
}
})
}
}
/// Whether and how to include the decoded key of a stream in dataflows
#[derive(Arbitrary, Clone, Debug, Eq, PartialEq, Serialize, Deserialize)]
pub enum KeyEnvelope {
/// Never include the key in the output row
None,
/// For composite key encodings, pull the fields from the encoding into columns.
Flattened,
/// Always use the given name for the key.
///
/// * For a single-field key, this means that the column will get the given name.
/// * For a multi-column key, the columns will get packed into a [`ScalarType::Record`], and
/// that Record will get the given name.
Named(String),
}
impl RustType<ProtoKeyEnvelope> for KeyEnvelope {
fn into_proto(&self) -> ProtoKeyEnvelope {
use proto_key_envelope::Kind;
ProtoKeyEnvelope {
kind: Some(match self {
KeyEnvelope::None => Kind::None(()),
KeyEnvelope::Flattened => Kind::Flattened(()),
KeyEnvelope::Named(name) => Kind::Named(name.clone()),
}),
}
}
fn from_proto(proto: ProtoKeyEnvelope) -> Result<Self, TryFromProtoError> {
use proto_key_envelope::Kind;
let kind = proto
.kind
.ok_or_else(|| TryFromProtoError::missing_field("ProtoKeyEnvelope::kind"))?;
Ok(match kind {
Kind::None(()) => KeyEnvelope::None,
Kind::Flattened(()) => KeyEnvelope::Flattened,
Kind::Named(name) => KeyEnvelope::Named(name),
})
}
}