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
//! Compile-time boundaries for transaction states and execution modes.
/// Create-table transactions cannot remove files.
///
/// ```compile_fail,E0599
/// use delta_kernel::engine_data::FilteredEngineData;
/// use delta_kernel::transaction::{CreateTable, Transaction};
///
/// fn remove(txn: &mut Transaction<CreateTable>, data: FilteredEngineData) {
/// txn.remove_files(data);
/// }
/// ```
;
/// An execution-mode bound does not provide the imperative commit API.
///
/// ```compile_fail,E0599
/// use delta_kernel::transaction::{ExecutionMode, UpdateTable, Transaction};
/// use delta_kernel::Engine;
///
/// fn commit<MODE: ExecutionMode>(txn: Transaction<UpdateTable, MODE>, engine: &dyn Engine) {
/// txn.commit(engine);
/// }
/// ```
;
/// An execution-mode bound does not provide EngineData addition staging.
///
/// ```compile_fail,E0599
/// use delta_kernel::transaction::{ExecutionMode, UpdateTable, Transaction};
/// use delta_kernel::EngineData;
///
/// fn add<MODE: ExecutionMode>(
/// txn: &mut Transaction<UpdateTable, MODE>,
/// data: Box<dyn EngineData>,
/// ) {
/// txn.add_files(data);
/// }
/// ```
;
/// An execution-mode bound does not provide EngineData removal staging.
///
/// ```compile_fail,E0599
/// use delta_kernel::engine_data::FilteredEngineData;
/// use delta_kernel::transaction::{ExecutionMode, UpdateTable, Transaction};
///
/// fn remove<MODE: ExecutionMode>(
/// txn: &mut Transaction<UpdateTable, MODE>,
/// data: FilteredEngineData,
/// ) {
/// txn.remove_files(data);
/// }
/// ```
;
/// Downstream types cannot implement execution modes.
///
/// ```compile_fail,E0277
/// use delta_kernel::transaction::ExecutionMode;
///
/// #[derive(Debug, Default)]
/// struct CustomMode;
///
/// impl ExecutionMode for CustomMode {}
/// ```
;
/// Shared configuration and write-state APIs are available for any execution mode.
///
/// ```no_run
/// use delta_kernel::transaction::{UpdateTable, Transaction, ExecutionMode};
/// use delta_kernel::KernelResult;
///
/// fn configure<MODE: ExecutionMode>(txn: Transaction<UpdateTable, MODE>) -> KernelResult<()> {
/// let txn = txn.with_operation_metrics([("numFiles", Some("1"))]);
/// let _state = txn.write_state()?;
/// Ok(())
/// }
/// ```
;
/// The default transaction mode is imperative, with file staging and commit APIs.
///
/// ```no_run
/// use std::collections::HashMap;
///
/// use delta_kernel::actions::deletion_vector::DeletionVectorDescriptor;
/// use delta_kernel::engine_data::FilteredEngineData;
/// use delta_kernel::transaction::{CommitResult, UpdateTable, Imperative, Transaction};
/// use delta_kernel::{Engine, EngineData, KernelResult};
///
/// fn stage_and_commit(
/// txn: Transaction,
/// engine: &dyn Engine,
/// add_metadata: Box<dyn EngineData>,
/// remove_metadata: FilteredEngineData,
/// new_dv_descriptors: HashMap<String, DeletionVectorDescriptor>,
/// existing_data_files: impl Iterator<Item = KernelResult<FilteredEngineData>>,
/// ) -> KernelResult<CommitResult> {
/// let mut txn: Transaction<UpdateTable, Imperative> = txn;
/// txn.add_files(add_metadata);
/// txn.remove_files(remove_metadata);
/// #[cfg(feature = "internal-api")]
/// txn.update_deletion_vectors(new_dv_descriptors, existing_data_files)?;
/// txn.commit(engine)
/// }
/// ```
;