scylla_node: improve the sample return val of node.dump_sstable()

so we can have better understanding of the format when using this function. Signed-off-by: Kefu Chai <[email protected]>
scylladb · Aug 14, 2023 · 4ff8fd8 · 4ff8fd8
1 parent 7bb4d15
commit 4ff8fd8
Showing 1 changed file with 17 additions and 2 deletions.
diff --git a/ccmlib/scylla_node.py b/ccmlib/scylla_node.py
@@ -1455,6 +1455,10 @@ def dump_sstables(self,
         :return: return all the partitions collected in the specified sstables
         :raises: subprocess.CalledProcessError if scylla-sstable returns a non-zero exit code.
 
+        the $SSTABLE is returned from this method, please see
+        https://opensource.docs.scylladb.com/stable/operating-scylla/admin-tools/scylla-sstable.html#dump-data
+        for the JSON schema of it.
+
         a typical return value might look like:
         ```
         [
@@ -1471,10 +1475,21 @@ def dump_sstables(self,
                     'value': '94'},
             'clustering_elements': [
               {
-                'type': clustering-row',
+                'type': 'clustering-row',
                 'key': {...},
                 'marker': {...},
-                'columns': {...},
+                'columns': {
+                  'c1': {
+                    'is_live': True,
+                    'type': 'regular',
+                    'timestamp': 1691723027979972,
+                    'ttl': '1234s',
+                    'expiry': '2023-08-11 03:24:21z',
+                    'value': 'new',
+                  },
+                  'c2': {...}
+                }
+              }
             ]
           }
         ]