Add st_view_reads_table system table

joshua-spacetime · joshua-spacetime · commit 05ba0682daf7 · 2025-10-24T16:28:50.000-07:00
diff --git a/crates/datastore/src/locking_tx_datastore/committed_state.rs b/crates/datastore/src/locking_tx_datastore/committed_state.rs
@@ -8,7 +8,7 @@ use super::{
 };
 use crate::system_tables::{
     ST_CONNECTION_CREDENTIALS_ID, ST_CONNECTION_CREDENTIALS_IDX, ST_VIEW_COLUMN_ID, ST_VIEW_COLUMN_IDX, ST_VIEW_ID,
-    ST_VIEW_IDX, ST_VIEW_PARAM_ID, ST_VIEW_PARAM_IDX,
+    ST_VIEW_IDX, ST_VIEW_PARAM_ID, ST_VIEW_PARAM_IDX, ST_VIEW_READS_TABLE_ID, ST_VIEW_READS_TABLE_IDX,
 };
 use crate::{
     db_metrics::DB_METRICS,
@@ -259,6 +259,7 @@ impl CommittedState {
         self.create_table(ST_VIEW_ID, schemas[ST_VIEW_IDX].clone());
         self.create_table(ST_VIEW_PARAM_ID, schemas[ST_VIEW_PARAM_IDX].clone());
         self.create_table(ST_VIEW_COLUMN_ID, schemas[ST_VIEW_COLUMN_IDX].clone());
+        self.create_table(ST_VIEW_READS_TABLE_ID, schemas[ST_VIEW_READS_TABLE_IDX].clone());
 
         // Insert the sequences into `st_sequences`
         let (st_sequences, blob_store, pool) =
diff --git a/crates/datastore/src/locking_tx_datastore/datastore.rs b/crates/datastore/src/locking_tx_datastore/datastore.rs
@@ -1252,7 +1252,7 @@ mod tests {
         ST_CONSTRAINT_NAME, ST_INDEX_ID, ST_INDEX_NAME, ST_MODULE_NAME, ST_RESERVED_SEQUENCE_RANGE,
         ST_ROW_LEVEL_SECURITY_ID, ST_ROW_LEVEL_SECURITY_NAME, ST_SCHEDULED_ID, ST_SCHEDULED_NAME, ST_SEQUENCE_ID,
         ST_SEQUENCE_NAME, ST_TABLE_NAME, ST_VAR_ID, ST_VAR_NAME, ST_VIEW_COLUMN_ID, ST_VIEW_COLUMN_NAME, ST_VIEW_ID,
-        ST_VIEW_NAME, ST_VIEW_PARAM_ID, ST_VIEW_PARAM_NAME,
+        ST_VIEW_NAME, ST_VIEW_PARAM_ID, ST_VIEW_PARAM_NAME, ST_VIEW_READS_TABLE_ID, ST_VIEW_READS_TABLE_NAME,
     };
     use crate::traits::{IsolationLevel, MutTx};
     use crate::Result;
@@ -1708,6 +1708,7 @@ mod tests {
             TableRow { id: ST_VIEW_ID.into(), name: ST_VIEW_NAME, ty: StTableType::System, access: StAccess::Public, primary_key: Some(StViewFields::ViewId.into()) },
             TableRow { id: ST_VIEW_PARAM_ID.into(), name: ST_VIEW_PARAM_NAME, ty: StTableType::System, access: StAccess::Public, primary_key: None },
             TableRow { id: ST_VIEW_COLUMN_ID.into(), name: ST_VIEW_COLUMN_NAME, ty: StTableType::System, access: StAccess::Public, primary_key: None },
+            TableRow { id: ST_VIEW_READS_TABLE_ID.into(), name: ST_VIEW_READS_TABLE_NAME, ty: StTableType::System, access: StAccess::Public, primary_key: None },
 
         ]));
         #[rustfmt::skip]
@@ -1783,6 +1784,10 @@ mod tests {
             ColRow { table: ST_VIEW_COLUMN_ID.into(), pos: 1, name: "col_pos", ty: ColId::get_type() },
             ColRow { table: ST_VIEW_COLUMN_ID.into(), pos: 2, name: "col_name", ty: AlgebraicType::String },
             ColRow { table: ST_VIEW_COLUMN_ID.into(), pos: 3, name: "col_type", ty: AlgebraicType::bytes() },
+
+            ColRow { table: ST_VIEW_READS_TABLE_ID.into(), pos: 0, name: "view_id", ty: ViewId::get_type() },
+            ColRow { table: ST_VIEW_READS_TABLE_ID.into(), pos: 1, name: "sender", ty: AlgebraicType::option(AlgebraicType::identity()) },
+            ColRow { table: ST_VIEW_READS_TABLE_ID.into(), pos: 2, name: "table_id", ty: TableId::get_type() },
         ]));
         #[rustfmt::skip]
         assert_eq!(query.scan_st_indexes()?, map_array([
@@ -1803,6 +1808,7 @@ mod tests {
             IndexRow { id: 15, table: ST_VIEW_ID.into(), col: col(1), name: "st_view_view_name_idx_btree", },
             IndexRow { id: 16, table: ST_VIEW_PARAM_ID.into(), col: col_list![0, 1], name: "st_view_param_view_id_param_pos_idx_btree", },
             IndexRow { id: 17, table: ST_VIEW_COLUMN_ID.into(), col: col_list![0, 1], name: "st_view_column_view_id_col_pos_idx_btree", },
+            IndexRow { id: 18, table: ST_VIEW_READS_TABLE_ID.into(), col: col_list![0, 1, 2], name: "st_view_reads_table_view_id_sender_table_id_idx_btree", },
         ]));
         let start = ST_RESERVED_SEQUENCE_RANGE as i128 + 1;
         #[rustfmt::skip]
@@ -2258,6 +2264,7 @@ mod tests {
             IndexRow { id: 15, table: ST_VIEW_ID.into(), col: col(1), name: "st_view_view_name_idx_btree", },
             IndexRow { id: 16, table: ST_VIEW_PARAM_ID.into(), col: col_list![0, 1], name: "st_view_param_view_id_param_pos_idx_btree", },
             IndexRow { id: 17, table: ST_VIEW_COLUMN_ID.into(), col: col_list![0, 1], name: "st_view_column_view_id_col_pos_idx_btree", },
+            IndexRow { id: 18, table: ST_VIEW_READS_TABLE_ID.into(), col: col_list![0, 1, 2], name: "st_view_reads_table_view_id_sender_table_id_idx_btree", },
             IndexRow { id: seq_start,     table: FIRST_NON_SYSTEM_ID, col: col(0), name: "Foo_id_idx_btree",  },
             IndexRow { id: seq_start + 1, table: FIRST_NON_SYSTEM_ID, col: col(1), name: "Foo_name_idx_btree",  },
             IndexRow { id: seq_start + 2, table: FIRST_NON_SYSTEM_ID, col: col(2), name: "Foo_age_idx_btree",  },
diff --git a/crates/datastore/src/system_tables.rs b/crates/datastore/src/system_tables.rs
@@ -71,6 +71,8 @@ pub const ST_VIEW_ID: TableId = TableId(12);
 pub const ST_VIEW_PARAM_ID: TableId = TableId(13);
 /// The static ID of the table that tracks view columns
 pub const ST_VIEW_COLUMN_ID: TableId = TableId(14);
+/// The static ID of the table that tracks the tables a view reads
+pub const ST_VIEW_READS_TABLE_ID: TableId = TableId(15);
 
 pub(crate) const ST_CONNECTION_CREDENTIALS_NAME: &str = "st_connection_credentials";
 pub const ST_TABLE_NAME: &str = "st_table";
@@ -86,6 +88,7 @@ pub(crate) const ST_ROW_LEVEL_SECURITY_NAME: &str = "st_row_level_security";
 pub(crate) const ST_VIEW_NAME: &str = "st_view";
 pub(crate) const ST_VIEW_PARAM_NAME: &str = "st_view_param";
 pub(crate) const ST_VIEW_COLUMN_NAME: &str = "st_view_column";
+pub(crate) const ST_VIEW_READS_TABLE_NAME: &str = "st_view_reads_table";
 /// Reserved range of sequence values used for system tables.
 ///
 /// Ids for user-created tables will start at `ST_RESERVED_SEQUENCE_RANGE`.
@@ -114,7 +117,7 @@ pub enum SystemTable {
     st_row_level_security,
 }
 
-pub fn system_tables() -> [TableSchema; 14] {
+pub fn system_tables() -> [TableSchema; 15] {
     [
         // The order should match the `id` of the system table, that start with [ST_TABLE_IDX].
         st_table_schema(),
@@ -131,6 +134,7 @@ pub fn system_tables() -> [TableSchema; 14] {
         st_view_schema(),
         st_view_param_schema(),
         st_view_column_schema(),
+        st_view_reads_table_schema(),
     ]
 }
 
@@ -173,6 +177,7 @@ pub(crate) const ST_CONNECTION_CREDENTIALS_IDX: usize = 10;
 pub(crate) const ST_VIEW_IDX: usize = 11;
 pub(crate) const ST_VIEW_PARAM_IDX: usize = 12;
 pub(crate) const ST_VIEW_COLUMN_IDX: usize = 13;
+pub(crate) const ST_VIEW_READS_TABLE_IDX: usize = 14;
 
 macro_rules! st_fields_enum {
     ($(#[$attr:meta])* enum $ty_name:ident { $($name:expr, $var:ident = $discr:expr,)* }) => {
@@ -239,6 +244,12 @@ st_fields_enum!(enum StViewColumnFields {
     "col_type", ColType = 3,
 });
 // WARNING: For a stable schema, don't change the field names and discriminants.
+st_fields_enum!(enum StViewReadsTableFields {
+    "view_id", ViewId = 0,
+    "sender", Sender = 1,
+    "table_id", TableId = 2,
+});
+// WARNING: For a stable schema, don't change the field names and discriminants.
 st_fields_enum!(enum StViewParamFields {
     "view_id", ViewId = 0,
     "param_pos", ParamPos = 1,
@@ -375,6 +386,19 @@ fn system_module_def() -> ModuleDef {
         .with_unique_constraint(st_view_param_unique_cols)
         .with_index_no_accessor_name(btree(st_view_param_unique_cols));
 
+    let st_view_reads_table_type = builder.add_type::<StViewReadsTableRow>();
+    builder
+        .build_table(
+            ST_VIEW_READS_TABLE_NAME,
+            *st_view_reads_table_type.as_ref().expect("should be ref"),
+        )
+        .with_type(TableType::System)
+        .with_index_no_accessor_name(btree([
+            StViewReadsTableFields::ViewId.col_id(),
+            StViewReadsTableFields::Sender.col_id(),
+            StViewReadsTableFields::TableId.col_id(),
+        ]));
+
     let st_index_type = builder.add_type::<StIndexRow>();
     builder
         .build_table(ST_INDEX_NAME, *st_index_type.as_ref().expect("should be ref"))
@@ -474,6 +498,7 @@ fn system_module_def() -> ModuleDef {
     validate_system_table::<StViewFields>(&result, ST_VIEW_NAME);
     validate_system_table::<StViewParamFields>(&result, ST_VIEW_PARAM_NAME);
     validate_system_table::<StViewColumnFields>(&result, ST_VIEW_COLUMN_NAME);
+    validate_system_table::<StViewReadsTableFields>(&result, ST_VIEW_READS_TABLE_NAME);
 
     result
 }
@@ -539,6 +564,7 @@ lazy_static::lazy_static! {
         m.insert("st_view_view_name_idx_btree", IndexId(15));
         m.insert("st_view_param_view_id_param_pos_idx_btree", IndexId(16));
         m.insert("st_view_column_view_id_col_pos_idx_btree", IndexId(17));
+        m.insert("st_view_reads_table_view_id_sender_table_id_idx_btree", IndexId(18));
         m
     };
 }
@@ -666,6 +692,10 @@ pub fn st_view_column_schema() -> TableSchema {
     st_schema(ST_VIEW_COLUMN_NAME, ST_VIEW_COLUMN_ID)
 }
 
+pub fn st_view_reads_table_schema() -> TableSchema {
+    st_schema(ST_VIEW_READS_TABLE_NAME, ST_VIEW_READS_TABLE_ID)
+}
+
 /// If `table_id` refers to a known system table, return its schema.
 ///
 /// Used when restoring from a snapshot; system tables are reinstantiated with this schema,
@@ -688,6 +718,7 @@ pub(crate) fn system_table_schema(table_id: TableId) -> Option<TableSchema> {
         ST_VIEW_ID => Some(st_view_schema()),
         ST_VIEW_PARAM_ID => Some(st_view_param_schema()),
         ST_VIEW_COLUMN_ID => Some(st_view_column_schema()),
+        ST_VIEW_READS_TABLE_ID => Some(st_view_reads_table_schema()),
         _ => None,
     }
 }
@@ -855,6 +886,20 @@ pub struct StViewParamRow {
     pub param_type: AlgebraicTypeViaBytes,
 }
 
+/// System Table [ST_VIEW_READS_TABLE_NAME]
+///
+/// | view_id | sender         | table_id |
+/// |---------|----------------|----------|
+/// | 1       | (some = 0x...) | 4097     |
+#[derive(Debug, Clone, PartialEq, Eq, SpacetimeType)]
+#[sats(crate = spacetimedb_lib)]
+pub struct StViewReadsTableRow {
+    /// A foreign key referencing [`ST_VIEW_NAME`].
+    pub view_id: ViewId,
+    pub sender: Option<Identity>,
+    pub table_id: TableId,
+}
+
 /// System Table [ST_INDEX_NAME]
 ///
 /// | index_id | table_id | index_name  | index_algorithm            |
