docs

arthurpassos · arthurpassos · commit 2ed102d67c5d · 2025-05-05T14:03:32.000-03:00
diff --git a/src/Core/ServerSettings.cpp b/src/Core/ServerSettings.cpp
@@ -1005,7 +1005,7 @@ namespace DB
     )", 0) \
     DECLARE(Bool, storage_shared_set_join_use_inner_uuid, false, "If enabled, an inner UUID is generated during the creation of SharedSet and SharedJoin. ClickHouse Cloud only", 0) \
     DECLARE(UInt64, input_format_parquet_metadata_cache_max_size, 500000000, "Maximum size of parquet file metadata cache", 0)                                                                                \
-    DECLARE(UInt64, object_storage_list_objects_cache_size, 5000000, "Maximum size of ObjectStorage list objects cache in bytes. Zero means disabled.", 0)                            \
+    DECLARE(UInt64, object_storage_list_objects_cache_size, 500000000, "Maximum size of ObjectStorage list objects cache in bytes. Zero means disabled.", 0)                            \
     DECLARE(UInt64, object_storage_list_objects_cache_max_entries, 1000, "Maximum size of ObjectStorage list objects cache in entries. Zero means disabled.", 0)                      \
     DECLARE(UInt64, object_storage_list_objects_cache_ttl, 3600, "Time to live of records in ObjectStorage list objects cache in seconds. Zero means unlimited", 0) \
 // clang-format on
diff --git a/src/Disks/ObjectStorages/IObjectStorage.h b/src/Disks/ObjectStorages/IObjectStorage.h
@@ -126,7 +126,7 @@ class IObjectStorage
 
     virtual std::string getDescription() const = 0;
 
-    // todo arthur add docs
+    /// Storage name + authentication unique id. Used for securing ListObjects cache
     virtual std::optional<std::string> getIdentityFingerprint() const = 0;
 
     virtual const MetadataStorageMetrics & getMetadataStorageMetrics() const;
diff --git a/src/Storages/Cache/ObjectStorageListObjectsCache.h b/src/Storages/Cache/ObjectStorageListObjectsCache.h
@@ -28,7 +28,7 @@ class ObjectStorageListObjectsCache
             const std::chrono::steady_clock::time_point & expires_at_ = std::chrono::steady_clock::now(),
             std::optional<UUID> user_id_ = std::nullopt);
 
-        // object storage name + account name
+        // object storage name + account
         std::string storage_identity;
         std::string bucket;
         std::string prefix;
diff --git a/src/Storages/ObjectStorage/StorageObjectStorageSource.cpp b/src/Storages/ObjectStorage/StorageObjectStorageSource.cpp
@@ -172,7 +172,7 @@ std::shared_ptr<IObjectIterator> StorageObjectStorageSource::createFileIterator(
                 }
                 else
                 {
-                    cache_ptr = std::make_unique<GlobIterator::ListObjectsCacheWithKey>(&cache, cache_key);
+                    cache_ptr = std::make_unique<GlobIterator::ListObjectsCacheWithKey>(cache, cache_key);
                     object_iterator = object_storage->iterate(configuration->getPathWithoutGlobs(), query_settings.list_object_keys_size);
                 }
             }
diff --git a/src/Storages/ObjectStorage/StorageObjectStorageSource.h b/src/Storages/ObjectStorage/StorageObjectStorageSource.h
@@ -164,17 +164,20 @@ class StorageObjectStorageSource::ReadTaskIterator : public IObjectIterator
 class StorageObjectStorageSource::GlobIterator : public IObjectIterator, WithContext
 {
 public:
+    /*
+     * Helper struct so `GlobIterator` does not need to re-construct the cache key all the time
+     */
     struct ListObjectsCacheWithKey
     {
-        ListObjectsCacheWithKey(ObjectStorageListObjectsCache * cache_, const ObjectStorageListObjectsCache::Key & key_) : cache(cache_), key(key_) {}
+        ListObjectsCacheWithKey(ObjectStorageListObjectsCache & cache_, const ObjectStorageListObjectsCache::Key & key_) : cache(cache_), key(key_) {}
 
         void set(ObjectStorageListObjectsCache::Value && value) const
         {
-            cache->set(key, std::make_shared<ObjectStorageListObjectsCache::Value>(std::move(value)));
+            cache.set(key, std::make_shared<ObjectStorageListObjectsCache::Value>(std::move(value)));
         }
 
     private:
-        ObjectStorageListObjectsCache * cache;
+        ObjectStorageListObjectsCache & cache;
         ObjectStorageListObjectsCache::Key key;
     };
 

Original file line number	Diff line number	Diff line change
`@@ -172,7 +172,7 @@ std::shared_ptr<IObjectIterator> StorageObjectStorageSource::createFileIterator(`
`172`	`172`	`}`
`173`	`173`	`else`
`174`	`174`	`{`
`175`		`- cache_ptr = std::make_unique<GlobIterator::ListObjectsCacheWithKey>(&cache, cache_key);`
	`175`	`+ cache_ptr = std::make_unique<GlobIterator::ListObjectsCacheWithKey>(cache, cache_key);`
`176`	`176`	`object_iterator = object_storage->iterate(configuration->getPathWithoutGlobs(), query_settings.list_object_keys_size);`
`177`	`177`	`}`
`178`	`178`	`}`
Original file line number	Diff line number	Diff line change
`@@ -164,17 +164,20 @@ class StorageObjectStorageSource::ReadTaskIterator : public IObjectIterator`
`164`	`164`	`class StorageObjectStorageSource::GlobIterator : public IObjectIterator, WithContext`
`165`	`165`	`{`
`166`	`166`	`public:`
	`167`	`+ /*`
	`168`	+ * Helper struct so `GlobIterator` does not need to re-construct the cache key all the time
	`169`	`+ */`
`167`	`170`	`struct ListObjectsCacheWithKey`
`168`	`171`	`{`
`169`		`- ListObjectsCacheWithKey(ObjectStorageListObjectsCache * cache_, const ObjectStorageListObjectsCache::Key & key_) : cache(cache_), key(key_) {}`
	`172`	`+ ListObjectsCacheWithKey(ObjectStorageListObjectsCache & cache_, const ObjectStorageListObjectsCache::Key & key_) : cache(cache_), key(key_) {}`
`170`	`173`
`171`	`174`	`void set(ObjectStorageListObjectsCache::Value && value) const`
`172`	`175`	`{`
`173`		`- cache->set(key, std::make_shared<ObjectStorageListObjectsCache::Value>(std::move(value)));`
	`176`	`+ cache.set(key, std::make_shared<ObjectStorageListObjectsCache::Value>(std::move(value)));`
`174`	`177`	`}`
`175`	`178`
`176`	`179`	`private:`
`177`		`- ObjectStorageListObjectsCache * cache;`
	`180`	`+ ObjectStorageListObjectsCache & cache;`
`178`	`181`	`ObjectStorageListObjectsCache::Key key;`
`179`	`182`	`};`
`180`	`183`