add comments

Author: xx01cyx

optd-persistent/src/cost_model/catalog/mock_catalog.rs

@@ -3,6 +3,7 @@ use serde_json::json;
 
 use crate::cost_model::interface::{AttrType, IndexType, StatType};
 
+/// TODO: documentation
 pub struct MockDatabaseMetadata {
     pub id: i32,
     pub name: String,
@@ -33,7 +34,6 @@ pub struct MockAttribute {
 pub struct MockStatistic {
     pub id: i32,
     pub stat_type: i32,
-    // TODO(lanlou): what should I use for the value type?
     pub stat_value: Json,
     pub attr_ids: Vec<i32>,
     pub table_id: Option<i32>,
@@ -74,7 +74,9 @@ pub struct MockCatalog {
     pub triggers: Vec<MockTrigger>,
     // TODO: constraints
 }
+
 impl MockCatalog {
+    /// TODO: documentation
     pub fn new() -> Self {
         let databases: Vec<MockDatabaseMetadata> = vec![MockDatabaseMetadata {
             id: 1,

optd-persistent/src/cost_model/orm.rs

@@ -177,6 +177,7 @@ impl CostModelStorageLayer for BackendManager {
                 )
                 .exec(&transaction)
                 .await?;
+                // TODO: initialize constraints
             }
             CatalogSource::Iceberg() => todo!(),
         }

optd-persistent/src/lib.rs

@@ -13,10 +13,14 @@ mod migrator;
 pub mod cost_model;
 pub use cost_model::interface::CostModelStorageLayer;
 
+/// The filename of the SQLite database for migration.
 pub const DATABASE_FILENAME: &str = "sqlite.db";
+/// The URL of the SQLite database for migration.
 pub const DATABASE_URL: &str = "sqlite:./sqlite.db?mode=rwc";
 
+/// The filename of the SQLite database for testing.
 pub const TEST_DATABASE_FILENAME: &str = "init.db";
+/// The URL of the SQLite database for testing.
 pub static TEST_DATABASE_FILE: LazyLock<String> = LazyLock::new(|| {
     std::env::current_dir()
         .unwrap()
@@ -27,6 +31,7 @@ pub static TEST_DATABASE_FILE: LazyLock<String> = LazyLock::new(|| {
         .unwrap()
         .to_owned()
 });
+/// The URL of the SQLite database for testing.
 pub static TEST_DATABASE_URL: LazyLock<String> =
     LazyLock::new(|| get_sqlite_url(TEST_DATABASE_FILE.as_str()));