chore: add docs on DB_CONNECTIONS

JasonShin · Oct 1, 2023 · eb3183a · eb3183a
1 parent 52a643d
commit eb3183a
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/src/common/lazy.rs b/src/common/lazy.rs
@@ -44,6 +44,8 @@ lazy_static! {
         cache
     };
 
+    // This variable holds a singleton of DBConnections that is used to get a DBConn from the cache
+    // DBConn is used to access the raw connection to the database or run `prepare` statement against each connection
     pub static ref DB_CONNECTIONS: Mutex<DBConnections<'static>> = {
         let db_connections = DBConnections::new(&DB_CONN_CACHE);
         Mutex::new(db_connections)