vitess.io/vitess@v0.16.2/go/vt/binlog/updatestream.go (about)

     1  /*
     2  Copyright 2019 The Vitess Authors.
     3  
     4  Licensed under the Apache License, Version 2.0 (the "License");
     5  you may not use this file except in compliance with the License.
     6  You may obtain a copy of the License at
     7  
     8      http://www.apache.org/licenses/LICENSE-2.0
     9  
    10  Unless required by applicable law or agreed to in writing, software
    11  distributed under the License is distributed on an "AS IS" BASIS,
    12  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    13  See the License for the specific language governing permissions and
    14  limitations under the License.
    15  */
    16  
    17  package binlog
    18  
    19  import (
    20  	"context"
    21  
    22  	binlogdatapb "vitess.io/vitess/go/vt/proto/binlogdata"
    23  	topodatapb "vitess.io/vitess/go/vt/proto/topodata"
    24  )
    25  
    26  // UpdateStream is the interface for the binlog server
    27  type UpdateStream interface {
    28  	// StreamKeyRange streams events related to a KeyRange only
    29  	StreamKeyRange(ctx context.Context, position string, keyRange *topodatapb.KeyRange, charset *binlogdatapb.Charset, callback func(trans *binlogdatapb.BinlogTransaction) error) error
    30  
    31  	// StreamTables streams events related to a set of Tables only
    32  	StreamTables(ctx context.Context, position string, tables []string, charset *binlogdatapb.Charset, callback func(trans *binlogdatapb.BinlogTransaction) error) error
    33  
    34  	// HandlePanic should be called in a defer,
    35  	// first thing in the RPC implementation.
    36  	HandlePanic(*error)
    37  }