Files
tidb/pkg/ddl/table_mode.go
2025-08-11 09:02:45 +00:00

101 lines
3.4 KiB
Go

// Copyright 2025 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 (
"github.com/pingcap/errors"
"github.com/pingcap/tidb/pkg/infoschema"
"github.com/pingcap/tidb/pkg/meta/model"
"github.com/pingcap/tidb/pkg/sessionctx"
)
// onAlterTableMode should only be called by alterTableMode, will call updateVersionAndTableInfo
func onAlterTableMode(jobCtx *jobContext, job *model.Job) (ver int64, err error) {
args, err := model.GetAlterTableModeArgs(job)
if err != nil {
return ver, err
}
var tbInfo *model.TableInfo
metaMut := jobCtx.metaMut
tbInfo, err = GetTableInfoAndCancelFaultJob(metaMut, job, job.SchemaID)
if err != nil {
return ver, err
}
switch tbInfo.Mode {
case model.TableModeNormal, model.TableModeImport, model.TableModeRestore:
if tbInfo.Mode == args.TableMode {
job.State = model.JobStateDone
return ver, err
}
// directly change table mode to target mode
err = alterTableMode(tbInfo, args)
if err != nil {
job.State = model.JobStateCancelled
return ver, err
}
// update table info and schema version
ver, err = updateVersionAndTableInfo(jobCtx, job, tbInfo, true)
if err != nil {
return ver, errors.Trace(err)
}
job.FinishTableJob(model.JobStateDone, model.StatePublic, ver, tbInfo)
default:
job.State = model.JobStateCancelled
err = infoschema.ErrInvalidTableModeSet.GenWithStackByArgs(tbInfo.Mode, args.TableMode, tbInfo.Name.O)
}
return ver, err
}
// alterTableMode first checks if the change is valid and changes table mode to target mode
// Currently we can assume args.TableMode will NEVER be model.TableModeRestore.
// Because BR will NOT use this function to set a table into ModeRestore,
// instead BR will use (batch)CreateTableWithInfo.
func alterTableMode(tbInfo *model.TableInfo, args *model.AlterTableModeArgs) error {
ok := validateTableMode(tbInfo.Mode, args.TableMode)
if !ok {
return infoschema.ErrInvalidTableModeSet.GenWithStackByArgs(tbInfo.Mode, args.TableMode, tbInfo.Name.O)
}
tbInfo.Mode = args.TableMode
return nil
}
// validateTableMode validate whether table mode convert is legal.
// Now only block import/restore to convert to each other.
// TODO: Now allow switching between the same table modes, but additional validation will be added later
// to verify that only the same modification source can perform ALTER same table mode.
func validateTableMode(origin, target model.TableMode) bool {
if origin == model.TableModeImport && target == model.TableModeRestore {
return false
}
if origin == model.TableModeRestore && target == model.TableModeImport {
return false
}
return true
}
// AlterTableMode creates a DDL job for alter table mode.
func AlterTableMode(de Executor, sctx sessionctx.Context, mode model.TableMode, schemaID, tableID int64) error {
args := &model.AlterTableModeArgs{
TableMode: mode,
SchemaID: schemaID,
TableID: tableID,
}
return de.AlterTableMode(sctx, args)
}