-
Notifications
You must be signed in to change notification settings - Fork 403
/
state.rs
466 lines (409 loc) · 16.4 KB
/
state.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
//! The module for delta table state.
use std::collections::HashMap;
use std::collections::HashSet;
use std::convert::TryFrom;
use std::io::{BufRead, BufReader, Cursor};
use chrono::Utc;
use lazy_static::lazy_static;
use object_store::{path::Path, Error as ObjectStoreError, ObjectStore};
use serde::{Deserialize, Serialize};
use super::config::TableConfig;
use crate::errors::DeltaTableError;
use crate::partitions::{DeltaTablePartition, PartitionFilter};
use crate::protocol::{self, Action, Add, ProtocolError};
use crate::schema::SchemaDataType;
use crate::storage::commit_uri_from_version;
use crate::table::DeltaTableMetaData;
use crate::DeltaTable;
use crate::Schema;
#[cfg(any(feature = "parquet", feature = "parquet2"))]
use super::{CheckPoint, DeltaTableConfig};
/// State snapshot currently held by the Delta Table instance.
#[derive(Default, Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct DeltaTableState {
// current table version represented by this table state
version: i64,
// A remove action should remain in the state of the table as a tombstone until it has expired.
// A tombstone expires when the creation timestamp of the delta file exceeds the expiration
tombstones: HashSet<protocol::Remove>,
// active files for table state
files: Vec<protocol::Add>,
// Information added to individual commits
commit_infos: Vec<protocol::CommitInfo>,
// Domain metadatas provided by the system or user
domain_metadatas: Vec<protocol::DomainMetaData>,
app_transaction_version: HashMap<String, i64>,
min_reader_version: i32,
min_writer_version: i32,
// table metadata corresponding to current version
current_metadata: Option<DeltaTableMetaData>,
// retention period for tombstones in milli-seconds
tombstone_retention_millis: i64,
// retention period for log entries in milli-seconds
log_retention_millis: i64,
enable_expired_log_cleanup: bool,
}
impl DeltaTableState {
/// Create Table state with specified version
pub fn with_version(version: i64) -> Self {
Self {
version,
..Self::default()
}
}
/// Return table version
pub fn version(&self) -> i64 {
self.version
}
/// Construct a delta table state object from commit version.
pub async fn from_commit(table: &DeltaTable, version: i64) -> Result<Self, ProtocolError> {
let commit_uri = commit_uri_from_version(version);
let commit_log_bytes = match table.storage.get(&commit_uri).await {
Ok(get) => Ok(get.bytes().await?),
Err(ObjectStoreError::NotFound { .. }) => Err(ProtocolError::EndOfLog),
Err(source) => Err(ProtocolError::ObjectStore { source }),
}?;
let reader = BufReader::new(Cursor::new(commit_log_bytes));
let mut new_state = DeltaTableState::with_version(version);
for line in reader.lines() {
let action: protocol::Action = serde_json::from_str(line?.as_str())?;
new_state.process_action(
action,
table.config.require_tombstones,
table.config.require_files,
)?;
}
Ok(new_state)
}
/// Construct a delta table state object from a list of actions
pub fn from_actions(actions: Vec<Action>, version: i64) -> Result<Self, ProtocolError> {
let mut new_state = DeltaTableState::with_version(version);
for action in actions {
new_state.process_action(action, true, true)?;
}
Ok(new_state)
}
/// Update DeltaTableState with checkpoint data.
#[cfg(any(feature = "parquet", feature = "parquet2"))]
pub fn process_checkpoint_bytes(
&mut self,
data: bytes::Bytes,
table_config: &DeltaTableConfig,
) -> Result<(), DeltaTableError> {
#[cfg(feature = "parquet")]
{
use parquet::file::reader::{FileReader, SerializedFileReader};
let preader = SerializedFileReader::new(data)?;
let schema = preader.metadata().file_metadata().schema();
if !schema.is_group() {
return Err(DeltaTableError::from(protocol::ProtocolError::Generic(
"Action record in checkpoint should be a struct".to_string(),
)));
}
for record in preader.get_row_iter(None)? {
self.process_action(
protocol::Action::from_parquet_record(schema, &record.unwrap())?,
table_config.require_tombstones,
table_config.require_files,
)?;
}
}
#[cfg(feature = "parquet2")]
{
use crate::protocol::parquet2_read::actions_from_row_group;
use parquet2::read::read_metadata;
let mut reader = std::io::Cursor::new(data);
let metadata = read_metadata(&mut reader)?;
for row_group in metadata.row_groups {
for action in actions_from_row_group(row_group, &mut reader)
.map_err(protocol::ProtocolError::from)?
{
self.process_action(
action,
table_config.require_tombstones,
table_config.require_files,
)?;
}
}
}
Ok(())
}
/// Construct a delta table state object from checkpoint.
#[cfg(any(feature = "parquet", feature = "parquet2"))]
pub async fn from_checkpoint(
table: &DeltaTable,
check_point: &CheckPoint,
) -> Result<Self, DeltaTableError> {
let checkpoint_data_paths = table.get_checkpoint_data_paths(check_point);
let mut new_state = Self::with_version(check_point.version);
for f in &checkpoint_data_paths {
let obj = table.storage.get(f).await?.bytes().await?;
new_state.process_checkpoint_bytes(obj, &table.config)?;
}
Ok(new_state)
}
/// List of commit info maps.
pub fn commit_infos(&self) -> &Vec<protocol::CommitInfo> {
&self.commit_infos
}
/// Retention of tombstone in milliseconds.
pub fn tombstone_retention_millis(&self) -> i64 {
self.tombstone_retention_millis
}
/// Retention of logs in milliseconds.
pub fn log_retention_millis(&self) -> i64 {
self.log_retention_millis
}
/// Whether to clean up expired checkpoints and delta logs.
pub fn enable_expired_log_cleanup(&self) -> bool {
self.enable_expired_log_cleanup
}
/// Full list of tombstones (remove actions) representing files removed from table state).
pub fn all_tombstones(&self) -> &HashSet<protocol::Remove> {
&self.tombstones
}
/// List of unexpired tombstones (remove actions) representing files removed from table state.
/// The retention period is set by `deletedFileRetentionDuration` with default value of 1 week.
pub fn unexpired_tombstones(&self) -> impl Iterator<Item = &protocol::Remove> {
let retention_timestamp = Utc::now().timestamp_millis() - self.tombstone_retention_millis;
self.tombstones
.iter()
.filter(move |t| t.deletion_timestamp.unwrap_or(0) > retention_timestamp)
}
/// Full list of add actions representing all parquet files that are part of the current
/// delta table state.
pub fn files(&self) -> &Vec<protocol::Add> {
self.files.as_ref()
}
/// Returns an iterator of file names present in the loaded state
#[inline]
pub fn file_paths_iter(&self) -> impl Iterator<Item = Path> + '_ {
self.files.iter().map(|add| match Path::parse(&add.path) {
Ok(path) => path,
Err(_) => Path::from(add.path.as_ref()),
})
}
/// HashMap containing the last txn version stored for every app id writing txn
/// actions.
pub fn app_transaction_version(&self) -> &HashMap<String, i64> {
&self.app_transaction_version
}
/// The min reader version required by the protocol.
pub fn min_reader_version(&self) -> i32 {
self.min_reader_version
}
/// The min writer version required by the protocol.
pub fn min_writer_version(&self) -> i32 {
self.min_writer_version
}
/// The most recent metadata of the table.
pub fn current_metadata(&self) -> Option<&DeltaTableMetaData> {
self.current_metadata.as_ref()
}
/// The table schema
pub fn schema(&self) -> Option<&Schema> {
self.current_metadata.as_ref().map(|m| &m.schema)
}
/// Well known table configuration
pub fn table_config(&self) -> TableConfig<'_> {
lazy_static! {
static ref DUMMY_CONF: HashMap<String, Option<String>> = HashMap::new();
}
self.current_metadata
.as_ref()
.map(|meta| TableConfig(&meta.configuration))
.unwrap_or_else(|| TableConfig(&DUMMY_CONF))
}
/// Merges new state information into our state
///
/// The DeltaTableState also carries the version information for the given state,
/// as there is a one-to-one match between a table state and a version. In merge/update
/// scenarios we cannot infer the intended / correct version number. By default this
/// function will update the tracked version if the version on `new_state` is larger then the
/// currently set version however it is up to the caller to update the `version` field according
/// to the version the merged state represents.
pub fn merge(
&mut self,
mut new_state: DeltaTableState,
require_tombstones: bool,
require_files: bool,
) {
if !new_state.tombstones.is_empty() {
self.files
.retain(|a| !new_state.tombstones.contains(a.path.as_str()));
}
if require_tombstones && require_files {
new_state.tombstones.into_iter().for_each(|r| {
self.tombstones.insert(r);
});
if !new_state.files.is_empty() {
new_state.files.iter().for_each(|s| {
self.tombstones.remove(s.path.as_str());
});
}
}
if require_files {
self.files.append(&mut new_state.files);
}
if new_state.min_reader_version > 0 {
self.min_reader_version = new_state.min_reader_version;
self.min_writer_version = new_state.min_writer_version;
}
if new_state.current_metadata.is_some() {
self.tombstone_retention_millis = new_state.tombstone_retention_millis;
self.log_retention_millis = new_state.log_retention_millis;
self.enable_expired_log_cleanup = new_state.enable_expired_log_cleanup;
self.current_metadata = new_state.current_metadata.take();
}
new_state
.app_transaction_version
.drain()
.for_each(|(app_id, version)| {
*self
.app_transaction_version
.entry(app_id)
.or_insert(version) = version
});
if !new_state.commit_infos.is_empty() {
self.commit_infos.append(&mut new_state.commit_infos);
}
if self.version < new_state.version {
self.version = new_state.version
}
}
/// Process given action by updating current state.
fn process_action(
&mut self,
action: protocol::Action,
require_tombstones: bool,
require_files: bool,
) -> Result<(), ProtocolError> {
match action {
// TODO: optionally load CDC into TableState
protocol::Action::cdc(_v) => {}
protocol::Action::add(v) => {
if require_files {
self.files.push(v);
}
}
protocol::Action::remove(v) => {
if require_tombstones && require_files {
self.tombstones.insert(v);
}
}
protocol::Action::protocol(v) => {
self.min_reader_version = v.min_reader_version;
self.min_writer_version = v.min_writer_version;
}
protocol::Action::metaData(v) => {
let md = DeltaTableMetaData::try_from(v)?;
let table_config = TableConfig(&md.configuration);
self.tombstone_retention_millis =
table_config.deleted_file_retention_duration().as_millis() as i64;
self.log_retention_millis =
table_config.log_retention_duration().as_millis() as i64;
self.enable_expired_log_cleanup = table_config.enable_expired_log_cleanup();
self.current_metadata = Some(md);
}
protocol::Action::txn(v) => {
*self
.app_transaction_version
.entry(v.app_id)
.or_insert(v.version) = v.version;
}
protocol::Action::commitInfo(v) => {
self.commit_infos.push(v);
}
protocol::Action::domainMetadata(v) => {
self.domain_metadatas.push(v);
}
}
Ok(())
}
/// Obtain Add actions for files that match the filter
pub fn get_active_add_actions_by_partitions<'a>(
&'a self,
filters: &'a [PartitionFilter],
) -> Result<impl Iterator<Item = &Add> + '_, DeltaTableError> {
let current_metadata = self.current_metadata().ok_or(DeltaTableError::NoMetadata)?;
let nonpartitioned_columns: Vec<String> = filters
.iter()
.filter(|f| !current_metadata.partition_columns.contains(&f.key))
.map(|f| f.key.to_string())
.collect();
if !nonpartitioned_columns.is_empty() {
return Err(DeltaTableError::ColumnsNotPartitioned {
nonpartitioned_columns: { nonpartitioned_columns },
});
}
let partition_col_data_types: HashMap<&str, &SchemaDataType> = current_metadata
.get_partition_col_data_types()
.into_iter()
.collect();
let actions = self.files().iter().filter(move |add| {
let partitions = add
.partition_values
.iter()
.map(|p| DeltaTablePartition::from_partition_value((p.0, p.1), ""))
.collect::<Vec<DeltaTablePartition>>();
filters
.iter()
.all(|filter| filter.match_partitions(&partitions, &partition_col_data_types))
});
Ok(actions)
}
}
#[cfg(test)]
mod tests {
use super::*;
use pretty_assertions::assert_eq;
#[test]
fn state_round_trip() {
let expected = DeltaTableState {
version: 0,
tombstones: Default::default(),
files: vec![],
commit_infos: vec![],
domain_metadatas: vec![],
app_transaction_version: Default::default(),
min_reader_version: 0,
min_writer_version: 0,
current_metadata: None,
tombstone_retention_millis: 0,
log_retention_millis: 0,
enable_expired_log_cleanup: false,
};
let bytes = serde_json::to_vec(&expected).unwrap();
let actual: DeltaTableState = serde_json::from_slice(&bytes).unwrap();
assert_eq!(actual.version, expected.version);
}
#[test]
fn state_records_new_txn_version() {
let mut app_transaction_version = HashMap::new();
app_transaction_version.insert("abc".to_string(), 1);
app_transaction_version.insert("xyz".to_string(), 1);
let mut state = DeltaTableState {
version: -1,
files: vec![],
commit_infos: vec![],
domain_metadatas: vec![],
tombstones: HashSet::new(),
current_metadata: None,
min_reader_version: 1,
min_writer_version: 1,
app_transaction_version,
tombstone_retention_millis: 0,
log_retention_millis: 0,
enable_expired_log_cleanup: true,
};
let txn_action = protocol::Action::txn(protocol::Txn {
app_id: "abc".to_string(),
version: 2,
last_updated: Some(0),
});
state.process_action(txn_action, false, true).unwrap();
assert_eq!(2, *state.app_transaction_version().get("abc").unwrap());
assert_eq!(1, *state.app_transaction_version().get("xyz").unwrap());
}
}