Function queryRetryStopOnError

backend/api/v1/sql_service.go:851–925

queryRetryStopOnError runs the query and stops on encountering errors. The error is both present in the returned QueryResult and error, the caller decides what to do.

(
	ctx context.Context,
	stores *store.Store,
	user *store.UserMessage,
	instance *store.InstanceMessage,
	database *store.DatabaseMessage,
	driver db.Driver,
	conn *sql.Conn,
	statement string,
	queryContext db.QueryContext,
	licenseService *enterprise.LicenseService,
	optionalAccessCheck accessCheckFunc,
	schemaSyncer *schemasync.Syncer,
)

// queryRetryStopOnError runs the query and stops on encountering errors.
// The error is both present in the returned QueryResult and error, the caller decides what to do.
func queryRetryStopOnError(
	ctx context.Context,
	stores *store.Store,
	user *store.UserMessage,
	instance *store.InstanceMessage,
	database *store.DatabaseMessage,
	driver db.Driver,
	conn *sql.Conn,
	statement string,
	queryContext db.QueryContext,
	licenseService *enterprise.LicenseService,
	optionalAccessCheck accessCheckFunc,
	schemaSyncer *schemasync.Syncer,
) ([]*v1pb.QueryResult, []*parserbase.QuerySpan, time.Duration, error) {
	// MSSQL requires statements to be executed as a batch to preserve variable scope.
	// For example, "DECLARE @meta int = 1; SELECT @meta" must be sent as one batch,
	// otherwise the second statement will fail with "variable not defined" error.
	// Split for span analysis, but pass original statement for batch execution.
	if instance.Metadata.GetEngine() == storepb.Engine_MSSQL {
		statements, err := parserbase.SplitMultiSQL(instance.Metadata.GetEngine(), statement)
		if err != nil {
			return nil, nil, 0, err
		}
		return queryRetry(ctx, stores, user, instance, database, driver, conn, statements, statement, queryContext, licenseService, optionalAccessCheck, schemaSyncer, hasMultipleStatements(statements))
	}

	// Split the statement into individual SQLs
	statements, err := parserbase.SplitMultiSQL(instance.Metadata.GetEngine(), statement)
	if err != nil {
		// Engines without splitter support (MongoDB, Redis, Elasticsearch) fall back to
		// treating the entire statement as a single unit. These engines also don't have
		// GetQuerySpan support, so queryRetry will return nil spans (old behavior).
		return queryRetry(ctx, stores, user, instance, database, driver, conn, []parserbase.Statement{{Text: statement}}, statement, queryContext, licenseService, optionalAccessCheck, schemaSyncer, false)
	}

	// A multi-statement batch can change the session schema mid-batch (e.g. SET search_path),
	// which the per-statement access check below cannot track; flag it so DML/DDL falls back
	// to the database-level check. SUP-222.
	multiStatement := hasMultipleStatements(statements)

	var allResults []*v1pb.QueryResult
	var allSpans []*parserbase.QuerySpan
	var totalDuration time.Duration

	for _, stmt := range statements {
		// Skip empty statements
		if stmt.Empty {
			continue
		}

		results, spans, duration, err := queryRetry(ctx, stores, user, instance, database, driver, conn, []parserbase.Statement{stmt}, stmt.Text, queryContext, licenseService, optionalAccessCheck, schemaSyncer, multiStatement)
		totalDuration += duration

		if err != nil {
			allResults = append(allResults, &v1pb.QueryResult{
				Error:     err.Error(),
				Statement: stmt.Text,
			})