github.com/pingcap/tiflow@v0.0.0-20240520035814-5bf52d54e205/cdc/sink/dmlsink/txn/backend.go (about)

     1  // Copyright 2022 PingCAP, Inc.
     2  //
     3  // Licensed under the Apache License, Version 2.0 (the "License");
     4  // you may not use this file except in compliance with the License.
     5  // You may obtain a copy of the License at
     6  //
     7  //     http://www.apache.org/licenses/LICENSE-2.0
     8  //
     9  // Unless required by applicable law or agreed to in writing, software
    10  // distributed under the License is distributed on an "AS IS" BASIS,
    11  // See the License for the specific language governing permissions and
    12  // limitations under the License.
    13  
    14  package txn
    15  
    16  import (
    17  	"context"
    18  	"time"
    19  
    20  	"github.com/pingcap/tiflow/cdc/sink/dmlsink"
    21  )
    22  
    23  // backend indicates a transaction backend like MySQL, TiDB, ...
    24  type backend interface {
    25  	// OnTxnEvent handles one TxnCallbackableEvent.
    26  	OnTxnEvent(e *dmlsink.TxnCallbackableEvent) (needFlush bool)
    27  
    28  	// Flush pending events in the backend.
    29  	Flush(ctx context.Context) error
    30  
    31  	// To reduce latency for low throughput cases.
    32  	MaxFlushInterval() time.Duration
    33  
    34  	// Close the backend.
    35  	Close() error
    36  }