tidb

Documentation

Overview

MIT License

Copyright (c) 2025 OcomSoft

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Index

• type Provider
  • func New() *Provider
  • func (p *Provider) ConvertFieldType(field *types.Field) string
  • func (p *Provider) GenerateAddColumn(tableName string, field *types.Field) string
  • func (p *Provider) GenerateAlterColumn(tableName string, oldField, newField *types.Field) (string, error)
  • func (p *Provider) GenerateCreateIndex(index *types.Index, tableName string) string
  • func (p *Provider) GenerateCreateTable(schema *types.Schema, table *types.Table) (string, error)
  • func (p *Provider) GenerateDropColumn(tableName, columnName string) string
  • func (p *Provider) GenerateDropForeignKeyConstraint(tableName, constraintName string) string
  • func (p *Provider) GenerateDropIndex(indexName, tableName string) string
  • func (p *Provider) GenerateDropTable(tableName string) string
  • func (p *Provider) GenerateForeignKeyConstraint(tableName, fieldName, referencedTable, onDelete string) string
  • func (p *Provider) GenerateForeignKeyConstraints(schema *types.Schema, junctionTables []types.Table) string
  • func (p *Provider) GenerateIndexes(schema *types.Schema) string
  • func (p *Provider) GenerateJunctionTable(table1, table2 string, schema *types.Schema) (string, error)
  • func (p *Provider) GenerateRenameColumn(tableName, oldName, newName string) string
  • func (p *Provider) GenerateRenameTable(oldName, newName string) string
  • func (p *Provider) GetDatabaseSchema(connectionString string) (*types.Schema, error)
  • func (p *Provider) GetDefaultValue(defaultRef string, defaults map[string]string) (string, error)
  • func (p *Provider) InferForeignKeyType(referencedTable string, schema *types.Schema) string
  • func (p *Provider) QuoteName(name string) string
  • func (p *Provider) SupportsOperation(operation string) bool

Types

type Provider

type Provider struct{}

Provider implements the Provider interface for TiDB TiDB is MySQL-compatible but distributed with some differences

func New

func New() *Provider

New creates a new TiDB provider

func (*Provider) ConvertFieldType

func (p *Provider) ConvertFieldType(field *types.Field) string

ConvertFieldType converts YAML field type to TiDB-specific SQL type

func (*Provider) GenerateAddColumn

func (p *Provider) GenerateAddColumn(tableName string, field *types.Field) string

GenerateAddColumn generates ALTER TABLE ADD COLUMN statement

func (*Provider) GenerateAlterColumn

func (p *Provider) GenerateAlterColumn(tableName string, oldField, newField *types.Field) (string, error)

func (*Provider) GenerateCreateIndex

func (p *Provider) GenerateCreateIndex(index *types.Index, tableName string) string

GenerateCreateIndex generates CREATE INDEX statement for TiDB

func (*Provider) GenerateCreateTable

func (p *Provider) GenerateCreateTable(schema *types.Schema, table *types.Table) (string, error)

GenerateCreateTable generates CREATE TABLE statement for TiDB

func (*Provider) GenerateDropColumn

func (p *Provider) GenerateDropColumn(tableName, columnName string) string

GenerateDropColumn generates ALTER TABLE DROP COLUMN statement

func (*Provider) GenerateDropForeignKeyConstraint

func (p *Provider) GenerateDropForeignKeyConstraint(tableName, constraintName string) string

func (*Provider) GenerateDropIndex

func (p *Provider) GenerateDropIndex(indexName, tableName string) string

GenerateDropIndex generates DROP INDEX statement for TiDB

func (*Provider) GenerateDropTable

func (p *Provider) GenerateDropTable(tableName string) string

GenerateDropTable generates DROP TABLE statement

func (*Provider) GenerateForeignKeyConstraint

func (p *Provider) GenerateForeignKeyConstraint(tableName, fieldName, referencedTable, onDelete string) string

func (*Provider) GenerateForeignKeyConstraints

func (p *Provider) GenerateForeignKeyConstraints(schema *types.Schema, junctionTables []types.Table) string

func (*Provider) GenerateIndexes

func (p *Provider) GenerateIndexes(schema *types.Schema) string

func (*Provider) GenerateJunctionTable

func (p *Provider) GenerateJunctionTable(table1, table2 string, schema *types.Schema) (string, error)

func (*Provider) GenerateRenameColumn

func (p *Provider) GenerateRenameColumn(tableName, oldName, newName string) string

GenerateRenameColumn generates ALTER TABLE CHANGE statement for TiDB (same as MySQL)

func (*Provider) GenerateRenameTable

func (p *Provider) GenerateRenameTable(oldName, newName string) string

GenerateRenameTable generates RENAME TABLE statement

func (*Provider) GetDatabaseSchema

func (p *Provider) GetDatabaseSchema(connectionString string) (*types.Schema, error)

GetDatabaseSchema extracts schema information from a TiDB database

func (*Provider) GetDefaultValue

func (p *Provider) GetDefaultValue(defaultRef string, defaults map[string]string) (string, error)

GetDefaultValue converts default value references to TiDB-specific values

func (*Provider) InferForeignKeyType

func (p *Provider) InferForeignKeyType(referencedTable string, schema *types.Schema) string

func (*Provider) QuoteName

func (p *Provider) QuoteName(name string) string

QuoteName quotes database identifiers for TiDB (same as MySQL)

func (*Provider) SupportsOperation

func (p *Provider) SupportsOperation(operation string) bool

SupportsOperation checks if TiDB supports a specific operation