-
Notifications
You must be signed in to change notification settings - Fork 135
/
table_metadata.rs
2246 lines (2080 loc) · 81.5 KB
/
table_metadata.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
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
// Licensed to the Apache Software Foundation (ASF) under one
// or more contributor license agreements. See the NOTICE file
// distributed with this work for additional information
// regarding copyright ownership. The ASF licenses this file
// to you 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.
//! Defines the [table metadata](https://iceberg.apache.org/spec/#table-metadata).
//! The main struct here is [TableMetadataV2] which defines the data for a table.
use std::cmp::Ordering;
use std::collections::HashMap;
use std::fmt::{Display, Formatter};
use std::sync::Arc;
use _serde::TableMetadataEnum;
use chrono::{DateTime, Utc};
use serde::{Deserialize, Serialize};
use serde_repr::{Deserialize_repr, Serialize_repr};
use uuid::Uuid;
use super::snapshot::SnapshotReference;
use super::{
PartitionSpec, PartitionSpecRef, SchemaId, SchemaRef, Snapshot, SnapshotRef, SnapshotRetention,
SortOrder, SortOrderRef, DEFAULT_PARTITION_SPEC_ID,
};
use crate::error::{timestamp_ms_to_utc, Result};
use crate::{Error, ErrorKind, TableCreation};
static MAIN_BRANCH: &str = "main";
pub(crate) static ONE_MINUTE_MS: i64 = 60_000;
pub(crate) static EMPTY_SNAPSHOT_ID: i64 = -1;
pub(crate) static INITIAL_SEQUENCE_NUMBER: i64 = 0;
/// Reserved table property for table format version.
///
/// Iceberg will default a new table's format version to the latest stable and recommended
/// version. This reserved property keyword allows users to override the Iceberg format version of
/// the table metadata.
///
/// If this table property exists when creating a table, the table will use the specified format
/// version. If a table updates this property, it will try to upgrade to the specified format
/// version.
pub const PROPERTY_FORMAT_VERSION: &str = "format-version";
/// Reserved table property for table UUID.
pub const PROPERTY_UUID: &str = "uuid";
/// Reserved table property for the total number of snapshots.
pub const PROPERTY_SNAPSHOT_COUNT: &str = "snapshot-count";
/// Reserved table property for current snapshot summary.
pub const PROPERTY_CURRENT_SNAPSHOT_SUMMARY: &str = "current-snapshot-summary";
/// Reserved table property for current snapshot id.
pub const PROPERTY_CURRENT_SNAPSHOT_ID: &str = "current-snapshot-id";
/// Reserved table property for current snapshot timestamp.
pub const PROPERTY_CURRENT_SNAPSHOT_TIMESTAMP: &str = "current-snapshot-timestamp-ms";
/// Reserved table property for the JSON representation of current schema.
pub const PROPERTY_CURRENT_SCHEMA: &str = "current-schema";
/// Reserved table property for the JSON representation of current(default) partition spec.
pub const PROPERTY_DEFAULT_PARTITION_SPEC: &str = "default-partition-spec";
/// Reserved table property for the JSON representation of current(default) sort order.
pub const PROPERTY_DEFAULT_SORT_ORDER: &str = "default-sort-order";
/// Property key for max number of previous versions to keep.
pub const PROPERTY_METADATA_PREVIOUS_VERSIONS_MAX: &str = "write.metadata.previous-versions-max";
/// Default value for max number of previous versions to keep.
pub const PROPERTY_METADATA_PREVIOUS_VERSIONS_MAX_DEFAULT: usize = 100;
/// Reserved Iceberg table properties list.
///
/// Reserved table properties are only used to control behaviors when creating or updating a
/// table. The value of these properties are not persisted as a part of the table metadata.
pub const RESERVED_PROPERTIES: [&str; 9] = [
PROPERTY_FORMAT_VERSION,
PROPERTY_UUID,
PROPERTY_SNAPSHOT_COUNT,
PROPERTY_CURRENT_SNAPSHOT_ID,
PROPERTY_CURRENT_SNAPSHOT_SUMMARY,
PROPERTY_CURRENT_SNAPSHOT_TIMESTAMP,
PROPERTY_CURRENT_SCHEMA,
PROPERTY_DEFAULT_PARTITION_SPEC,
PROPERTY_DEFAULT_SORT_ORDER,
];
/// Reference to [`TableMetadata`].
pub type TableMetadataRef = Arc<TableMetadata>;
#[derive(Debug, PartialEq, Deserialize, Eq, Clone)]
#[serde(try_from = "TableMetadataEnum")]
/// Fields for the version 2 of the table metadata.
///
/// We assume that this data structure is always valid, so we will panic when invalid error happens.
/// We check the validity of this data structure when constructing.
pub struct TableMetadata {
/// Integer Version for the format.
pub(crate) format_version: FormatVersion,
/// A UUID that identifies the table
pub(crate) table_uuid: Uuid,
/// Location tables base location
pub(crate) location: String,
/// The tables highest sequence number
pub(crate) last_sequence_number: i64,
/// Timestamp in milliseconds from the unix epoch when the table was last updated.
pub(crate) last_updated_ms: i64,
/// An integer; the highest assigned column ID for the table.
pub(crate) last_column_id: i32,
/// A list of schemas, stored as objects with schema-id.
pub(crate) schemas: HashMap<i32, SchemaRef>,
/// ID of the table’s current schema.
pub(crate) current_schema_id: i32,
/// A list of partition specs, stored as full partition spec objects.
pub(crate) partition_specs: HashMap<i32, PartitionSpecRef>,
/// ID of the “current” spec that writers should use by default.
pub(crate) default_spec_id: i32,
/// An integer; the highest assigned partition field ID across all partition specs for the table.
pub(crate) last_partition_id: i32,
///A string to string map of table properties. This is used to control settings that
/// affect reading and writing and is not intended to be used for arbitrary metadata.
/// For example, commit.retry.num-retries is used to control the number of commit retries.
pub(crate) properties: HashMap<String, String>,
/// long ID of the current table snapshot; must be the same as the current
/// ID of the main branch in refs.
pub(crate) current_snapshot_id: Option<i64>,
///A list of valid snapshots. Valid snapshots are snapshots for which all
/// data files exist in the file system. A data file must not be deleted
/// from the file system until the last snapshot in which it was listed is
/// garbage collected.
pub(crate) snapshots: HashMap<i64, SnapshotRef>,
/// A list (optional) of timestamp and snapshot ID pairs that encodes changes
/// to the current snapshot for the table. Each time the current-snapshot-id
/// is changed, a new entry should be added with the last-updated-ms
/// and the new current-snapshot-id. When snapshots are expired from
/// the list of valid snapshots, all entries before a snapshot that has
/// expired should be removed.
pub(crate) snapshot_log: Vec<SnapshotLog>,
/// A list (optional) of timestamp and metadata file location pairs
/// that encodes changes to the previous metadata files for the table.
/// Each time a new metadata file is created, a new entry of the
/// previous metadata file location should be added to the list.
/// Tables can be configured to remove oldest metadata log entries and
/// keep a fixed-size log of the most recent entries after a commit.
pub(crate) metadata_log: Vec<MetadataLog>,
/// A list of sort orders, stored as full sort order objects.
pub(crate) sort_orders: HashMap<i64, SortOrderRef>,
/// Default sort order id of the table. Note that this could be used by
/// writers, but is not used when reading because reads use the specs
/// stored in manifest files.
pub(crate) default_sort_order_id: i64,
///A map of snapshot references. The map keys are the unique snapshot reference
/// names in the table, and the map values are snapshot reference objects.
/// There is always a main branch reference pointing to the current-snapshot-id
/// even if the refs map is null.
pub(crate) refs: HashMap<String, SnapshotReference>,
}
impl TableMetadata {
/// Returns format version of this metadata.
#[inline]
pub fn format_version(&self) -> FormatVersion {
self.format_version
}
/// Returns uuid of current table.
#[inline]
pub fn uuid(&self) -> Uuid {
self.table_uuid
}
/// Returns table location.
#[inline]
pub fn location(&self) -> &str {
self.location.as_str()
}
/// Returns last sequence number.
#[inline]
pub fn last_sequence_number(&self) -> i64 {
self.last_sequence_number
}
/// Returns last updated time.
#[inline]
pub fn last_updated_timestamp(&self) -> Result<DateTime<Utc>> {
timestamp_ms_to_utc(self.last_updated_ms)
}
/// Returns last updated time in milliseconds.
#[inline]
pub fn last_updated_ms(&self) -> i64 {
self.last_updated_ms
}
/// Returns schemas
#[inline]
pub fn schemas_iter(&self) -> impl Iterator<Item = &SchemaRef> {
self.schemas.values()
}
/// Lookup schema by id.
#[inline]
pub fn schema_by_id(&self, schema_id: SchemaId) -> Option<&SchemaRef> {
self.schemas.get(&schema_id)
}
/// Get current schema
#[inline]
pub fn current_schema(&self) -> &SchemaRef {
self.schema_by_id(self.current_schema_id)
.expect("Current schema id set, but not found in table metadata")
}
/// Returns all partition specs.
#[inline]
pub fn partition_specs_iter(&self) -> impl Iterator<Item = &PartitionSpecRef> {
self.partition_specs.values()
}
/// Lookup partition spec by id.
#[inline]
pub fn partition_spec_by_id(&self, spec_id: i32) -> Option<&PartitionSpecRef> {
self.partition_specs.get(&spec_id)
}
/// Get default partition spec
#[inline]
pub fn default_partition_spec(&self) -> &PartitionSpecRef {
self.partition_spec_by_id(self.default_spec_id)
.expect("Default partition spec id set, but not found in table metadata")
}
/// Returns all snapshots
#[inline]
pub fn snapshots(&self) -> impl Iterator<Item = &SnapshotRef> {
self.snapshots.values()
}
/// Lookup snapshot by id.
#[inline]
pub fn snapshot_by_id(&self, snapshot_id: i64) -> Option<&SnapshotRef> {
self.snapshots.get(&snapshot_id)
}
/// Returns snapshot history.
#[inline]
pub fn history(&self) -> &[SnapshotLog] {
&self.snapshot_log
}
/// Returns the metadata log.
#[inline]
pub fn metadata_log(&self) -> &[MetadataLog] {
&self.metadata_log
}
/// Get current snapshot
#[inline]
pub fn current_snapshot(&self) -> Option<&SnapshotRef> {
self.current_snapshot_id.map(|s| {
self.snapshot_by_id(s)
.expect("Current snapshot id has been set, but doesn't exist in metadata")
})
}
/// Get the snapshot for a reference
/// Returns an option if the `ref_name` is not found
#[inline]
pub fn snapshot_for_ref(&self, ref_name: &str) -> Option<&SnapshotRef> {
self.refs.get(ref_name).map(|r| {
self.snapshot_by_id(r.snapshot_id)
.unwrap_or_else(|| panic!("Snapshot id of ref {} doesn't exist", ref_name))
})
}
/// Return all sort orders.
#[inline]
pub fn sort_orders_iter(&self) -> impl Iterator<Item = &SortOrderRef> {
self.sort_orders.values()
}
/// Lookup sort order by id.
#[inline]
pub fn sort_order_by_id(&self, sort_order_id: i64) -> Option<&SortOrderRef> {
self.sort_orders.get(&sort_order_id)
}
/// Returns default sort order id.
#[inline]
pub fn default_sort_order(&self) -> &SortOrderRef {
self.sort_orders
.get(&self.default_sort_order_id)
.expect("Default order id has been set, but not found in table metadata!")
}
/// Returns properties of table.
#[inline]
pub fn properties(&self) -> &HashMap<String, String> {
&self.properties
}
/// Append snapshot to table
pub fn append_snapshot(&mut self, snapshot: Snapshot) {
self.last_updated_ms = snapshot.timestamp_ms();
self.last_sequence_number = snapshot.sequence_number();
self.refs
.entry(MAIN_BRANCH.to_string())
.and_modify(|s| {
s.snapshot_id = snapshot.snapshot_id();
})
.or_insert_with(|| {
SnapshotReference::new(snapshot.snapshot_id(), SnapshotRetention::Branch {
min_snapshots_to_keep: None,
max_snapshot_age_ms: None,
max_ref_age_ms: None,
})
});
self.snapshot_log.push(snapshot.log());
self.snapshots
.insert(snapshot.snapshot_id(), Arc::new(snapshot));
}
/// Normalize this partition spec.
///
/// This is an internal method
/// meant to be called after constructing table metadata from untrusted sources.
/// We run this method after json deserialization.
/// All constructors for `TableMetadata` which are part of `iceberg-rust`
/// should return normalized `TableMetadata`.
pub(super) fn try_normalize(&mut self) -> Result<&mut Self> {
self.validate_current_schema()?;
self.normalize_current_snapshot()?;
self.validate_refs()?;
self.validate_chronological_snapshot_logs()?;
self.validate_chronological_metadata_logs()?;
// Normalize location (remove trailing slash)
self.location = self.location.trim_end_matches('/').to_string();
self.validate_format_version_specifics()?;
self.try_normalize_partition_spec()?;
self.try_normalize_sort_order()?;
Ok(self)
}
/// If the default partition spec is specified but the spec is not present in specs, add it
fn try_normalize_partition_spec(&mut self) -> Result<()> {
if self.partition_spec_by_id(self.default_spec_id).is_some() {
return Ok(());
}
if self.default_spec_id != DEFAULT_PARTITION_SPEC_ID {
return Err(Error::new(
ErrorKind::DataInvalid,
format!(
"No partition spec exists with the default spec id {}.",
self.default_spec_id
),
));
}
let partition_spec = PartitionSpec {
spec_id: DEFAULT_PARTITION_SPEC_ID,
fields: vec![],
};
self.partition_specs
.insert(DEFAULT_PARTITION_SPEC_ID, Arc::new(partition_spec));
Ok(())
}
/// If the default sort order is unsorted but the sort order is not present, add it
fn try_normalize_sort_order(&mut self) -> Result<()> {
if self.sort_order_by_id(self.default_sort_order_id).is_some() {
return Ok(());
}
if self.default_sort_order_id != SortOrder::UNSORTED_ORDER_ID {
return Err(Error::new(
ErrorKind::DataInvalid,
format!(
"No sort order exists with the default sort order id {}.",
self.default_sort_order_id
),
));
}
let sort_order = SortOrder::unsorted_order();
self.sort_orders
.insert(SortOrder::UNSORTED_ORDER_ID, Arc::new(sort_order));
Ok(())
}
/// Validate the current schema is set and exists.
fn validate_current_schema(&self) -> Result<()> {
if self.schema_by_id(self.current_schema_id).is_none() {
return Err(Error::new(
ErrorKind::DataInvalid,
format!(
"No schema exists with the current schema id {}.",
self.current_schema_id
),
));
}
Ok(())
}
/// If current snapshot is Some(-1) then set it to None.
fn normalize_current_snapshot(&mut self) -> Result<()> {
if let Some(current_snapshot_id) = self.current_snapshot_id {
if current_snapshot_id == EMPTY_SNAPSHOT_ID {
self.current_snapshot_id = None;
} else if self.snapshot_by_id(current_snapshot_id).is_none() {
return Err(Error::new(
ErrorKind::DataInvalid,
format!(
"Snapshot for current snapshot id {} does not exist in the existing snapshots list",
current_snapshot_id
),
));
}
}
Ok(())
}
/// Validate that all refs are valid (snapshot exists)
fn validate_refs(&self) -> Result<()> {
for (name, snapshot_ref) in self.refs.iter() {
if self.snapshot_by_id(snapshot_ref.snapshot_id).is_none() {
return Err(Error::new(
ErrorKind::DataInvalid,
format!(
"Snapshot for reference {name} does not exist in the existing snapshots list"
),
));
}
}
let main_ref = self.refs.get(MAIN_BRANCH);
if self.current_snapshot_id.is_some() {
if let Some(main_ref) = main_ref {
if main_ref.snapshot_id != self.current_snapshot_id.unwrap_or_default() {
return Err(Error::new(
ErrorKind::DataInvalid,
format!(
"Current snapshot id does not match main branch ({:?} != {:?})",
self.current_snapshot_id.unwrap_or_default(),
main_ref.snapshot_id
),
));
}
}
} else if main_ref.is_some() {
return Err(Error::new(
ErrorKind::DataInvalid,
"Current snapshot is not set, but main branch exists",
));
}
Ok(())
}
/// Validate that for V1 Metadata the last_sequence_number is 0
fn validate_format_version_specifics(&self) -> Result<()> {
if self.format_version < FormatVersion::V2 && self.last_sequence_number != 0 {
return Err(Error::new(
ErrorKind::DataInvalid,
format!(
"Last sequence number must be 0 in v1. Found {}",
self.last_sequence_number
),
));
}
Ok(())
}
/// Validate snapshots logs are chronological and last updated is after the last snapshot log.
fn validate_chronological_snapshot_logs(&self) -> Result<()> {
for window in self.snapshot_log.windows(2) {
let (prev, curr) = (&window[0], &window[1]);
// commits can happen concurrently from different machines.
// A tolerance helps us avoid failure for small clock skew
if curr.timestamp_ms - prev.timestamp_ms < -ONE_MINUTE_MS {
return Err(Error::new(
ErrorKind::DataInvalid,
"Expected sorted snapshot log entries",
));
}
}
if let Some(last) = self.snapshot_log.last() {
// commits can happen concurrently from different machines.
// A tolerance helps us avoid failure for small clock skew
if self.last_updated_ms - last.timestamp_ms < -ONE_MINUTE_MS {
return Err(Error::new(
ErrorKind::DataInvalid,
format!(
"Invalid update timestamp {}: before last snapshot log entry at {}",
self.last_updated_ms, last.timestamp_ms
),
));
}
}
Ok(())
}
fn validate_chronological_metadata_logs(&self) -> Result<()> {
for window in self.metadata_log.windows(2) {
let (prev, curr) = (&window[0], &window[1]);
// commits can happen concurrently from different machines.
// A tolerance helps us avoid failure for small clock skew
if curr.timestamp_ms - prev.timestamp_ms < -ONE_MINUTE_MS {
return Err(Error::new(
ErrorKind::DataInvalid,
"Expected sorted metadata log entries",
));
}
}
if let Some(last) = self.metadata_log.last() {
// commits can happen concurrently from different machines.
// A tolerance helps us avoid failure for small clock skew
if self.last_updated_ms - last.timestamp_ms < -ONE_MINUTE_MS {
return Err(Error::new(
ErrorKind::DataInvalid,
format!(
"Invalid update timestamp {}: before last metadata log entry at {}",
self.last_updated_ms, last.timestamp_ms
),
));
}
}
Ok(())
}
}
/// Manipulating table metadata.
pub struct TableMetadataBuilder(TableMetadata);
impl TableMetadataBuilder {
/// Creates a new table metadata builder from the given table metadata.
pub fn new(origin: TableMetadata) -> Self {
Self(origin)
}
/// Creates a new table metadata builder from the given table creation.
pub fn from_table_creation(table_creation: TableCreation) -> Result<Self> {
let TableCreation {
name: _,
location,
schema,
partition_spec,
sort_order,
properties,
} = table_creation;
let partition_specs = match partition_spec {
Some(_) => {
return Err(Error::new(
ErrorKind::FeatureUnsupported,
"Can't create table with partition spec now",
))
}
None => HashMap::from([(
DEFAULT_PARTITION_SPEC_ID,
Arc::new(PartitionSpec {
spec_id: DEFAULT_PARTITION_SPEC_ID,
fields: vec![],
}),
)]),
};
let sort_orders = match sort_order {
Some(_) => {
return Err(Error::new(
ErrorKind::FeatureUnsupported,
"Can't create table with sort order now",
))
}
None => HashMap::from([(
SortOrder::UNSORTED_ORDER_ID,
Arc::new(SortOrder::unsorted_order()),
)]),
};
let mut table_metadata = TableMetadata {
format_version: FormatVersion::V2,
table_uuid: Uuid::now_v7(),
location: location.ok_or_else(|| {
Error::new(
ErrorKind::DataInvalid,
"Can't create table without location",
)
})?,
last_sequence_number: 0,
last_updated_ms: Utc::now().timestamp_millis(),
last_column_id: schema.highest_field_id(),
current_schema_id: schema.schema_id(),
schemas: HashMap::from([(schema.schema_id(), Arc::new(schema))]),
partition_specs,
default_spec_id: DEFAULT_PARTITION_SPEC_ID,
last_partition_id: 0,
properties,
current_snapshot_id: None,
snapshots: Default::default(),
snapshot_log: vec![],
sort_orders,
metadata_log: vec![],
default_sort_order_id: SortOrder::UNSORTED_ORDER_ID,
refs: Default::default(),
};
table_metadata.try_normalize()?;
Ok(Self(table_metadata))
}
/// Changes uuid of table metadata.
pub fn assign_uuid(mut self, uuid: Uuid) -> Result<Self> {
self.0.table_uuid = uuid;
Ok(self)
}
/// Returns the new table metadata after changes.
pub fn build(self) -> Result<TableMetadata> {
Ok(self.0)
}
}
pub(super) mod _serde {
use std::borrow::BorrowMut;
/// This is a helper module that defines types to help with serialization/deserialization.
/// For deserialization the input first gets read into either the [TableMetadataV1] or [TableMetadataV2] struct
/// and then converted into the [TableMetadata] struct. Serialization works the other way around.
/// [TableMetadataV1] and [TableMetadataV2] are internal struct that are only used for serialization and deserialization.
use std::collections::HashMap;
/// This is a helper module that defines types to help with serialization/deserialization.
/// For deserialization the input first gets read into either the [TableMetadataV1] or [TableMetadataV2] struct
/// and then converted into the [TableMetadata] struct. Serialization works the other way around.
/// [TableMetadataV1] and [TableMetadataV2] are internal struct that are only used for serialization and deserialization.
use std::sync::Arc;
use serde::{Deserialize, Serialize};
use uuid::Uuid;
use super::{
FormatVersion, MetadataLog, SnapshotLog, TableMetadata, DEFAULT_PARTITION_SPEC_ID,
MAIN_BRANCH,
};
use crate::spec::schema::_serde::{SchemaV1, SchemaV2};
use crate::spec::snapshot::_serde::{SnapshotV1, SnapshotV2};
use crate::spec::{
PartitionField, PartitionSpec, Schema, Snapshot, SnapshotReference, SnapshotRetention,
SortOrder,
};
use crate::{Error, ErrorKind};
#[derive(Debug, Serialize, Deserialize, PartialEq, Eq)]
#[serde(untagged)]
pub(super) enum TableMetadataEnum {
V2(TableMetadataV2),
V1(TableMetadataV1),
}
#[derive(Debug, Serialize, Deserialize, PartialEq, Eq)]
#[serde(rename_all = "kebab-case")]
/// Defines the structure of a v2 table metadata for serialization/deserialization
pub(super) struct TableMetadataV2 {
pub format_version: VersionNumber<2>,
pub table_uuid: Uuid,
pub location: String,
pub last_sequence_number: i64,
pub last_updated_ms: i64,
pub last_column_id: i32,
pub schemas: Vec<SchemaV2>,
pub current_schema_id: i32,
pub partition_specs: Vec<PartitionSpec>,
pub default_spec_id: i32,
pub last_partition_id: i32,
#[serde(skip_serializing_if = "Option::is_none")]
pub properties: Option<HashMap<String, String>>,
#[serde(skip_serializing_if = "Option::is_none")]
pub current_snapshot_id: Option<i64>,
#[serde(skip_serializing_if = "Option::is_none")]
pub snapshots: Option<Vec<SnapshotV2>>,
#[serde(skip_serializing_if = "Option::is_none")]
pub snapshot_log: Option<Vec<SnapshotLog>>,
#[serde(skip_serializing_if = "Option::is_none")]
pub metadata_log: Option<Vec<MetadataLog>>,
pub sort_orders: Vec<SortOrder>,
pub default_sort_order_id: i64,
#[serde(skip_serializing_if = "Option::is_none")]
pub refs: Option<HashMap<String, SnapshotReference>>,
}
#[derive(Debug, Serialize, Deserialize, PartialEq, Eq)]
#[serde(rename_all = "kebab-case")]
/// Defines the structure of a v1 table metadata for serialization/deserialization
pub(super) struct TableMetadataV1 {
pub format_version: VersionNumber<1>,
#[serde(skip_serializing_if = "Option::is_none")]
pub table_uuid: Option<Uuid>,
pub location: String,
pub last_updated_ms: i64,
pub last_column_id: i32,
pub schema: SchemaV1,
#[serde(skip_serializing_if = "Option::is_none")]
pub schemas: Option<Vec<SchemaV1>>,
#[serde(skip_serializing_if = "Option::is_none")]
pub current_schema_id: Option<i32>,
pub partition_spec: Vec<PartitionField>,
#[serde(skip_serializing_if = "Option::is_none")]
pub partition_specs: Option<Vec<PartitionSpec>>,
#[serde(skip_serializing_if = "Option::is_none")]
pub default_spec_id: Option<i32>,
#[serde(skip_serializing_if = "Option::is_none")]
pub last_partition_id: Option<i32>,
#[serde(skip_serializing_if = "Option::is_none")]
pub properties: Option<HashMap<String, String>>,
#[serde(skip_serializing_if = "Option::is_none")]
pub current_snapshot_id: Option<i64>,
#[serde(skip_serializing_if = "Option::is_none")]
pub snapshots: Option<Vec<SnapshotV1>>,
#[serde(skip_serializing_if = "Option::is_none")]
pub snapshot_log: Option<Vec<SnapshotLog>>,
#[serde(skip_serializing_if = "Option::is_none")]
pub metadata_log: Option<Vec<MetadataLog>>,
pub sort_orders: Option<Vec<SortOrder>>,
pub default_sort_order_id: Option<i64>,
}
/// Helper to serialize and deserialize the format version.
#[derive(Debug, PartialEq, Eq)]
pub(crate) struct VersionNumber<const V: u8>;
impl Serialize for TableMetadata {
fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
where S: serde::Serializer {
// we must do a clone here
let table_metadata_enum: TableMetadataEnum =
self.clone().try_into().map_err(serde::ser::Error::custom)?;
table_metadata_enum.serialize(serializer)
}
}
impl<const V: u8> Serialize for VersionNumber<V> {
fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
where S: serde::Serializer {
serializer.serialize_u8(V)
}
}
impl<'de, const V: u8> Deserialize<'de> for VersionNumber<V> {
fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
where D: serde::Deserializer<'de> {
let value = u8::deserialize(deserializer)?;
if value == V {
Ok(VersionNumber::<V>)
} else {
Err(serde::de::Error::custom("Invalid Version"))
}
}
}
impl TryFrom<TableMetadataEnum> for TableMetadata {
type Error = Error;
fn try_from(value: TableMetadataEnum) -> Result<Self, Error> {
match value {
TableMetadataEnum::V2(value) => value.try_into(),
TableMetadataEnum::V1(value) => value.try_into(),
}
}
}
impl TryFrom<TableMetadata> for TableMetadataEnum {
type Error = Error;
fn try_from(value: TableMetadata) -> Result<Self, Error> {
Ok(match value.format_version {
FormatVersion::V2 => TableMetadataEnum::V2(value.into()),
FormatVersion::V1 => TableMetadataEnum::V1(value.try_into()?),
})
}
}
impl TryFrom<TableMetadataV2> for TableMetadata {
type Error = Error;
fn try_from(value: TableMetadataV2) -> Result<Self, self::Error> {
let current_snapshot_id = if let &Some(-1) = &value.current_snapshot_id {
None
} else {
value.current_snapshot_id
};
let schemas = HashMap::from_iter(
value
.schemas
.into_iter()
.map(|schema| Ok((schema.schema_id, Arc::new(schema.try_into()?))))
.collect::<Result<Vec<_>, Error>>()?,
);
let mut metadata = TableMetadata {
format_version: FormatVersion::V2,
table_uuid: value.table_uuid,
location: value.location,
last_sequence_number: value.last_sequence_number,
last_updated_ms: value.last_updated_ms,
last_column_id: value.last_column_id,
current_schema_id: value.current_schema_id,
schemas,
partition_specs: HashMap::from_iter(
value
.partition_specs
.into_iter()
.map(|x| (x.spec_id(), Arc::new(x))),
),
default_spec_id: value.default_spec_id,
last_partition_id: value.last_partition_id,
properties: value.properties.unwrap_or_default(),
current_snapshot_id,
snapshots: value
.snapshots
.map(|snapshots| {
HashMap::from_iter(
snapshots
.into_iter()
.map(|x| (x.snapshot_id, Arc::new(x.into()))),
)
})
.unwrap_or_default(),
snapshot_log: value.snapshot_log.unwrap_or_default(),
metadata_log: value.metadata_log.unwrap_or_default(),
sort_orders: HashMap::from_iter(
value
.sort_orders
.into_iter()
.map(|x| (x.order_id, Arc::new(x))),
),
default_sort_order_id: value.default_sort_order_id,
refs: value.refs.unwrap_or_else(|| {
if let Some(snapshot_id) = current_snapshot_id {
HashMap::from_iter(vec![(MAIN_BRANCH.to_string(), SnapshotReference {
snapshot_id,
retention: SnapshotRetention::Branch {
min_snapshots_to_keep: None,
max_snapshot_age_ms: None,
max_ref_age_ms: None,
},
})])
} else {
HashMap::new()
}
}),
};
metadata.borrow_mut().try_normalize()?;
Ok(metadata)
}
}
impl TryFrom<TableMetadataV1> for TableMetadata {
type Error = Error;
fn try_from(value: TableMetadataV1) -> Result<Self, Error> {
let current_snapshot_id = if let &Some(-1) = &value.current_snapshot_id {
None
} else {
value.current_snapshot_id
};
let schemas = value
.schemas
.map(|schemas| {
Ok::<_, Error>(HashMap::from_iter(
schemas
.into_iter()
.enumerate()
.map(|(i, schema)| {
Ok((
schema.schema_id.unwrap_or(i as i32),
Arc::new(schema.try_into()?),
))
})
.collect::<Result<Vec<_>, Error>>()?
.into_iter(),
))
})
.or_else(|| {
Some(value.schema.try_into().map(|schema: Schema| {
HashMap::from_iter(vec![(schema.schema_id(), Arc::new(schema))])
}))
})
.transpose()?
.unwrap_or_default();
let partition_specs = HashMap::from_iter(
value
.partition_specs
.unwrap_or_else(|| {
vec![PartitionSpec {
spec_id: DEFAULT_PARTITION_SPEC_ID,
fields: value.partition_spec,
}]
})
.into_iter()
.map(|x| (x.spec_id(), Arc::new(x))),
);
let mut metadata = TableMetadata {
format_version: FormatVersion::V1,
table_uuid: value.table_uuid.unwrap_or_default(),
location: value.location,
last_sequence_number: 0,
last_updated_ms: value.last_updated_ms,
last_column_id: value.last_column_id,
current_schema_id: value
.current_schema_id
.unwrap_or_else(|| schemas.keys().copied().max().unwrap_or_default()),
default_spec_id: value
.default_spec_id
.unwrap_or_else(|| partition_specs.keys().copied().max().unwrap_or_default()),
last_partition_id: value
.last_partition_id
.unwrap_or_else(|| partition_specs.keys().copied().max().unwrap_or_default()),
partition_specs,
schemas,
properties: value.properties.unwrap_or_default(),
current_snapshot_id,
snapshots: value
.snapshots
.map(|snapshots| {
Ok::<_, Error>(HashMap::from_iter(
snapshots
.into_iter()
.map(|x| Ok((x.snapshot_id, Arc::new(x.try_into()?))))
.collect::<Result<Vec<_>, Error>>()?,
))
})
.transpose()?
.unwrap_or_default(),
snapshot_log: value.snapshot_log.unwrap_or_default(),
metadata_log: value.metadata_log.unwrap_or_default(),
sort_orders: match value.sort_orders {
Some(sort_orders) => HashMap::from_iter(
sort_orders.into_iter().map(|x| (x.order_id, Arc::new(x))),
),
None => HashMap::new(),
},
default_sort_order_id: value
.default_sort_order_id
.unwrap_or(SortOrder::UNSORTED_ORDER_ID),
refs: if let Some(snapshot_id) = current_snapshot_id {
HashMap::from_iter(vec![(MAIN_BRANCH.to_string(), SnapshotReference {
snapshot_id,
retention: SnapshotRetention::Branch {
min_snapshots_to_keep: None,
max_snapshot_age_ms: None,
max_ref_age_ms: None,
},
})])
} else {
HashMap::new()
},
};
metadata.borrow_mut().try_normalize()?;
Ok(metadata)
}
}
impl From<TableMetadata> for TableMetadataV2 {
fn from(v: TableMetadata) -> Self {
TableMetadataV2 {
format_version: VersionNumber::<2>,
table_uuid: v.table_uuid,
location: v.location,
last_sequence_number: v.last_sequence_number,
last_updated_ms: v.last_updated_ms,
last_column_id: v.last_column_id,
schemas: v
.schemas
.into_values()
.map(|x| {
Arc::try_unwrap(x)
.unwrap_or_else(|schema| schema.as_ref().clone())
.into()
})
.collect(),
current_schema_id: v.current_schema_id,
partition_specs: v
.partition_specs
.into_values()
.map(|x| Arc::try_unwrap(x).unwrap_or_else(|s| s.as_ref().clone()))
.collect(),