Skip to content

Commit cdbb497

Browse files
docs: warn that FileIO properties may be sensitive
1 parent 32ebd8e commit cdbb497

1 file changed

Lines changed: 4 additions & 1 deletion

File tree

‎src/iceberg/file_io.h‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -182,7 +182,10 @@ class ICEBERG_EXPORT FileIO {
182182
/// \brief Return storage-credential support when implemented by this FileIO.
183183
virtual SupportsStorageCredentials* AsSupportsStorageCredentials() { return nullptr; }
184184

185-
/// \brief Return this FileIO's configuration properties (empty by default).
185+
/// \brief Return the configuration used to create this FileIO.
186+
///
187+
/// The returned map may contain credentials. Callers must not log or expose it.
188+
/// Implementations that do not expose their configuration return an empty map.
186189
virtual const std::unordered_map<std::string, std::string>& properties() const {
187190
static const std::unordered_map<std::string, std::string> kEmpty;
188191
return kEmpty;

0 commit comments

Comments
 (0)