From ac85b3806d9b754aa2cd6db3ed82fdae505acae5 Mon Sep 17 00:00:00 2001 From: Zach Musgrave Date: Wed, 4 Dec 2019 11:19:33 -0800 Subject: [PATCH] Added a caveat to the pile of sugar-coated broken glass I just committed Signed-off-by: Zach Musgrave --- go/libraries/doltcore/sqle/table_editor.go | 3 +++ 1 file changed, 3 insertions(+) diff --git a/go/libraries/doltcore/sqle/table_editor.go b/go/libraries/doltcore/sqle/table_editor.go index 7a194c1171..5aaf32b502 100644 --- a/go/libraries/doltcore/sqle/table_editor.go +++ b/go/libraries/doltcore/sqle/table_editor.go @@ -26,6 +26,9 @@ import ( // tableEditor supports making multiple row edits (inserts, updates, deletes) to a table. It does error checking for key // collision etc. in the Close() method, as well as during Insert / Update. +// Right now a table editor allows you to combine inserts, updates, and deletes in any order, and makes reasonable +// attempts to produce correct results when doing so. But this probably (definitely) doesn't work in every case, and +// higher-level clients should carefully flush the editor when necessary (i.e. before an update after many inserts). type tableEditor struct { t *DoltTable ed *types.MapEditor