Layer 2: Storage
Single-purpose storage interfaces. Each store does one thing.
SqlJournalStore
Write-ahead log for statements: one append-only, keyless table per dataset in JOURNAL_SCHEMA. A flush renames the table to a timestamped segment, recreating it in the same DDL transaction, hands the segment over as Arrow tables and drops it once the consumer has written them – a failed write keeps its rows for the next flush. On postgres the rename waits at most lock_timeout (5s) for in-flight writers; a blocked flush fails and the next one retries. flush_lock() serializes flushes per dataset. get_journal picks the store: SqliteJournalStore / PostgresJournalStore by uri, or ApiJournalStore in api mode, which only writes – the server drains its journal.
ftm_lakehouse.storage.journal.sql.SqlJournalStore
Bases: BaseJournalStore[SqlJournalWriter]
SQL journal – an append-only heap per dataset in JOURNAL_SCHEMA.
A flush renames the table to a timestamped segment and creates a fresh one
in the same DDL transaction, streams the segment out as Arrow and drops it
– cleanup is a catalog operation, never a DELETE. Dialects:
SqliteJournalStore / PostgresJournalStore, picked by sql_journal.
Source code in ftm_lakehouse/storage/journal/sql.py
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 | |
lock_timeout = None
class-attribute
instance-attribute
Dialect bound on how long the rotation waits for in-flight writers.
acquire()
Take a connection for a writer's inserts.
A plain connect; PostgresJournalStore
borrows from an ADBC pool instead.
clear()
Delete all rows for this dataset. Returns count of deleted rows.
Source code in ftm_lakehouse/storage/journal/sql.py
connect()
count()
Count rows for this dataset, across all segments.
Source code in ftm_lakehouse/storage/journal/sql.py
dispose()
flush_batches()
Rotate the journal, then stream each segment as Arrow tables and drop it.
Held under flush_lock – a concurrent
flush yields nothing. Segments left by a crashed flush are drained too,
and a consumer that fails keeps the undrained rows for the next flush.
Rows stream unordered, so a table spans shards and
append writes one
file per partition it touches.
Source code in ftm_lakehouse/storage/journal/sql.py
flush_lock()
Hold this dataset's flush window; yields False if another flush has it.
Without it a second flush would drain the first one's segment. The lock must release itself when its holder dies, or a crash strands a segment.
Source code in ftm_lakehouse/storage/journal/sql.py
insert_batch(conn, batch)
iterate_entity(entity_id)
Iterate the live statements of one entity, across all segments.
A full scan per call – the journal has no index (see
journal_table).
Source code in ftm_lakehouse/storage/journal/sql.py
read_segment(name)
release(conn)
Hand a writer's connection back by closing it.
On postgres that checks it into the pool, rolled back, so the next writer never inherits an aborted transaction.
ParquetStore
Delta Lake parquet store for statements, partitioned by (shard, bucket, origin). Writes are append-only; reads reconcile duplicates, superseded fragments and tombstones, except over partitions made of merge output alone, which read as a plain scan. merge (under the merge lock, so appends keep flowing) and vacuum (under the exclusive .LOCK too) are maintenance; shard is the one operation that moves rows between partitions, onto a new shard count.
ftm_lakehouse.storage.parquet.ParquetStore
The statement store of one dataset: one Delta table, partitioned by
(shard, bucket, origin), at {uri}/statements – or at
{LAKEHOUSE_STATEMENTS_URI}/{dataset}/statements when that is set. Locks
and tags stay with the dataset at uri.
Source code in ftm_lakehouse/storage/parquet.py
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 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 | |
deltatable
property
A freshly loaded handle on the table, for callers outside the store.
exists
property
Whether the Delta table exists.
needs_merge
property
Whether any partition holds a file merge did not
write.
num_rows
property
Physical row count from the snapshot's file statistics – no scan.
version
property
Current version of the main Delta table.
append(batch)
Append JOURNAL_SCHEMA rows, deriving their shard.
One write per bucket, for its writer profile. Unsorted and lock-free –
concurrent appends commit through Delta's optimistic concurrency; only
.LOCK makes them wait. The touched partitions are dirty until the
next merge.
Source code in ftm_lakehouse/storage/parquet.py
configure_table()
Apply TABLE_CONFIGURATION, then checkpoint and clean up the log under
it.
Returns:
| Type | Description |
|---|---|
dict[str, str]
|
The properties that changed. |
Source code in ftm_lakehouse/storage/parquet.py
cursor(raw=TABLE_RAW.name, live=TABLE.name)
A cursor with the whole table registered as a read's views
(register_partition): the live view is a plain scan when every
partition is clean, the dedupe query otherwise.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
raw
|
str
|
Name of the view over every physical row. |
name
|
live
|
str
|
Name of the view over the live rows. |
name
|
Yields:
| Type | Description |
|---|---|
DuckDBPyConnection
|
A DuckDB cursor of the store's connection. |
Source code in ftm_lakehouse/storage/parquet.py
delete_origin(origin)
Physically drop every row of one origin – whole partitions, at once, with no grace period.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
origin
|
str
|
The origin to drop. |
required |
Returns:
| Type | Description |
|---|---|
int
|
Number of rows removed. |
Raises:
| Type | Description |
|---|---|
ValueError
|
If |
RuntimeError
|
When the write fence cannot be acquired. |
Source code in ftm_lakehouse/storage/parquet.py
deleted_candidates(since)
Every entity with a tombstone at or after since – one raw scan over
the whole store.
Source code in ftm_lakehouse/storage/parquet.py
destroy()
Soft-delete the store: drop its _delta_log. The parquet files stay
on disk until a vacuum of the re-created table.
Other processes keep the snapshot they hold – restart them.
Source code in ftm_lakehouse/storage/parquet.py
evolve_schema()
Add the SHARDED_SCHEMA columns the table was created without.
A metadata-only commit; older files read the new columns as NULL. Additive only – a removed column needs a full rewrite.
Returns:
| Type | Description |
|---|---|
list[str]
|
The columns added. |
Source code in ftm_lakehouse/storage/parquet.py
merge(force=False)
Rewrite every dirty partition into canonical files, in entity_id
order – one per MERGE_CHUNK_BYTES of rows.
Duplicates collapse, fragments supersede, first_seen folds and
tombstones past LAKEHOUSE_GRACE_PERIOD_DAYS go with the rows they
shadow (build_merge_sql).
Reads see the same rows before and after (dataChange = false).
Partitions merge in LAKEHOUSE_WORKERS processes, committed in
batches of MERGE_COMMIT_BATCH; a failed run still commits what
finished, including the partitions still running when one failed.
Holds only merge_lock, so appends
keep flowing.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
force
|
bool
|
Rewrite every partition from scratch, clean ones included,
re-sorting the last merge's files instead of trusting them. With
a grace period of |
False
|
Source code in ftm_lakehouse/storage/parquet.py
992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 | |
merge_lock()
The .LOCK-MERGE – held by merge, the export
sweep and, with .LOCK, the exclusive maintenance. Appends don't wait
for it; it keeps a vacuum off files a running sweep reads.
Source code in ftm_lakehouse/storage/parquet.py
query(q=None)
Query entities from the store.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
q
|
Query | None
|
Filters, plus ordering / slicing. |
None
|
Yields:
| Type | Description |
|---|---|
StatementEntities
|
|
Source code in ftm_lakehouse/storage/parquet.py
query_statements(q=None)
Query statements from the store.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
q
|
Query | None
|
Filters, plus ordering / slicing. |
None
|
Yields:
| Type | Description |
|---|---|
Statements
|
|
Statements
|
so one can be handed to |
Statements
|
Source code in ftm_lakehouse/storage/parquet.py
shard(shards)
Rewrite the store onto shards entity-hash shards.
One streamed, atomic overwrite per (bucket, origin) group; every
partition comes out dirty, so run optimize afterwards. Idempotent.
Blocks parquet appends but not the journal – run it with writers stopped.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
shards
|
int
|
Target shard count; |
required |
Source code in ftm_lakehouse/storage/parquet.py
sweep_sources()
Every (shard, bucket) pair of one snapshot as a SweepSource, the
units an export sweeps (no entity spans two).
Source code in ftm_lakehouse/storage/parquet.py
unlock()
Forcibly release .LOCK and .LOCK-MERGE after a crashed writer.
Breaking a lock a live writer holds can corrupt its write – confirm no process is writing first.
Returns:
| Type | Description |
|---|---|
bool
|
Whether a lock was released. |
Source code in ftm_lakehouse/storage/parquet.py
vacuum(retention_hours=0)
Delete the files the Delta log no longer references, and the staging
tables a crashed merge left (STAGING_DIR).
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
retention_hours
|
int
|
Keep such files newer than this. |
0
|
Source code in ftm_lakehouse/storage/parquet.py
write_stream(tables, budget=None)
Append a stream of JOURNAL_SCHEMA tables as a part-* file per
(shard, bucket, origin). This is not the journal drain but used for
bulk imports via cli or scripts.
A partition's rows are held until they fill a file (MERGE_CHUNK_BYTES)
or the held rows exceed budget; then the largest partitions are
written, down to half the budget, in one commit per bucket of up to
WRITE_FLUSH_PARTITIONS partitions.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
tables
|
Iterable[Table]
|
Stream of packed statement tables. |
required |
budget
|
int | None
|
Arrow bytes to hold, default |
None
|
Returns:
| Type | Description |
|---|---|
int
|
Number of rows written. |
Source code in ftm_lakehouse/storage/parquet.py
ftm_lakehouse.storage.parquet.merge_partition(task)
Merge one partition into new data files next to its old ones.
The partition is read as entity_id-sorted streams (_runs) and cut
into entity-closed chunks
(entity_chunks), each deduped
by build_merge_sql on its
own – every window key holds entity_id, so the chunks give the rows the
whole would – and written as they come, sorted within and ascending across
chunks. Batches hold about MERGE_BATCH_BYTES at the partition's average
row size, so memory follows the merge constants, not the partition.
Writes but does not commit – ParquetStore.merge
does; an uncommitted file is an orphan the next vacuum removes.
Source code in ftm_lakehouse/storage/parquet.py
TagStore
Key-value freshness tracking.
ftm_lakehouse.storage.tags.TagStore
Bases: Tags
Key-value store for freshness tracking.
Tags are timestamps stored as key-value pairs, used to track when resources were last updated and determine if processing is needed.
Layout: tags/{tenant}/{key}
This store has the "tags/{tenant}" key prefix set, so clients must use relative paths from there.
Source code in ftm_lakehouse/storage/tags.py
is_latest(key, dependencies)
Check if the tag is more recent than all dependencies.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
key
|
Uri
|
Tag key to check |
required |
dependencies
|
Iterable[Uri]
|
Tag keys that this key depends on |
required |
Returns:
| Type | Description |
|---|---|
bool
|
True if key is newer than all dependencies, False otherwise |
VersionStore
Timestamped snapshots for config / index files.