Files
tidb/pkg/ddl/options.go

89 lines
2.6 KiB
Go

// Copyright 2019 PingCAP, Inc.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package ddl
import (
"time"
"github.com/pingcap/tidb/pkg/ddl/notifier"
"github.com/pingcap/tidb/pkg/infoschema"
"github.com/pingcap/tidb/pkg/kv"
"github.com/pingcap/tidb/pkg/meta/autoid"
clientv3 "go.etcd.io/etcd/client/v3"
)
// Option represents an option to initialize the DDL module
type Option func(*Options)
// Options represents all the options of the DDL module needs
type Options struct {
EtcdCli *clientv3.Client
Store kv.Storage
AutoIDClient *autoid.ClientDiscover
InfoCache *infoschema.InfoCache
Lease time.Duration
SchemaLoader SchemaLoader
EventPublishStore notifier.Store
}
// WithEtcdClient specifies the `clientv3.Client` of DDL used to request the etcd service
func WithEtcdClient(client *clientv3.Client) Option {
return func(options *Options) {
options.EtcdCli = client
}
}
// WithStore specifies the `kv.Storage` of DDL used to request the KV service
func WithStore(store kv.Storage) Option {
return func(options *Options) {
options.Store = store
}
}
// WithInfoCache specifies the `infoschema.InfoCache`
func WithInfoCache(ic *infoschema.InfoCache) Option {
return func(options *Options) {
options.InfoCache = ic
}
}
// WithAutoIDClient specifies the autoid client used by the autoid service for those AUTO_ID_CACHE=1 tables.
func WithAutoIDClient(cli *autoid.ClientDiscover) Option {
return func(options *Options) {
options.AutoIDClient = cli
}
}
// WithLease specifies the schema lease duration
func WithLease(lease time.Duration) Option {
return func(options *Options) {
options.Lease = lease
}
}
// WithSchemaLoader specifies the schema loader used to load schema from storage
func WithSchemaLoader(loader SchemaLoader) Option {
return func(options *Options) {
options.SchemaLoader = loader
}
}
// WithEventPublishStore specifies the store used to publish DDL events
func WithEventPublishStore(store notifier.Store) Option {
return func(options *Options) {
options.EventPublishStore = store
}
}