mz_adapter/catalog/migrate.rs
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 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849
// 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.
use std::collections::BTreeMap;
use maplit::btreeset;
use mz_catalog::builtin::BuiltinTable;
use mz_catalog::durable::Transaction;
use mz_catalog::memory::objects::{BootstrapStateUpdateKind, StateUpdate};
use mz_ore::collections::CollectionExt;
use mz_ore::now::NowFn;
use mz_persist_types::ShardId;
use mz_repr::{CatalogItemId, Timestamp};
use mz_sql::ast::display::AstDisplay;
use mz_sql::names::FullItemName;
use mz_sql_parser::ast::{IdentError, Raw, Statement};
use mz_storage_client::controller::StorageTxn;
use semver::Version;
use tracing::info;
use uuid::Uuid;
// DO NOT add any more imports from `crate` outside of `crate::catalog`.
use crate::catalog::open::into_consolidatable_updates_startup;
use crate::catalog::state::LocalExpressionCache;
use crate::catalog::{BuiltinTableUpdate, CatalogState, ConnCatalog};
fn rewrite_ast_items<F>(tx: &mut Transaction<'_>, mut f: F) -> Result<(), anyhow::Error>
where
F: for<'a> FnMut(
&'a mut Transaction<'_>,
CatalogItemId,
&'a mut Statement<Raw>,
) -> Result<(), anyhow::Error>,
{
let mut updated_items = BTreeMap::new();
for mut item in tx.get_items() {
let mut stmt = mz_sql::parse::parse(&item.create_sql)?.into_element().ast;
f(tx, item.id, &mut stmt)?;
item.create_sql = stmt.to_ast_string_stable();
updated_items.insert(item.id, item);
}
tx.update_items(updated_items)?;
Ok(())
}
fn rewrite_items<F>(
tx: &mut Transaction<'_>,
cat: &ConnCatalog<'_>,
mut f: F,
) -> Result<(), anyhow::Error>
where
F: for<'a> FnMut(
&'a mut Transaction<'_>,
&'a &ConnCatalog<'_>,
CatalogItemId,
&'a mut Statement<Raw>,
) -> Result<(), anyhow::Error>,
{
let mut updated_items = BTreeMap::new();
let items = tx.get_items();
for mut item in items {
let mut stmt = mz_sql::parse::parse(&item.create_sql)?.into_element().ast;
f(tx, &cat, item.id, &mut stmt)?;
item.create_sql = stmt.to_ast_string_stable();
updated_items.insert(item.id, item);
}
tx.update_items(updated_items)?;
Ok(())
}
pub(crate) struct MigrateResult {
pub(crate) builtin_table_updates: Vec<BuiltinTableUpdate<&'static BuiltinTable>>,
pub(crate) post_item_updates: Vec<(BootstrapStateUpdateKind, Timestamp, i64)>,
}
/// Migrates all user items and loads them into `state`.
///
/// Returns the builtin updates corresponding to all user items.
pub(crate) async fn migrate(
state: &mut CatalogState,
tx: &mut Transaction<'_>,
local_expr_cache: &mut LocalExpressionCache,
item_updates: Vec<StateUpdate>,
now: NowFn,
_boot_ts: Timestamp,
) -> Result<MigrateResult, anyhow::Error> {
let catalog_version = tx.get_catalog_content_version();
let catalog_version = match catalog_version {
Some(v) => Version::parse(&v)?,
None => Version::new(0, 0, 0),
};
info!(
"migrating statements from catalog version {:?}",
catalog_version
);
// Special block for `ast_rewrite_sources_to_tables` migration
// since it requires a feature flag needs to update multiple AST items at once.
if state.system_config().force_source_table_syntax() {
ast_rewrite_sources_to_tables(tx, now)?;
}
rewrite_ast_items(tx, |_tx, _id, _stmt| {
// Add per-item AST migrations below.
//
// Each migration should be a function that takes `stmt` (the AST
// representing the creation SQL for the item) as input. Any
// mutations to `stmt` will be staged for commit to the catalog.
//
// Migration functions may also take `tx` as input to stage
// arbitrary changes to the catalog.
Ok(())
})?;
// Load items into catalog. We make sure to consolidate the old updates with the new updates to
// avoid trying to apply unmigrated items.
let commit_ts = tx.upper();
let mut item_updates = into_consolidatable_updates_startup(item_updates, commit_ts);
let op_item_updates = tx.get_and_commit_op_updates();
let op_item_updates = into_consolidatable_updates_startup(op_item_updates, commit_ts);
item_updates.extend(op_item_updates);
differential_dataflow::consolidation::consolidate_updates(&mut item_updates);
// Since some migrations might introduce non-item 'post-item' updates, we sequester those
// so they can be applied with other post-item updates after migrations to avoid
// accumulating negative diffs.
let (post_item_updates, item_updates): (Vec<_>, Vec<_>) = item_updates
.into_iter()
// The only post-item update kind we currently generate is to
// update storage collection metadata.
.partition(|(kind, _, _)| {
matches!(kind, BootstrapStateUpdateKind::StorageCollectionMetadata(_))
});
let item_updates = item_updates
.into_iter()
.map(|(kind, ts, diff)| StateUpdate {
kind: kind.into(),
ts,
diff: diff.try_into().expect("valid diff"),
})
.collect();
let mut ast_builtin_table_updates = state
.apply_updates_for_bootstrap(item_updates, local_expr_cache)
.await;
info!("migrating from catalog version {:?}", catalog_version);
let conn_cat = state.for_system_session();
rewrite_items(tx, &conn_cat, |_tx, _conn_cat, _id, _stmt| {
let _catalog_version = catalog_version.clone();
// Add per-item, post-planning AST migrations below. Most
// migrations should be in the above `rewrite_ast_items` block.
//
// Each migration should be a function that takes `item` (the AST
// representing the creation SQL for the item) as input. Any
// mutations to `item` will be staged for commit to the catalog.
//
// Be careful if you reference `conn_cat`. Doing so is *weird*,
// as you'll be rewriting the catalog while looking at it. If
// possible, make your migration independent of `conn_cat`, and only
// consider a single item at a time.
//
// Migration functions may also take `tx` as input to stage
// arbitrary changes to the catalog.
Ok(())
})?;
// Add whole-catalog migrations below.
//
// Each migration should be a function that takes `tx` and `conn_cat` as
// input and stages arbitrary transformations to the catalog on `tx`.
let op_item_updates = tx.get_and_commit_op_updates();
let item_builtin_table_updates = state
.apply_updates_for_bootstrap(op_item_updates, local_expr_cache)
.await;
ast_builtin_table_updates.extend(item_builtin_table_updates);
info!(
"migration from catalog version {:?} complete",
catalog_version
);
Ok(MigrateResult {
builtin_table_updates: ast_builtin_table_updates,
post_item_updates,
})
}
// Add new migrations below their appropriate heading, and precede them with a
// short summary of the migration's purpose and optional additional commentary
// about safety or approach.
//
// The convention is to name the migration function using snake case:
// > <category>_<description>_<version>
//
// Please include the adapter team on any code reviews that add or edit
// migrations.
/// Migrates all sources to use the new sources as tables model
///
/// First we migrate existing `CREATE SUBSOURCE` statements, turning them into
/// `CREATE TABLE .. FROM SOURCE` statements. This covers existing Postgres,
/// MySQL, and multi-output (tpch, auction, marketing) load-generator subsources.
///
/// Second we migrate existing `CREATE SOURCE` statements for these multi-output
/// sources to remove any subsource-specific options (e.g. TEXT COLUMNS).
///
/// Third we migrate existing single-output `CREATE SOURCE` statements.
/// This includes existing Kafka and single-output load-generator
/// subsources. This will generate an additional `CREATE TABLE .. FROM SOURCE`
/// statement that copies over all the export-specific options. This table will use
/// to the existing source statement's persist shard but use a new GlobalID.
/// The original source statement will be updated to remove the export-specific options,
/// renamed to `<original_name>_source`, and use a new empty shard while keeping its
/// same GlobalId.
///
fn ast_rewrite_sources_to_tables(
tx: &mut Transaction<'_>,
now: NowFn,
) -> Result<(), anyhow::Error> {
use maplit::btreemap;
use maplit::btreeset;
use mz_persist_types::ShardId;
use mz_proto::RustType;
use mz_sql::ast::{
CreateSourceConnection, CreateSourceStatement, CreateSubsourceOptionName,
CreateSubsourceStatement, CreateTableFromSourceStatement, Ident,
KafkaSourceConfigOptionName, LoadGenerator, MySqlConfigOptionName, PgConfigOptionName,
RawItemName, TableFromSourceColumns, TableFromSourceOption, TableFromSourceOptionName,
UnresolvedItemName, Value, WithOptionValue,
};
use mz_storage_client::controller::StorageTxn;
use mz_storage_types::sources::load_generator::LoadGeneratorOutput;
use mz_storage_types::sources::SourceExportStatementDetails;
use prost::Message;
let items_with_statements = tx
.get_items()
.map(|item| {
let stmt = mz_sql::parse::parse(&item.create_sql)?.into_element().ast;
Ok((item, stmt))
})
.collect::<Result<Vec<_>, anyhow::Error>>()?;
let items_with_statements_copied = items_with_statements.clone();
let item_names_per_schema = items_with_statements_copied
.iter()
.map(|(item, _)| (item.schema_id.clone(), &item.name))
.fold(BTreeMap::new(), |mut acc, (schema_id, name)| {
acc.entry(schema_id)
.or_insert_with(|| btreeset! {})
.insert(name);
acc
});
// Any CatalogItemId that should be changed to a new CatalogItemId in any statements that
// reference it. This is necessary for ensuring downstream statements (e.g.
// mat views, indexes) that reference a single-output source (e.g. kafka)
// will now reference the corresponding new table, with the same data, instead.
let mut changed_ids = BTreeMap::new();
for (mut item, stmt) in items_with_statements {
match stmt {
// Migrate each `CREATE SUBSOURCE` statement to an equivalent
// `CREATE TABLE ... FROM SOURCE` statement.
Statement::CreateSubsource(CreateSubsourceStatement {
name,
columns,
constraints,
of_source,
if_not_exists,
mut with_options,
}) => {
let raw_source_name = match of_source {
// If `of_source` is None then this is a `progress` subsource which we
// are not migrating as they are not currently relevant to the new table model.
None => continue,
Some(name) => name,
};
let source = match raw_source_name {
// Some legacy subsources have named-only references to their `of_source`
// so we ensure we always use an ID-based reference in the stored
// `CREATE TABLE ... FROM SOURCE` statements.
RawItemName::Name(name) => {
// Convert the name reference to an ID reference.
let (source_item, _) = items_with_statements_copied
.iter()
.find(|(_, statement)| match statement {
Statement::CreateSource(stmt) => stmt.name == name,
_ => false,
})
.expect("source must exist");
RawItemName::Id(source_item.id.to_string(), name, None)
}
RawItemName::Id(..) => raw_source_name,
};
// The external reference is a `with_option` on subsource statements but is a
// separate field on table statements.
let external_reference = match with_options
.iter()
.position(|opt| opt.name == CreateSubsourceOptionName::ExternalReference)
{
Some(i) => match with_options.remove(i).value {
Some(WithOptionValue::UnresolvedItemName(name)) => name,
_ => unreachable!("external reference must be an unresolved item name"),
},
None => panic!("subsource must have an external reference"),
};
let with_options = with_options
.into_iter()
.map(|option| {
match option.name {
CreateSubsourceOptionName::Details => TableFromSourceOption {
name: TableFromSourceOptionName::Details,
// The `details` option on both subsources and tables is identical, using the same
// ProtoSourceExportStatementDetails serialized value.
value: option.value,
},
CreateSubsourceOptionName::TextColumns => TableFromSourceOption {
name: TableFromSourceOptionName::TextColumns,
value: option.value,
},
CreateSubsourceOptionName::ExcludeColumns => TableFromSourceOption {
name: TableFromSourceOptionName::ExcludeColumns,
value: option.value,
},
CreateSubsourceOptionName::Progress => {
panic!("progress option should not exist on this subsource")
}
CreateSubsourceOptionName::ExternalReference => {
unreachable!("This option is handled separately above.")
}
}
})
.collect::<Vec<_>>();
let table = CreateTableFromSourceStatement {
name,
constraints,
columns: mz_sql::ast::TableFromSourceColumns::Defined(columns),
if_not_exists,
source,
external_reference: Some(external_reference.clone()),
with_options,
// Subsources don't have `envelope`, `include_metadata`, or `format` options.
envelope: None,
include_metadata: vec![],
format: None,
};
info!(
"migrate: converted subsource {} to table {}",
item.create_sql, table
);
item.create_sql = Statement::CreateTableFromSource(table).to_ast_string_stable();
tx.update_item(item.id, item)?;
}
// Postgres sources are multi-output sources whose subsources are
// migrated above. All we need to do is remove the subsource-related
// options from this statement since they are no longer relevant.
Statement::CreateSource(CreateSourceStatement {
connection:
mut conn @ (CreateSourceConnection::Postgres { .. }
| CreateSourceConnection::Yugabyte { .. }),
name,
if_not_exists,
in_cluster,
include_metadata,
format,
envelope,
col_names,
with_options,
key_constraint,
external_references,
progress_subsource,
}) => {
let options = match &mut conn {
CreateSourceConnection::Postgres { options, .. } => options,
CreateSourceConnection::Yugabyte { options, .. } => options,
_ => unreachable!("match determined above"),
};
// This option storing text columns on the primary source statement is redundant
// with the option on subsource statements so can just be removed.
// This was kept for round-tripping of `CREATE SOURCE` statements that automatically
// generated subsources, which is no longer necessary.
if options
.iter()
.any(|o| matches!(o.name, PgConfigOptionName::TextColumns))
{
options.retain(|o| !matches!(o.name, PgConfigOptionName::TextColumns));
let stmt = Statement::CreateSource(CreateSourceStatement {
connection: conn,
name,
if_not_exists,
in_cluster,
include_metadata,
format,
envelope,
col_names,
with_options,
key_constraint,
external_references,
progress_subsource,
});
item.create_sql = stmt.to_ast_string_stable();
tx.update_item(item.id, item)?;
info!("migrate: converted postgres source {stmt} to remove subsource options");
}
}
// MySQL sources are multi-output sources whose subsources are
// migrated above. All we need to do is remove the subsource-related
// options from this statement since they are no longer relevant.
Statement::CreateSource(CreateSourceStatement {
connection: mut conn @ CreateSourceConnection::MySql { .. },
name,
if_not_exists,
in_cluster,
include_metadata,
format,
envelope,
col_names,
with_options,
key_constraint,
external_references,
progress_subsource,
..
}) => {
let options = match &mut conn {
CreateSourceConnection::MySql { options, .. } => options,
_ => unreachable!("match determined above"),
};
// These options storing text and exclude columns on the primary source statement
// are redundant with the options on subsource statements so can just be removed.
// They was kept for round-tripping of `CREATE SOURCE` statements that automatically
// generated subsources, which is no longer necessary.
if options.iter().any(|o| {
matches!(
o.name,
MySqlConfigOptionName::TextColumns | MySqlConfigOptionName::ExcludeColumns
)
}) {
options.retain(|o| {
!matches!(
o.name,
MySqlConfigOptionName::TextColumns
| MySqlConfigOptionName::ExcludeColumns
)
});
let stmt = Statement::CreateSource(CreateSourceStatement {
connection: conn,
name,
if_not_exists,
in_cluster,
include_metadata,
format,
envelope,
col_names,
with_options,
key_constraint,
external_references,
progress_subsource,
});
item.create_sql = stmt.to_ast_string_stable();
tx.update_item(item.id, item)?;
info!("migrate: converted mysql source {stmt} to remove subsource options");
}
}
// Multi-output load generator sources whose subsources are already
// migrated above. There is no need to remove any options from this
// statement since they are not export-specific.
Statement::CreateSource(CreateSourceStatement {
connection:
CreateSourceConnection::LoadGenerator {
generator:
LoadGenerator::Auction | LoadGenerator::Marketing | LoadGenerator::Tpch,
..
},
..
}) => {}
// Single-output sources that need to be migrated to tables. These sources currently output
// data to the primary collection of the source statement. We will create a new table
// statement for them and move all export-specific options over from the source statement,
// while moving the `CREATE SOURCE` statement to a new name and moving its shard to the
// new table statement.
Statement::CreateSource(CreateSourceStatement {
connection:
conn @ (CreateSourceConnection::Kafka { .. }
| CreateSourceConnection::LoadGenerator {
generator:
LoadGenerator::Clock
| LoadGenerator::Datums
| LoadGenerator::Counter
| LoadGenerator::KeyValue,
..
}),
name,
col_names,
include_metadata,
format,
envelope,
with_options,
if_not_exists,
in_cluster,
progress_subsource,
external_references,
key_constraint,
}) => {
// To check if this is a source that has already been migrated we use a basic
// heuristic: if there is at least one existing table for the source, and if
// the envelope/format/include_metadata options are empty, we assume it's
// already been migrated.
let tables_for_source =
items_with_statements_copied
.iter()
.any(|(_, statement)| match statement {
Statement::CreateTableFromSource(stmt) => {
let source: CatalogItemId = match &stmt.source {
RawItemName::Name(_) => {
unreachable!("tables store source as ID")
}
RawItemName::Id(source_id, _, _) => {
source_id.parse().expect("valid id")
}
};
source == item.id
}
_ => false,
});
if tables_for_source
&& envelope.is_none()
&& format.is_none()
&& include_metadata.is_empty()
{
info!("migrate: skipping already migrated source: {}", name);
continue;
}
// Use the current source name as the new table name, and rename the source to
// `<source_name>_source`. This is intended to allow users to continue using
// queries that reference the source name, since they will now need to query the
// table instead.
assert_eq!(
item.name,
name.0.last().expect("at least one ident").to_string()
);
// First find an unused name within the same schema to avoid conflicts.
let is_valid = |new_source_ident: &Ident| {
if item_names_per_schema
.get(&item.schema_id)
.expect("schema must exist")
.contains(&new_source_ident.to_string())
{
Ok::<_, IdentError>(false)
} else {
Ok(true)
}
};
let new_source_ident =
Ident::try_generate_name(item.name.clone(), "_source", is_valid)?;
// We will use the original item name for the new table item.
let table_item_name = item.name.clone();
// Update the source item/statement to use the new name.
let mut new_source_name = name.clone();
*new_source_name.0.last_mut().expect("at least one ident") =
new_source_ident.clone();
item.name = new_source_ident.to_string();
// A reference to the source that will be included in the table statement
let source_ref =
RawItemName::Id(item.id.to_string(), new_source_name.clone(), None);
let columns = if col_names.is_empty() {
TableFromSourceColumns::NotSpecified
} else {
TableFromSourceColumns::Named(col_names)
};
// All source tables must have a `details` option, which is a serialized proto
// describing any source-specific details for this table statement.
let details = match &conn {
// For kafka sources this proto is currently empty.
CreateSourceConnection::Kafka { .. } => SourceExportStatementDetails::Kafka {},
CreateSourceConnection::LoadGenerator { .. } => {
// Since these load generators are single-output we use the default output.
SourceExportStatementDetails::LoadGenerator {
output: LoadGeneratorOutput::Default,
}
}
_ => unreachable!("match determined above"),
};
let table_with_options = vec![TableFromSourceOption {
name: TableFromSourceOptionName::Details,
value: Some(WithOptionValue::Value(Value::String(hex::encode(
details.into_proto().encode_to_vec(),
)))),
}];
// Generate the same external-reference that would have been generated
// during purification for single-output sources.
let external_reference = match &conn {
CreateSourceConnection::Kafka { options, .. } => {
let topic_option = options
.iter()
.find(|o| matches!(o.name, KafkaSourceConfigOptionName::Topic))
.expect("kafka sources must have a topic");
let topic = match &topic_option.value {
Some(WithOptionValue::Value(Value::String(topic))) => topic,
_ => unreachable!("topic must be a string"),
};
Some(UnresolvedItemName::qualified(&[Ident::new(topic)?]))
}
CreateSourceConnection::LoadGenerator { generator, .. } => {
// Since these load generators are single-output the external reference
// uses the schema-name for both namespace and name.
let name = FullItemName {
database: mz_sql::names::RawDatabaseSpecifier::Name(
mz_storage_types::sources::load_generator::LOAD_GENERATOR_DATABASE_NAME
.to_owned(),
),
schema: generator.schema_name().to_string(),
item: generator.schema_name().to_string(),
};
Some(UnresolvedItemName::from(name))
}
_ => unreachable!("match determined above"),
};
// The new table statement, stealing the name and the export-specific fields from
// the create source statement.
let table = CreateTableFromSourceStatement {
name,
constraints: vec![],
columns,
if_not_exists: false,
source: source_ref,
external_reference,
with_options: table_with_options,
envelope,
include_metadata,
format,
};
// The source statement with a new name and many of its fields emptied
let source = CreateSourceStatement {
connection: conn,
name: new_source_name,
if_not_exists,
in_cluster,
include_metadata: vec![],
format: None,
envelope: None,
col_names: vec![],
with_options,
key_constraint,
external_references,
progress_subsource,
};
let source_id = item.id;
let source_global_id = item.global_id;
let schema_id = item.schema_id.clone();
let schema = tx.get_schema(&item.schema_id).expect("schema must exist");
let owner_id = item.owner_id.clone();
let privileges = item.privileges.clone();
let extra_versions = item.extra_versions.clone();
// Update the source statement in the catalog first, since the name will
// otherwise conflict with the new table statement.
info!("migrate: updated source {} to {source}", item.create_sql);
item.create_sql = Statement::CreateSource(source).to_ast_string_stable();
tx.update_item(item.id, item)?;
// Insert the new table statement into the catalog with a new id.
let ids = tx.allocate_user_item_ids(1)?;
let (new_table_id, new_table_global_id) = ids[0];
info!("migrate: added table {new_table_id}: {table}");
tx.insert_user_item(
new_table_id,
new_table_global_id,
schema_id,
&table_item_name,
table.to_ast_string_stable(),
owner_id,
privileges,
&Default::default(),
extra_versions,
)?;
// We need to move the shard currently attached to the source statement to the
// table statement such that the existing data in the shard is preserved and can
// be queried on the new table statement. However, we need to keep the GlobalId of
// the source the same, to preserve existing references to that statement in
// external tools such as DBT and Terraform. We will insert a new shard for the source
// statement which will be automatically created after the migration is complete.
let new_source_shard = ShardId::new();
let (source_global_id, existing_source_shard) = tx
.delete_collection_metadata(btreeset! {source_global_id})
.pop()
.expect("shard should exist");
tx.insert_collection_metadata(btreemap! {
new_table_global_id => existing_source_shard,
source_global_id => new_source_shard
})?;
add_to_audit_log(
tx,
mz_audit_log::EventType::Create,
mz_audit_log::ObjectType::Table,
mz_audit_log::EventDetails::IdFullNameV1(mz_audit_log::IdFullNameV1 {
id: new_table_id.to_string(),
name: mz_audit_log::FullNameV1 {
database: schema
.database_id
.map(|d| d.to_string())
.unwrap_or_default(),
schema: schema.name,
item: table_item_name,
},
}),
now(),
)?;
// We also need to update any other statements that reference the source to use the new
// table id/name instead.
changed_ids.insert(source_id, new_table_id);
}
#[expect(unreachable_patterns)]
Statement::CreateSource(_) => {}
_ => (),
}
}
let mut updated_items = BTreeMap::new();
for (mut item, mut statement) in items_with_statements_copied {
match &statement {
// Don’t rewrite any of the statements we just migrated.
Statement::CreateSource(_) => {}
Statement::CreateSubsource(_) => {}
Statement::CreateTableFromSource(_) => {}
// We need to rewrite any statements that reference a source id to use the new
// table id instead, since any contained data in the source will now be in the table.
// This assumes the table has stolen the source's name, which is the case
// for all sources that were migrated.
_ => {
if mz_sql::names::modify_dependency_item_ids(&mut statement, &changed_ids) {
info!("migrate: updated dependency reference in statement {statement}");
item.create_sql = statement.to_ast_string_stable();
updated_items.insert(item.id, item);
}
}
}
}
if !updated_items.is_empty() {
tx.update_items(updated_items)?;
}
Ok(())
}
// Durable migrations
/// Migrations that run only on the durable catalog before any data is loaded into memory.
pub(crate) fn durable_migrate(
tx: &mut Transaction,
_organization_id: Uuid,
_boot_ts: Timestamp,
) -> Result<(), anyhow::Error> {
// Migrate the expression cache to a new shard. We're updating the keys to use the explicit
// binary version instead of the deploy generation.
const EXPR_CACHE_MIGRATION_KEY: &str = "expr_cache_migration";
const EXPR_CACHE_MIGRATION_DONE: u64 = 1;
if tx.get_config(EXPR_CACHE_MIGRATION_KEY.to_string()) != Some(EXPR_CACHE_MIGRATION_DONE) {
if let Some(shard_id) = tx.get_expression_cache_shard() {
tx.mark_shards_as_finalized(btreeset! {shard_id});
tx.set_expression_cache_shard(ShardId::new())?;
}
tx.set_config(
EXPR_CACHE_MIGRATION_KEY.to_string(),
Some(EXPR_CACHE_MIGRATION_DONE),
)?;
}
// Migrate the builtin migration shard to a new shard. We're updating the keys to use the explicit
// binary version instead of the deploy generation.
const BUILTIN_MIGRATION_SHARD_MIGRATION_KEY: &str = "migration_shard_migration";
const BUILTIN_MIGRATION_SHARD_MIGRATION_DONE: u64 = 1;
if tx.get_config(BUILTIN_MIGRATION_SHARD_MIGRATION_KEY.to_string())
!= Some(BUILTIN_MIGRATION_SHARD_MIGRATION_DONE)
{
if let Some(shard_id) = tx.get_builtin_migration_shard() {
tx.mark_shards_as_finalized(btreeset! {shard_id});
tx.set_builtin_migration_shard(ShardId::new())?;
}
tx.set_config(
BUILTIN_MIGRATION_SHARD_MIGRATION_KEY.to_string(),
Some(BUILTIN_MIGRATION_SHARD_MIGRATION_DONE),
)?;
}
Ok(())
}
// Add new migrations below their appropriate heading, and precede them with a
// short summary of the migration's purpose and optional additional commentary
// about safety or approach.
//
// The convention is to name the migration function using snake case:
// > <category>_<description>_<version>
//
// Please include the adapter team on any code reviews that add or edit
// migrations.
fn add_to_audit_log(
tx: &mut Transaction,
event_type: mz_audit_log::EventType,
object_type: mz_audit_log::ObjectType,
details: mz_audit_log::EventDetails,
occurred_at: mz_ore::now::EpochMillis,
) -> Result<(), anyhow::Error> {
let id = tx.get_and_increment_id(mz_catalog::durable::AUDIT_LOG_ID_ALLOC_KEY.to_string())?;
let event =
mz_audit_log::VersionedEvent::new(id, event_type, object_type, details, None, occurred_at);
tx.insert_audit_log_event(event);
Ok(())
}