Added caution comment to dataset classes

neo-project · Dec 4, 2024 · 7840ecc · 7840ecc
1 parent 29d244c
commit 7840ecc
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 0 deletions.
diff --git a/src/Plugins/LevelDBStore/IO/Data/LevelDB/DB.cs b/src/Plugins/LevelDBStore/IO/Data/LevelDB/DB.cs
@@ -20,6 +20,7 @@ namespace Neo.IO.Storage.LevelDB
     /// <summary>
     /// A DB is a persistent ordered map from keys to values.
     /// A DB is safe for concurrent access from multiple threads without any external synchronization.
+    /// <code>Iterating over the whole dataset can be time-consuming. Depending upon how large the dataset is.</code>
     /// </summary>
     public class DB : LevelDBHandle, IEnumerable<KeyValuePair<byte[], byte[]>>
     {

diff --git a/src/Plugins/LevelDBStore/Plugins/Storage/Snapshot.cs b/src/Plugins/LevelDBStore/Plugins/Storage/Snapshot.cs
@@ -17,6 +17,9 @@
 
 namespace Neo.Plugins.Storage
 {
+    /// <summary>
+    /// <code>Iterating over the whole dataset can be time-consuming. Depending upon how large the dataset is.</code>
+    /// </summary>
     internal class Snapshot : ISnapshot, IEnumerable<KeyValuePair<byte[], byte[]>>
     {
         private readonly DB _db;

diff --git a/src/Plugins/LevelDBStore/Plugins/Storage/Store.cs b/src/Plugins/LevelDBStore/Plugins/Storage/Store.cs
@@ -16,6 +16,9 @@
 
 namespace Neo.Plugins.Storage
 {
+    /// <summary>
+    /// <code>Iterating over the whole dataset can be time-consuming. Depending upon how large the dataset is.</code>
+    /// </summary>
     internal class Store : IStore, IEnumerable<KeyValuePair<byte[], byte[]>>
     {
         private readonly DB _db;