deltalake_core/operations/transaction/mod.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
//! Add a commit entry to the Delta Table.
//! This module provides a unified interface for modifying commit behavior and attributes
//!
//! [`CommitProperties`] provides an unified client interface for all Delta opeartions.
//! Internally this is used to initialize a [`CommitBuilder`].
//!
//! For advanced use cases [`CommitBuilder`] can be used which allows
//! finer control over the commit process. The builder can be converted
//! into a future the yield either a [`PreparedCommit`] or a [`FinalizedCommit`].
//!
//! A [`PreparedCommit`] represents a temporary commit marker written to storage.
//! To convert to a [`FinalizedCommit`] an atomic rename is attempted. If the rename fails
//! then conflict resolution is performed and the atomic rename is tried for the latest version.
//!
//!<pre>
//! Client Interface
//! ┌─────────────────────────────┐
//! │ Commit Properties │
//! │ │
//! │ Public commit interface for │
//! │ all Delta Operations │
//! │ │
//! └─────────────┬───────────────┘
//! │
//! ─────────────────────┼────────────────────────────────────
//! │
//! ▼ Advanced Interface
//! ┌─────────────────────────────┐
//! │ Commit Builder │
//! │ │
//! │ Advanced entry point for │
//! │ creating a commit │
//! └─────────────┬───────────────┘
//! │
//! ▼
//! ┌───────────────────────────────────┐
//! │ │
//! │ ┌───────────────────────────────┐ │
//! │ │ Prepared Commit │ │
//! │ │ │ │
//! │ │ Represents a temporary │ │
//! │ │ commit marker written to │ │
//! │ │ storage │ │
//! │ └──────────────┬────────────────┘ │
//! │ │ │
//! │ ▼ │
//! │ ┌───────────────────────────────┐ │
//! │ │ Finalize Commit │ │
//! │ │ │ │
//! │ │ Convert the commit marker │ │
//! │ │ to a commit using atomic │ │
//! │ │ operations │ │
//! │ │ │ │
//! │ └───────────────────────────────┘ │
//! │ │
//! └────────────────┬──────────────────┘
//! │
//! ▼
//! ┌───────────────────────────────┐
//! │ Post Commit │
//! │ │
//! │ Commit that was materialized │
//! │ to storage with post commit │
//! │ hooks to be executed │
//! └──────────────┬────────────────┘
//! │
//! ▼
//! ┌───────────────────────────────┐
//! │ Finalized Commit │
//! │ │
//! │ Commit that was materialized │
//! │ to storage │
//! │ │
//! └───────────────────────────────┘
//!</pre>
use std::collections::HashMap;
use bytes::Bytes;
use chrono::Utc;
use conflict_checker::ConflictChecker;
use futures::future::BoxFuture;
use object_store::path::Path;
use object_store::Error as ObjectStoreError;
use serde_json::Value;
use self::conflict_checker::{TransactionInfo, WinningCommitSummary};
use crate::checkpoints::{cleanup_expired_logs_for, create_checkpoint_for};
use crate::errors::DeltaTableError;
use crate::kernel::{
Action, CommitInfo, EagerSnapshot, Metadata, Protocol, ReaderFeatures, Transaction,
WriterFeatures,
};
use crate::logstore::{CommitOrBytes, LogStoreRef};
use crate::protocol::DeltaOperation;
use crate::storage::ObjectStoreRef;
use crate::table::config::TableConfig;
use crate::table::state::DeltaTableState;
use crate::{crate_version, DeltaResult};
pub use self::conflict_checker::CommitConflictError;
pub use self::protocol::INSTANCE as PROTOCOL;
#[cfg(test)]
pub(crate) mod application;
mod conflict_checker;
mod protocol;
#[cfg(feature = "datafusion")]
mod state;
const DELTA_LOG_FOLDER: &str = "_delta_log";
pub(crate) const DEFAULT_RETRIES: usize = 15;
/// Error raised while commititng transaction
#[derive(thiserror::Error, Debug)]
pub enum TransactionError {
/// Version already exists
#[error("Tried committing existing table version: {0}")]
VersionAlreadyExists(i64),
/// Error returned when reading the delta log object failed.
#[error("Error serializing commit log to json: {json_err}")]
SerializeLogJson {
/// Commit log record JSON serialization error.
json_err: serde_json::error::Error,
},
/// Error returned when reading the delta log object failed.
#[error("Log storage error: {}", .source)]
ObjectStore {
/// Storage error details when reading the delta log object failed.
#[from]
source: ObjectStoreError,
},
/// Error returned when a commit conflict ocurred
#[error("Failed to commit transaction: {0}")]
CommitConflict(#[from] CommitConflictError),
/// Error returned when maximum number of commit trioals is exceeded
#[error("Failed to commit transaction: {0}")]
MaxCommitAttempts(i32),
/// The transaction includes Remove action with data change but Delta table is append-only
#[error(
"The transaction includes Remove action with data change but Delta table is append-only"
)]
DeltaTableAppendOnly,
/// Error returned when unsupported reader features are required
#[error("Unsupported reader features required: {0:?}")]
UnsupportedReaderFeatures(Vec<ReaderFeatures>),
/// Error returned when unsupported writer features are required
#[error("Unsupported writer features required: {0:?}")]
UnsupportedWriterFeatures(Vec<WriterFeatures>),
/// Error returned when writer features are required but not specified
#[error("Writer features must be specified for writerversion >= 7, please specify: {0:?}")]
WriterFeaturesRequired(WriterFeatures),
/// Error returned when reader features are required but not specified
#[error("Reader features must be specified for reader version >= 3, please specify: {0:?}")]
ReaderFeaturesRequired(ReaderFeatures),
/// The transaction failed to commit due to an error in an implementation-specific layer.
/// Currently used by DynamoDb-backed S3 log store when database operations fail.
#[error("Transaction failed: {msg}")]
LogStoreError {
/// Detailed message for the commit failure.
msg: String,
/// underlying error in the log store transactional layer.
source: Box<dyn std::error::Error + Send + Sync + 'static>,
},
}
impl From<TransactionError> for DeltaTableError {
fn from(err: TransactionError) -> Self {
match err {
TransactionError::VersionAlreadyExists(version) => {
DeltaTableError::VersionAlreadyExists(version)
}
TransactionError::SerializeLogJson { json_err } => {
DeltaTableError::SerializeLogJson { json_err }
}
TransactionError::ObjectStore { source } => DeltaTableError::ObjectStore { source },
other => DeltaTableError::Transaction { source: other },
}
}
}
/// Error raised while commititng transaction
#[derive(thiserror::Error, Debug)]
pub enum CommitBuilderError {}
impl From<CommitBuilderError> for DeltaTableError {
fn from(err: CommitBuilderError) -> Self {
DeltaTableError::CommitValidation { source: err }
}
}
/// Reference to some structure that contains mandatory attributes for performing a commit.
pub trait TableReference: Send + Sync {
/// Well known table configuration
fn config(&self) -> TableConfig;
/// Get the table protocol of the snapshot
fn protocol(&self) -> &Protocol;
/// Get the table metadata of the snapshot
fn metadata(&self) -> &Metadata;
/// Try to cast this table reference to a `EagerSnapshot`
fn eager_snapshot(&self) -> &EagerSnapshot;
}
impl TableReference for EagerSnapshot {
fn protocol(&self) -> &Protocol {
EagerSnapshot::protocol(self)
}
fn metadata(&self) -> &Metadata {
EagerSnapshot::metadata(self)
}
fn config(&self) -> TableConfig {
self.table_config()
}
fn eager_snapshot(&self) -> &EagerSnapshot {
self
}
}
impl TableReference for DeltaTableState {
fn config(&self) -> TableConfig {
self.snapshot.config()
}
fn protocol(&self) -> &Protocol {
self.snapshot.protocol()
}
fn metadata(&self) -> &Metadata {
self.snapshot.metadata()
}
fn eager_snapshot(&self) -> &EagerSnapshot {
&self.snapshot
}
}
/// Data that was actually written to the log store.
#[derive(Debug)]
pub struct CommitData {
/// The actions
pub actions: Vec<Action>,
/// The Operation
pub operation: DeltaOperation,
/// The Metadata
pub app_metadata: HashMap<String, Value>,
/// Application specific transaction
pub app_transactions: Vec<Transaction>,
}
impl CommitData {
/// Create new data to be comitted
pub fn new(
mut actions: Vec<Action>,
operation: DeltaOperation,
mut app_metadata: HashMap<String, Value>,
app_transactions: Vec<Transaction>,
) -> Self {
if !actions.iter().any(|a| matches!(a, Action::CommitInfo(..))) {
let mut commit_info = operation.get_commit_info();
commit_info.timestamp = Some(Utc::now().timestamp_millis());
app_metadata.insert(
"clientVersion".to_string(),
Value::String(format!("delta-rs.{}", crate_version())),
);
app_metadata.extend(commit_info.info);
commit_info.info = app_metadata.clone();
actions.push(Action::CommitInfo(commit_info))
}
for txn in &app_transactions {
actions.push(Action::Txn(txn.clone()))
}
CommitData {
actions,
operation,
app_metadata,
app_transactions,
}
}
/// Obtain the byte representation of the commit.
pub fn get_bytes(&self) -> Result<bytes::Bytes, TransactionError> {
let mut jsons = Vec::<String>::new();
for action in &self.actions {
let json = serde_json::to_string(action)
.map_err(|e| TransactionError::SerializeLogJson { json_err: e })?;
jsons.push(json);
}
Ok(bytes::Bytes::from(jsons.join("\n")))
}
}
#[derive(Clone, Debug, Copy)]
/// Properties for post commit hook.
pub struct PostCommitHookProperties {
create_checkpoint: bool,
/// Override the EnableExpiredLogCleanUp setting, if None config setting is used
cleanup_expired_logs: Option<bool>,
}
#[derive(Clone, Debug)]
/// End user facing interface to be used by operations on the table.
/// Enable controling commit behaviour and modifying metadata that is written during a commit.
pub struct CommitProperties {
pub(crate) app_metadata: HashMap<String, Value>,
pub(crate) app_transaction: Vec<Transaction>,
max_retries: usize,
create_checkpoint: bool,
cleanup_expired_logs: Option<bool>,
}
impl Default for CommitProperties {
fn default() -> Self {
Self {
app_metadata: Default::default(),
app_transaction: Vec::new(),
max_retries: DEFAULT_RETRIES,
create_checkpoint: true,
cleanup_expired_logs: None,
}
}
}
impl CommitProperties {
/// Specify metadata the be comitted
pub fn with_metadata(
mut self,
metadata: impl IntoIterator<Item = (String, serde_json::Value)>,
) -> Self {
self.app_metadata = HashMap::from_iter(metadata);
self
}
/// Specify maximum number of times to retry the transaction before failing to commit
pub fn with_max_retries(mut self, max_retries: usize) -> Self {
self.max_retries = max_retries;
self
}
/// Specify if it should create a checkpoint when the commit interval condition is met
pub fn with_create_checkpoint(mut self, create_checkpoint: bool) -> Self {
self.create_checkpoint = create_checkpoint;
self
}
/// Add an additonal application transaction to the commit
pub fn with_application_transaction(mut self, txn: Transaction) -> Self {
self.app_transaction.push(txn);
self
}
/// Override application transactions for the commit
pub fn with_application_transactions(mut self, txn: Vec<Transaction>) -> Self {
self.app_transaction = txn;
self
}
/// Specify if it should clean up the logs when the logRetentionDuration interval is met
pub fn with_cleanup_expired_logs(mut self, cleanup_expired_logs: Option<bool>) -> Self {
self.cleanup_expired_logs = cleanup_expired_logs;
self
}
}
impl From<CommitProperties> for CommitBuilder {
fn from(value: CommitProperties) -> Self {
CommitBuilder {
max_retries: value.max_retries,
app_metadata: value.app_metadata,
post_commit_hook: Some(PostCommitHookProperties {
create_checkpoint: value.create_checkpoint,
cleanup_expired_logs: value.cleanup_expired_logs,
}),
app_transaction: value.app_transaction,
..Default::default()
}
}
}
/// Prepare data to be committed to the Delta log and control how the commit is performed
pub struct CommitBuilder {
actions: Vec<Action>,
app_metadata: HashMap<String, Value>,
app_transaction: Vec<Transaction>,
max_retries: usize,
post_commit_hook: Option<PostCommitHookProperties>,
}
impl Default for CommitBuilder {
fn default() -> Self {
CommitBuilder {
actions: Vec::new(),
app_metadata: HashMap::new(),
app_transaction: Vec::new(),
max_retries: DEFAULT_RETRIES,
post_commit_hook: None,
}
}
}
impl<'a> CommitBuilder {
/// Actions to be included in the commit
pub fn with_actions(mut self, actions: Vec<Action>) -> Self {
self.actions = actions;
self
}
/// Metadata for the operation performed like metrics, user, and notebook
pub fn with_app_metadata(mut self, app_metadata: HashMap<String, Value>) -> Self {
self.app_metadata = app_metadata;
self
}
/// Maximum number of times to retry the transaction before failing to commit
pub fn with_max_retries(mut self, max_retries: usize) -> Self {
self.max_retries = max_retries;
self
}
/// Specify all the post commit hook properties
pub fn with_post_commit_hook(mut self, post_commit_hook: PostCommitHookProperties) -> Self {
self.post_commit_hook = Some(post_commit_hook);
self
}
/// Prepare a Commit operation using the configured builder
pub fn build(
self,
table_data: Option<&'a dyn TableReference>,
log_store: LogStoreRef,
operation: DeltaOperation,
) -> PreCommit<'a> {
let data = CommitData::new(
self.actions,
operation,
self.app_metadata,
self.app_transaction,
);
PreCommit {
log_store,
table_data,
max_retries: self.max_retries,
data,
post_commit_hook: self.post_commit_hook,
}
}
}
/// Represents a commit that has not yet started but all details are finalized
pub struct PreCommit<'a> {
log_store: LogStoreRef,
table_data: Option<&'a dyn TableReference>,
data: CommitData,
max_retries: usize,
post_commit_hook: Option<PostCommitHookProperties>,
}
impl<'a> std::future::IntoFuture for PreCommit<'a> {
type Output = DeltaResult<FinalizedCommit>;
type IntoFuture = BoxFuture<'a, Self::Output>;
fn into_future(self) -> Self::IntoFuture {
Box::pin(async move { self.into_prepared_commit_future().await?.await?.await })
}
}
impl<'a> PreCommit<'a> {
/// Prepare the commit but do not finalize it
pub fn into_prepared_commit_future(self) -> BoxFuture<'a, DeltaResult<PreparedCommit<'a>>> {
let this = self;
// Write delta log entry as temporary file to storage. For the actual commit,
// the temporary file is moved (atomic rename) to the delta log folder within `commit` function.
async fn write_tmp_commit(
log_entry: Bytes,
store: ObjectStoreRef,
) -> DeltaResult<CommitOrBytes> {
let token = uuid::Uuid::new_v4().to_string();
let path = Path::from_iter([DELTA_LOG_FOLDER, &format!("_commit_{token}.json.tmp")]);
store.put(&path, log_entry.into()).await?;
Ok(CommitOrBytes::TmpCommit(path))
}
Box::pin(async move {
if let Some(table_reference) = this.table_data {
PROTOCOL.can_commit(table_reference, &this.data.actions, &this.data.operation)?;
}
let log_entry = this.data.get_bytes()?;
// With the DefaultLogStore, we just pass the bytes around, since we use conditionalPuts
// Other stores will use tmp_commits
let commit_or_bytes = if this.log_store.name() == "DefaultLogStore" {
CommitOrBytes::LogBytes(log_entry)
} else {
write_tmp_commit(log_entry, this.log_store.object_store()).await?
};
Ok(PreparedCommit {
commit_or_bytes,
log_store: this.log_store,
table_data: this.table_data,
max_retries: this.max_retries,
data: this.data,
post_commit: this.post_commit_hook,
})
})
}
}
/// Represents a inflight commit
pub struct PreparedCommit<'a> {
commit_or_bytes: CommitOrBytes,
log_store: LogStoreRef,
data: CommitData,
table_data: Option<&'a dyn TableReference>,
max_retries: usize,
post_commit: Option<PostCommitHookProperties>,
}
impl<'a> PreparedCommit<'a> {
/// The temporary commit file created
pub fn commit_or_bytes(&self) -> &CommitOrBytes {
&self.commit_or_bytes
}
}
impl<'a> std::future::IntoFuture for PreparedCommit<'a> {
type Output = DeltaResult<PostCommit<'a>>;
type IntoFuture = BoxFuture<'a, Self::Output>;
fn into_future(self) -> Self::IntoFuture {
let this = self;
Box::pin(async move {
let commit_or_bytes = this.commit_or_bytes;
if this.table_data.is_none() {
this.log_store
.write_commit_entry(0, commit_or_bytes.clone())
.await?;
return Ok(PostCommit {
version: 0,
data: this.data,
create_checkpoint: false,
cleanup_expired_logs: None,
log_store: this.log_store,
table_data: this.table_data,
});
}
// unwrap() is safe here due to the above check
// TODO: refactor to only depend on TableReference Trait
let read_snapshot = this.table_data.unwrap().eager_snapshot();
let mut attempt_number = 1;
while attempt_number <= this.max_retries {
let version = read_snapshot.version() + attempt_number as i64;
match this
.log_store
.write_commit_entry(version, commit_or_bytes.clone())
.await
{
Ok(()) => {
return Ok(PostCommit {
version,
data: this.data,
create_checkpoint: this
.post_commit
.map(|v| v.create_checkpoint)
.unwrap_or_default(),
cleanup_expired_logs: this
.post_commit
.map(|v| v.cleanup_expired_logs)
.unwrap_or_default(),
log_store: this.log_store,
table_data: this.table_data,
});
}
Err(TransactionError::VersionAlreadyExists(version)) => {
let summary = WinningCommitSummary::try_new(
this.log_store.as_ref(),
version - 1,
version,
)
.await?;
let transaction_info = TransactionInfo::try_new(
read_snapshot,
this.data.operation.read_predicate(),
&this.data.actions,
this.data.operation.read_whole_table(),
)?;
let conflict_checker = ConflictChecker::new(
transaction_info,
summary,
Some(&this.data.operation),
);
match conflict_checker.check_conflicts() {
Ok(_) => {
attempt_number += 1;
}
Err(err) => {
this.log_store
.abort_commit_entry(version, commit_or_bytes)
.await?;
return Err(TransactionError::CommitConflict(err).into());
}
};
}
Err(err) => {
this.log_store
.abort_commit_entry(version, commit_or_bytes)
.await?;
return Err(err.into());
}
}
}
Err(TransactionError::MaxCommitAttempts(this.max_retries as i32).into())
})
}
}
/// Represents items for the post commit hook
pub struct PostCommit<'a> {
/// The winning version number of the commit
pub version: i64,
/// The data that was comitted to the log store
pub data: CommitData,
create_checkpoint: bool,
cleanup_expired_logs: Option<bool>,
log_store: LogStoreRef,
table_data: Option<&'a dyn TableReference>,
}
impl<'a> PostCommit<'a> {
/// Runs the post commit activities
async fn run_post_commit_hook(&self) -> DeltaResult<DeltaTableState> {
if let Some(table) = self.table_data {
let mut snapshot = table.eager_snapshot().clone();
if self.version - snapshot.version() > 1 {
// This may only occur during concurrent write actions. We need to update the state first to - 1
// then we can advance.
snapshot
.update(self.log_store.clone(), Some(self.version - 1))
.await?;
snapshot.advance(vec![&self.data])?;
} else {
snapshot.advance(vec![&self.data])?;
}
let state = DeltaTableState { snapshot };
// Execute each hook
if self.create_checkpoint {
self.create_checkpoint(&state, &self.log_store, self.version)
.await?;
}
let cleanup_logs = if let Some(cleanup_logs) = self.cleanup_expired_logs {
cleanup_logs
} else {
state.table_config().enable_expired_log_cleanup()
};
if cleanup_logs {
cleanup_expired_logs_for(
self.version,
self.log_store.as_ref(),
Utc::now().timestamp_millis()
- state.table_config().log_retention_duration().as_millis() as i64,
)
.await?;
}
Ok(state)
} else {
let state = DeltaTableState::try_new(
&Path::default(),
self.log_store.object_store(),
Default::default(),
Some(self.version),
)
.await?;
Ok(state)
}
}
async fn create_checkpoint(
&self,
table_state: &DeltaTableState,
log_store: &LogStoreRef,
version: i64,
) -> DeltaResult<()> {
let checkpoint_interval = table_state.config().checkpoint_interval() as i64;
if ((version + 1) % checkpoint_interval) == 0 {
create_checkpoint_for(version, table_state, log_store.as_ref()).await?
}
Ok(())
}
}
/// A commit that successfully completed
pub struct FinalizedCommit {
/// The new table state after a commmit
pub snapshot: DeltaTableState,
/// Version of the finalized commit
pub version: i64,
}
impl FinalizedCommit {
/// The new table state after a commmit
pub fn snapshot(&self) -> DeltaTableState {
self.snapshot.clone()
}
/// Version of the finalized commit
pub fn version(&self) -> i64 {
self.version
}
}
impl<'a> std::future::IntoFuture for PostCommit<'a> {
type Output = DeltaResult<FinalizedCommit>;
type IntoFuture = BoxFuture<'a, Self::Output>;
fn into_future(self) -> Self::IntoFuture {
let this = self;
Box::pin(async move {
match this.run_post_commit_hook().await {
Ok(snapshot) => Ok(FinalizedCommit {
snapshot,
version: this.version,
}),
Err(err) => Err(err),
}
})
}
}
#[cfg(test)]
mod tests {
use std::{collections::HashMap, sync::Arc};
use super::*;
use crate::{
logstore::{default_logstore::DefaultLogStore, LogStore},
storage::commit_uri_from_version,
};
use object_store::{memory::InMemory, ObjectStore, PutPayload};
use url::Url;
#[test]
fn test_commit_uri_from_version() {
let version = commit_uri_from_version(0);
assert_eq!(version, Path::from("_delta_log/00000000000000000000.json"));
let version = commit_uri_from_version(123);
assert_eq!(version, Path::from("_delta_log/00000000000000000123.json"))
}
#[tokio::test]
async fn test_try_commit_transaction() {
let store = Arc::new(InMemory::new());
let url = Url::parse("mem://what/is/this").unwrap();
let log_store = DefaultLogStore::new(
store.clone(),
crate::logstore::LogStoreConfig {
location: url,
options: HashMap::new().into(),
},
);
let version_path = Path::from("_delta_log/00000000000000000000.json");
store.put(&version_path, PutPayload::new()).await.unwrap();
let res = log_store
.write_commit_entry(0, CommitOrBytes::LogBytes(PutPayload::new().into()))
.await;
// fails if file version already exists
assert!(res.is_err());
// succeeds for next version
log_store
.write_commit_entry(1, CommitOrBytes::LogBytes(PutPayload::new().into()))
.await
.unwrap();
}
}