From 6d14b90db228a503bddeee3ff787b126bad5d24b Mon Sep 17 00:00:00 2001 From: Manan007224 Date: Mon, 8 Feb 2021 23:06:14 -0800 Subject: [PATCH] add documentation for enableRowBatchSize flag update cc --- batch_writer.go | 2 +- config.go | 5 +++++ 2 files changed, 6 insertions(+), 1 deletion(-) diff --git a/batch_writer.go b/batch_writer.go index 73e6224b..9ae9d13d 100644 --- a/batch_writer.go +++ b/batch_writer.go @@ -107,7 +107,7 @@ func (w *BatchWriter) WriteRowBatch(batch *RowBatch) error { if w.EnforceInlineVerification { // This code should only be active if the InlineVerifier background // reverification is not occuring. An example of this would be when you - // run the BatchWriter as a part of copying the primary table or delta + // run the BatchWriter as a part of copying the primary table or the delta // copying the joined table. if len(mismatches) > 0 { tx.Rollback() diff --git a/config.go b/config.go index 83d4a864..f5f1a370 100644 --- a/config.go +++ b/config.go @@ -716,6 +716,11 @@ type Config struct { // EnableRowBatchsize is used to enable or disable the calculation of number of bytes written for each row batch. // // Optional: Defaults to false. + // + // NOTE: + // Turning off the EnableRowBatchSize flag would show the NumBytes written per RowBatch to be zero + // in the Progress. This behaviour is perfectly okay and doesn't mean there are no rows being written + // to the target DB. EnableRowBatchSize bool }