From e1febaa6b4808d6cf1affa26104adb5e8dd18061 Mon Sep 17 00:00:00 2001
From: Parker Timmerman <parker.timmerman@materialize.com>
Date: Tue, 14 Jan 2025 11:58:36 -0500
Subject: [PATCH] add a comment calling out that oneshot ingestions only stage
 data, they don't also link it

---
 src/storage-client/src/client.rs | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/src/storage-client/src/client.rs b/src/storage-client/src/client.rs
index 80561b6edfcbc..791dea68e1ba9 100644
--- a/src/storage-client/src/client.rs
+++ b/src/storage-client/src/client.rs
@@ -123,6 +123,11 @@ pub enum StorageCommand<T = mz_repr::Timestamp> {
     UpdateConfiguration(StorageParameters),
     /// Run the enumerated sources, each associated with its identifier.
     RunIngestions(Vec<RunIngestionCommand>),
+    /// Run a dataflow which will ingest data from an external source and only __stage__ it in
+    /// Persist.
+    ///
+    /// Unlike regular ingestions/sources, some other component (e.g. `environmentd`) is
+    /// responsible for linking the staged data into a shard.
     RunOneshotIngestion(RunOneshotIngestionCommand),
     /// Enable compaction in storage-managed collections.
     ///