github.com/pingcap/tiflow@v0.0.0-20240520035814-5bf52d54e205/cdc/sink/ddlsink/ddl_sink.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 ddlsink
    15  
    16  import (
    17  	"context"
    18  
    19  	"github.com/pingcap/tiflow/cdc/model"
    20  )
    21  
    22  // Sink is the interface for sink of DDL events.
    23  type Sink interface {
    24  	// WriteDDLEvent writes a DDL event to the sink.
    25  	// Note: This is a synchronous and thread-safe method.
    26  	WriteDDLEvent(ctx context.Context, ddl *model.DDLEvent) error
    27  	// WriteCheckpointTs writes a checkpoint timestamp to the sink.
    28  	// Note: This is a synchronous and thread-safe method.
    29  	// This only for MQSink for now.
    30  	WriteCheckpointTs(ctx context.Context, ts uint64, tables []*model.TableInfo) error
    31  	// Close closes the sink.
    32  	Close()
    33  }