Skip to content

Commit c039063

Browse files
author
David Noble
committed
DVPL-4307: Fix export code comments
The text of the code comments speaks for itself. Signed-off-by: David Noble <dnoble@splunk.com>
1 parent 9b2dd75 commit c039063

File tree

1 file changed

+5
-4
lines changed

1 file changed

+5
-4
lines changed

splunklib/client.py

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2718,10 +2718,11 @@ def export(self, query, **params):
27182718
# Normal events are returned as dicts
27192719
print result
27202720
assert rr.is_preview == False
2721-
2722-
Running an export search is more efficient than running a similar
2723-
preview search because no post-processing is done on the retrieved
2724-
events. The raw events are simply returned.
2721+
2722+
Running an export search is more efficient as it streams the results
2723+
directly to you, rather than having to write them out to disk and make
2724+
them available later. As soon as results are ready, you will receive
2725+
them.
27252726
27262727
The ``export`` method makes a single roundtrip to the server (as opposed
27272728
to two for :meth:`create` followed by :meth:`preview`), plus at most two

0 commit comments

Comments
 (0)