risingwave_meta/backup_restore/restore.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
// Copyright 2024 RisingWave Labs
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
use std::sync::Arc;
use risingwave_backup::error::{BackupError, BackupResult};
use risingwave_backup::meta_snapshot::Metadata;
use risingwave_backup::storage::{MetaSnapshotStorage, MetaSnapshotStorageRef};
use risingwave_backup::MetaSnapshotId;
use risingwave_common::config::{MetaBackend, ObjectStoreConfig};
use risingwave_hummock_sdk::version::HummockVersion;
use risingwave_hummock_sdk::version_checkpoint_path;
use risingwave_object_store::object::build_remote_object_store;
use risingwave_object_store::object::object_metrics::ObjectStoreMetrics;
use risingwave_pb::hummock::PbHummockVersionCheckpoint;
use thiserror_ext::AsReport;
use crate::backup_restore::restore_impl::v2::{LoaderV2, WriterModelV2ToMetaStoreV2};
use crate::backup_restore::restore_impl::{Loader, Writer};
use crate::backup_restore::utils::{get_backup_store, get_meta_store};
use crate::controller::SqlMetaStore;
/// Command-line arguments for restore.
#[derive(clap::Args, Debug, Clone)]
pub struct RestoreOpts {
/// Id of snapshot used to restore. Available snapshots can be found in
/// <`storage_directory>/manifest.json`.
#[clap(long)]
pub meta_snapshot_id: u64,
/// Type of meta store to restore.
#[clap(long, value_enum, default_value_t = MetaBackend::Mem)]
pub meta_store_type: MetaBackend,
#[clap(long, default_value_t = String::from(""))]
pub sql_endpoint: String,
/// Username of sql backend, required when meta backend set to MySQL or PostgreSQL.
#[clap(long, default_value = "")]
pub sql_username: String,
/// Password of sql backend, required when meta backend set to MySQL or PostgreSQL.
#[clap(long, default_value = "")]
pub sql_password: String,
/// Database of sql backend, required when meta backend set to MySQL or PostgreSQL.
#[clap(long, default_value = "")]
pub sql_database: String,
/// Url of storage to fetch meta snapshot from.
#[clap(long)]
pub backup_storage_url: String,
/// Directory of storage to fetch meta snapshot from.
#[clap(long, default_value_t = String::from("backup"))]
pub backup_storage_directory: String,
/// Url of storage to restore hummock version to.
#[clap(long)]
pub hummock_storage_url: String,
/// Directory of storage to restore hummock version to.
#[clap(long, default_value_t = String::from("hummock_001"))]
pub hummock_storage_directory: String,
/// Print the target snapshot, but won't restore to meta store.
#[clap(long)]
pub dry_run: bool,
/// The read timeout for object store
#[clap(long, default_value_t = 600000)]
pub read_attempt_timeout_ms: u64,
/// The maximum number of read retry attempts for the object store.
#[clap(long, default_value_t = 3)]
pub read_retry_attempts: u64,
}
async fn restore_hummock_version(
hummock_storage_url: &str,
hummock_storage_directory: &str,
hummock_version: &HummockVersion,
) -> BackupResult<()> {
let object_store = Arc::new(
build_remote_object_store(
hummock_storage_url,
Arc::new(ObjectStoreMetrics::unused()),
"Version Checkpoint",
Arc::new(ObjectStoreConfig::default()),
)
.await,
);
let checkpoint_path = version_checkpoint_path(hummock_storage_directory);
let checkpoint = PbHummockVersionCheckpoint {
version: Some(hummock_version.into()),
// Ignore stale objects. Full GC will clear them.
stale_objects: Default::default(),
};
use prost::Message;
let buf = checkpoint.encode_to_vec();
object_store
.upload(&checkpoint_path, buf.into())
.await
.map_err(|e| BackupError::StateStorage(e.into()))?;
Ok(())
}
/// Restores a meta store.
/// Uses `meta_store` and `backup_store` if provided.
/// Otherwise creates them based on `opts`.
async fn restore_impl(
opts: RestoreOpts,
meta_store: Option<SqlMetaStore>,
backup_store: Option<MetaSnapshotStorageRef>,
) -> BackupResult<()> {
if cfg!(not(test)) {
assert!(meta_store.is_none());
assert!(backup_store.is_none());
}
let meta_store = match meta_store {
None => get_meta_store(opts.clone()).await?,
Some(m) => m,
};
let backup_store = match backup_store {
None => get_backup_store(opts.clone()).await?,
Some(b) => b,
};
let target_id = opts.meta_snapshot_id;
let snapshot_list = &backup_store.manifest().snapshot_metadata;
if !snapshot_list.iter().any(|m| m.id == target_id) {
return Err(BackupError::Other(anyhow::anyhow!(
"snapshot id {} not found",
target_id
)));
}
let format_version = match snapshot_list.iter().find(|m| m.id == target_id) {
None => {
return Err(BackupError::Other(anyhow::anyhow!(
"snapshot id {} not found",
target_id
)));
}
Some(s) => s.format_version,
};
if format_version < 2 {
unimplemented!("not supported: write model V1 to meta store V2");
} else {
dispatch(
target_id,
&opts,
LoaderV2::new(backup_store),
WriterModelV2ToMetaStoreV2::new(meta_store.to_owned()),
)
.await?;
}
Ok(())
}
async fn dispatch<L: Loader<S>, W: Writer<S>, S: Metadata>(
target_id: MetaSnapshotId,
opts: &RestoreOpts,
loader: L,
writer: W,
) -> BackupResult<()> {
let target_snapshot = loader.load(target_id).await?;
if opts.dry_run {
return Ok(());
}
let hummock_version = target_snapshot.metadata.hummock_version_ref().clone();
writer.write(target_snapshot).await?;
restore_hummock_version(
&opts.hummock_storage_url,
&opts.hummock_storage_directory,
&hummock_version,
)
.await?;
Ok(())
}
pub async fn restore(opts: RestoreOpts) -> BackupResult<()> {
tracing::info!("restore with opts: {:#?}", opts);
let result = restore_impl(opts, None, None).await;
match &result {
Ok(_) => {
tracing::info!("command succeeded");
}
Err(e) => {
tracing::warn!(error = %e.as_report(), "command failed");
}
}
result
}
// #[cfg(test)]
// mod tests {
//
// // use risingwave_backup::meta_snapshot_v1::MetaSnapshotV1;
// // use risingwave_common::config::{MetaBackend, SystemConfig};
// // use risingwave_pb::meta::SystemParams;
// //
// // use crate::backup_restore::RestoreOpts;
//
// // type MetaSnapshot = MetaSnapshotV1;
//
// // fn get_restore_opts() -> RestoreOpts {
// // RestoreOpts {
// // meta_snapshot_id: 1,
// // meta_store_type: MetaBackend::Mem,
// // sql_endpoint: "".to_string(),
// // sql_username: "".to_string(),
// // sql_password: "".to_string(),
// // sql_database: "".to_string(),
// // backup_storage_url: "memory".to_string(),
// // backup_storage_directory: "".to_string(),
// // hummock_storage_url: "memory".to_string(),
// // hummock_storage_directory: "".to_string(),
// // dry_run: false,
// // read_attempt_timeout_ms: 60000,
// // read_retry_attempts: 3,
// // }
// // }
//
// // fn get_system_params() -> SystemParams {
// // SystemParams {
// // state_store: Some("state_store".into()),
// // data_directory: Some("data_directory".into()),
// // use_new_object_prefix_strategy: Some(true),
// // backup_storage_url: Some("backup_storage_url".into()),
// // backup_storage_directory: Some("backup_storage_directory".into()),
// // ..SystemConfig::default().into_init_system_params()
// // }
// // }
//
// // TODO: support in-memory sql restore tests.
// // #[tokio::test]
// // async fn test_restore_basic() {
// // let opts = get_restore_opts();
// // let backup_store = get_backup_store(opts.clone()).await.unwrap();
// // let nonempty_meta_store = get_meta_store(opts.clone()).await.unwrap();
// // dispatch_meta_store!(nonempty_meta_store.clone(), store, {
// // let stats = HummockVersionStats::default();
// // stats.insert(&store).await.unwrap();
// // });
// // let empty_meta_store = get_meta_store(opts.clone()).await.unwrap();
// // let system_param = get_system_params();
// // let snapshot = MetaSnapshot {
// // id: opts.meta_snapshot_id,
// // metadata: ClusterMetadata {
// // hummock_version: {
// // let mut version = HummockVersion::default();
// // version.id = HummockVersionId::new(123);
// // version
// // },
// // system_param: system_param.clone(),
// // ..Default::default()
// // },
// // ..Default::default()
// // };
// //
// // // target snapshot not found
// // restore_impl(opts.clone(), None, Some(backup_store.clone()))
// // .await
// // .unwrap_err();
// //
// // backup_store.create(&snapshot, None).await.unwrap();
// // restore_impl(opts.clone(), None, Some(backup_store.clone()))
// // .await
// // .unwrap();
// //
// // // target meta store not empty
// // restore_impl(
// // opts.clone(),
// // Some(nonempty_meta_store),
// // Some(backup_store.clone()),
// // )
// // .await
// // .unwrap_err();
// //
// // restore_impl(
// // opts.clone(),
// // Some(empty_meta_store.clone()),
// // Some(backup_store.clone()),
// // )
// // .await
// // .unwrap();
// //
// // dispatch_meta_store!(empty_meta_store, store, {
// // let restored_system_param = SystemParams::get(&store).await.unwrap().unwrap();
// // assert_eq!(restored_system_param, system_param);
// // });
// // }
// //
// // #[tokio::test]
// // async fn test_restore_default_cf() {
// // let opts = get_restore_opts();
// // let backup_store = get_backup_store(opts.clone()).await.unwrap();
// // let snapshot = MetaSnapshot {
// // id: opts.meta_snapshot_id,
// // metadata: ClusterMetadata {
// // default_cf: HashMap::from([(vec![1u8, 2u8], memcomparable::to_vec(&10).unwrap())]),
// // system_param: get_system_params(),
// // ..Default::default()
// // },
// // ..Default::default()
// // };
// // backup_store.create(&snapshot, None).await.unwrap();
// //
// // // `snapshot_2` is a superset of `snapshot`
// // let mut snapshot_2 = MetaSnapshot {
// // id: snapshot.id + 1,
// // ..snapshot.clone()
// // };
// // snapshot_2
// // .metadata
// // .default_cf
// // .insert(vec![1u8, 2u8], memcomparable::to_vec(&10).unwrap());
// // snapshot_2
// // .metadata
// // .default_cf
// // .insert(vec![10u8, 20u8], memcomparable::to_vec(&10).unwrap());
// // backup_store.create(&snapshot_2, None).await.unwrap();
// // let empty_meta_store = get_meta_store(opts.clone()).await.unwrap();
// // restore_impl(
// // opts.clone(),
// // Some(empty_meta_store.clone()),
// // Some(backup_store.clone()),
// // )
// // .await
// // .unwrap();
// // dispatch_meta_store!(empty_meta_store, store, {
// // let mut kvs = store
// // .list_cf(DEFAULT_COLUMN_FAMILY)
// // .await
// // .unwrap()
// // .into_iter()
// // .map(|(_, v)| v)
// // .collect_vec();
// // kvs.sort();
// // assert_eq!(
// // kvs,
// // vec![
// // memcomparable::to_vec(&10).unwrap(),
// // memcomparable::to_vec(&10).unwrap()
// // ]
// // );
// // });
// // }
// //
// // #[tokio::test]
// // #[should_panic]
// // async fn test_sanity_check_superset_requirement() {
// // let opts = get_restore_opts();
// // let backup_store = get_backup_store(opts.clone()).await.unwrap();
// // let snapshot = MetaSnapshot {
// // id: opts.meta_snapshot_id,
// // metadata: ClusterMetadata {
// // default_cf: HashMap::from([(vec![1u8, 2u8], memcomparable::to_vec(&10).unwrap())]),
// // system_param: get_system_params(),
// // ..Default::default()
// // },
// // ..Default::default()
// // };
// // backup_store.create(&snapshot, None).await.unwrap();
// //
// // // violate superset requirement
// // let mut snapshot_2 = MetaSnapshot {
// // id: snapshot.id + 1,
// // ..Default::default()
// // };
// // snapshot_2
// // .metadata
// // .default_cf
// // .insert(vec![10u8, 20u8], memcomparable::to_vec(&1).unwrap());
// // backup_store.create(&snapshot_2, None).await.unwrap();
// // restore_impl(opts.clone(), None, Some(backup_store.clone()))
// // .await
// // .unwrap();
// // }
// //
// // #[tokio::test]
// // #[should_panic]
// // async fn test_sanity_check_monotonicity_requirement() {
// // let opts = get_restore_opts();
// // let backup_store = get_backup_store(opts.clone()).await.unwrap();
// // let snapshot = MetaSnapshot {
// // id: opts.meta_snapshot_id,
// // metadata: ClusterMetadata {
// // default_cf: HashMap::from([(vec![1u8, 2u8], memcomparable::to_vec(&10).unwrap())]),
// // system_param: get_system_params(),
// // ..Default::default()
// // },
// // ..Default::default()
// // };
// // backup_store.create(&snapshot, None).await.unwrap();
// //
// // // violate monotonicity requirement
// // let mut snapshot_2 = MetaSnapshot {
// // id: snapshot.id + 1,
// // ..Default::default()
// // };
// // snapshot_2
// // .metadata
// // .default_cf
// // .insert(vec![1u8, 2u8], memcomparable::to_vec(&9).unwrap());
// // backup_store.create(&snapshot_2, None).await.unwrap();
// // restore_impl(opts.clone(), None, Some(backup_store.clone()))
// // .await
// // .unwrap();
// // }
// //
// // #[tokio::test]
// // async fn test_dry_run() {
// // let mut opts = get_restore_opts();
// // assert!(!opts.dry_run);
// // opts.dry_run = true;
// // let backup_store = get_backup_store(opts.clone()).await.unwrap();
// // let empty_meta_store = get_meta_store(opts.clone()).await.unwrap();
// // let system_param = get_system_params();
// // let snapshot = MetaSnapshot {
// // id: opts.meta_snapshot_id,
// // metadata: ClusterMetadata {
// // default_cf: HashMap::from([
// // (
// // "some_key_1".as_bytes().to_vec(),
// // memcomparable::to_vec(&10).unwrap(),
// // ),
// // (
// // "some_key_2".as_bytes().to_vec(),
// // memcomparable::to_vec(&"some_value_2".to_string()).unwrap(),
// // ),
// // ]),
// // hummock_version: {
// // let mut version = HummockVersion::default();
// // version.id = HummockVersionId::new(123);
// // version
// // },
// // system_param: system_param.clone(),
// // ..Default::default()
// // },
// // ..Default::default()
// // };
// // backup_store.create(&snapshot, None).await.unwrap();
// // restore_impl(
// // opts.clone(),
// // Some(empty_meta_store.clone()),
// // Some(backup_store.clone()),
// // )
// // .await
// // .unwrap();
// //
// // dispatch_meta_store!(empty_meta_store, store, {
// // assert!(SystemParams::get(&store).await.unwrap().is_none());
// // });
// // }
// }