Update datafusion/execution/src/cache/cache_manager.rs

Co-authored-by: Andrew Lamb <[email protected]>
apache · Oct 7, 2023 · a29f172 · a29f172
1 parent c807225
commit a29f172
Showing 1 changed file with 5 additions and 2 deletions.
diff --git a/datafusion/execution/src/cache/cache_manager.rs b/datafusion/execution/src/cache/cache_manager.rs
@@ -79,8 +79,11 @@ pub struct CacheManagerConfig {
     /// Avoid get same file statistics repeatedly in same datafusion session.
     /// Default is disable. Fow now only supports Parquet files.
     pub table_files_statistics_cache: Option<FileStatisticsCache>,
-    /// Enable cache of files statistics when listing files.
-    /// Avoid get same files meta under same path repeatedly in same datafusion session.
+    /// Enable cache of file metadata when listing files.
+    /// This setting avoids listing file meta of the same path repeatedly 
+    /// in same session, which may be expensive in certain situations (e.g. remote object storage). 
+    /// Note that if this option is enabled, DataFusion will not see any updates to the underlying
+    /// location.  
     /// Default is disable.
     pub list_files_cache: Option<ListFilesCache>,
 }