Merge pull request #1214 from uptrace/fix/add-comments-and-restore-check

fix: restore q.limit check

Author: j2gg0s

query_delete.go

@@ -384,12 +384,13 @@ func (q *DeleteQuery) afterDeleteHook(ctx context.Context) error {
 	return nil
 }
 
+// String returns the generated SQL query string. The DeleteQuery instance must not be
+// modified during query generation to ensure multiple calls to String() return identical results.
 func (q *DeleteQuery) String() string {
 	buf, err := q.AppendQuery(q.db.Formatter(), nil)
 	if err != nil {
 		panic(err)
 	}
-
 	return string(buf)
 }
 

query_insert.go

@@ -694,11 +694,12 @@ func (q *InsertQuery) tryLastInsertID(res sql.Result, dest []interface{}) error
 	return nil
 }
 
+// String returns the generated SQL query string. The InsertQuery instance must not be
+// modified during query generation to ensure multiple calls to String() return identical results.
 func (q *InsertQuery) String() string {
 	buf, err := q.AppendQuery(q.db.Formatter(), nil)
 	if err != nil {
 		panic(err)
 	}
-
 	return string(buf)
 }

query_merge.go

@@ -281,12 +281,13 @@ func (q *MergeQuery) scanOrExec(
 	return res, nil
 }
 
+// String returns the generated SQL query string. The MergeQuery instance must not be
+// modified during query generation to ensure multiple calls to String() return identical results.
 func (q *MergeQuery) String() string {
 	buf, err := q.AppendQuery(q.db.Formatter(), nil)
 	if err != nil {
 		panic(err)
 	}
-
 	return string(buf)
 }
 

query_raw.go

@@ -96,11 +96,12 @@ func (q *RawQuery) Operation() string {
 	return "SELECT"
 }
 
+// String returns the generated SQL query string. The RawQuery instance must not be
+// modified during query generation to ensure multiple calls to String() return identical results.
 func (q *RawQuery) String() string {
 	buf, err := q.AppendQuery(q.db.Formatter(), nil)
 	if err != nil {
 		panic(err)
 	}
-
 	return string(buf)
 }

query_select.go

@@ -979,20 +979,25 @@ func (q *SelectQuery) scanAndCountConcurrently(
 	var mu sync.Mutex
 	var firstErr error
 
+	// FIXME: clone should not be needed, because the query is not modified here
+	// and should not be implicitly modified by the Bun lib.
 	countQuery := q.Clone()
 
-	wg.Add(1)
-	go func() {
-		defer wg.Done()
-
-		if err := q.Scan(ctx, dest...); err != nil {
-			mu.Lock()
-			if firstErr == nil {
-				firstErr = err
+	// Don't scan results if the user explicitly set Limit(-1).
+	if q.limit >= 0 {
+		wg.Add(1)
+		go func() {
+			defer wg.Done()
+
+			if err := q.Scan(ctx, dest...); err != nil {
+				mu.Lock()
+				if firstErr == nil {
+					firstErr = err
+				}
+				mu.Unlock()
 			}
-			mu.Unlock()
-		}
-	}()
+		}()
+	}
 
 	wg.Add(1)
 	go func() {
@@ -1016,6 +1021,7 @@ func (q *SelectQuery) scanAndCountConcurrently(
 func (q *SelectQuery) scanAndCountSeq(ctx context.Context, dest ...interface{}) (int, error) {
 	var firstErr error
 
+	// Don't scan results if the user explicitly set Limit(-1).
 	if q.limit >= 0 {
 		firstErr = q.Scan(ctx, dest...)
 	}
@@ -1086,12 +1092,13 @@ func (q *SelectQuery) whereExists(ctx context.Context) (bool, error) {
 	return n == 1, nil
 }
 
+// String returns the generated SQL query string. The SelectQuery instance must not be
+// modified during query generation to ensure multiple calls to String() return identical results.
 func (q *SelectQuery) String() string {
 	buf, err := q.AppendQuery(q.db.Formatter(), nil)
 	if err != nil {
 		panic(err)
 	}
-
 	return string(buf)
 }
 

query_table_create.go

@@ -408,11 +408,12 @@ func (q *CreateTableQuery) afterCreateTableHook(ctx context.Context) error {
 	return nil
 }
 
+// String returns the generated SQL query string. The CreateTableQuery instance must not be
+// modified during query generation to ensure multiple calls to String() return identical results.
 func (q *CreateTableQuery) String() string {
 	buf, err := q.AppendQuery(q.db.Formatter(), nil)
 	if err != nil {
 		panic(err)
 	}
-
 	return string(buf)
 }

query_table_drop.go

@@ -165,11 +165,12 @@ func (q *DropTableQuery) afterDropTableHook(ctx context.Context) error {
 	return nil
 }
 
+// String returns the generated SQL query string. The DropTableQuery instance must not be
+// modified during query generation to ensure multiple calls to String() return identical results.
 func (q *DropTableQuery) String() string {
 	buf, err := q.AppendQuery(q.db.Formatter(), nil)
 	if err != nil {
 		panic(err)
 	}
-
 	return string(buf)
 }

query_update.go

@@ -635,12 +635,13 @@ func (q *UpdateQuery) hasTableAlias(fmter schema.Formatter) bool {
 	return fmter.HasFeature(feature.UpdateMultiTable | feature.UpdateTableAlias)
 }
 
+// String returns the generated SQL query string. The UpdateQuery instance must not be
+// modified during query generation to ensure multiple calls to String() return identical results.
 func (q *UpdateQuery) String() string {
 	buf, err := q.AppendQuery(q.db.Formatter(), nil)
 	if err != nil {
 		panic(err)
 	}
-
 	return string(buf)
 }