summaryrefslogtreecommitdiff
path: root/net/p5-Data-Stream-Bulk/DESCR
diff options
context:
space:
mode:
Diffstat (limited to 'net/p5-Data-Stream-Bulk/DESCR')
-rw-r--r--net/p5-Data-Stream-Bulk/DESCR13
1 files changed, 13 insertions, 0 deletions
diff --git a/net/p5-Data-Stream-Bulk/DESCR b/net/p5-Data-Stream-Bulk/DESCR
new file mode 100644
index 00000000000..73c92bbec57
--- /dev/null
+++ b/net/p5-Data-Stream-Bulk/DESCR
@@ -0,0 +1,13 @@
+This module tries to find middle ground between one at a time and
+all at once processing of data sets.
+
+The purpose of this module is to avoid the overhead of implementing
+an iterative api when this isn't necessary, without breaking forward
+compatibility in case that becomes necessary later on.
+
+The API optimizes for when a data set typically fits in memory and
+is returned as an array, but the consumer cannot assume that the
+data set is bounded.
+
+The API is destructive in order to minimize the chance that resultsets
+are leaked due to improper usage.