类 MysqlSchemaDialect

MySQL 的模式生成/反射功能

命名空间: Cake\Database\Schema

属性摘要

$_driver protected

Cake\Database\Driver

正在使用的驱动程序实例。

方法摘要

__construct() public

构造函数
_applyTypeSpecificColumnConversion() protected

尝试使用匹配的数据库类型将 SQL 列定义转换为抽象类型定义。
_convertColumn() protected

将 MySQL 列类型转换为抽象类型。
_convertConstraintColumns() protected

将外键约束引用转换为有效的字符串化列表
_convertOnClause() protected

将字符串 ON 子句转换为抽象 ON 子句。
_foreignOnClause() protected

为外键生成 ON 子句。
_getTypeSpecificColumnSql() protected

尝试使用匹配的数据库类型为表中的单个列生成 SQL 片段。
_keySql() protected

用于生成键 SQL 片段的辅助方法。
addConstraintSql() public

生成将外键约束添加到表的 SQL 查询
columnSql() public

为表中的单个列生成 SQL 片段。
constraintSql() public

生成用于定义表约束的 SQL 片段。
convertColumnDescription() public

将字段描述结果转换为抽象模式字段。
convertForeignKeyDescription() public

将外键描述转换为 Table 对象上的约束。
convertIndexDescription() public

将索引描述结果转换为抽象模式索引或约束。
convertOptionsDescription() public

将选项数据转换为表选项。
createTableSql() public

生成创建表的 SQL 语句。
describeColumnSql() public

生成描述表的 SQL 语句。
describeForeignKeySql() public

生成描述表中外键的 SQL 语句。
describeIndexSql() public

生成描述表中索引的 SQL 语句。
describeOptionsSql() public

生成描述表选项的 SQL 语句
dropConstraintSql() public

生成从表中删除外键约束所需的 SQL 查询
dropTableSql() public

生成删除表的 SQL 语句。
indexSql() public

为表中的单个索引生成 SQL 片段。
listTablesSql() public

生成列出表和视图的 SQL 语句。
listTablesWithoutViewsSql() public

生成列出表（不包括所有视图）的 SQL 语句。
truncateTableSql() public

生成截断表的 SQL 语句。

方法详情

__construct() ¶ public

__construct(Cake\Database\Driver $driver)

构造函数

此构造函数将连接驱动程序，以便像 columnSql() 这样的方法在驱动程序未连接时会失败。

参数

Cake\Database\Driver $driver: 要使用的驱动程序。

_applyTypeSpecificColumnConversion() ¶ protected

_applyTypeSpecificColumnConversion(string $columnType, array $definition): array|null

尝试使用匹配的数据库类型将 SQL 列定义转换为抽象类型定义。

参数

string $columnType: 列类型。
array $definition: 列定义。

返回值

array|null

_convertColumn() ¶ protected

_convertColumn(string $column): array<string, mixed>

将 MySQL 列类型转换为抽象类型。

返回的类型将是 Cake\Database\TypeFactory 可以处理的类型。

参数

string $column: 列类型 + 长度

返回值

array<string, mixed>

抛出

Cake\Database\Exception\DatabaseException
当列类型无法解析时。

_convertConstraintColumns() ¶ protected

_convertConstraintColumns(list<string>|string $references): string

将外键约束引用转换为有效的字符串化列表

参数

list<string>|string $references: 外键约束语句的引用列

返回值

string

_convertOnClause() ¶ protected

_convertOnClause(string $clause): string

将字符串 ON 子句转换为抽象 ON 子句。

参数

string $clause: 要转换的 ON 子句。

返回值

string

_foreignOnClause() ¶ protected

_foreignOnClause(string $on): string

为外键生成 ON 子句。

参数

string $on: ON 子句

返回值

string

_getTypeSpecificColumnSql() ¶ protected

_getTypeSpecificColumnSql(string $columnType, Cake\Database\Schema\TableSchemaInterface $schema, string $column): string|null

尝试使用匹配的数据库类型为表中的单个列生成 SQL 片段。

参数

string $columnType: 列类型。
Cake\Database\Schema\TableSchemaInterface $schema: 包含该列的表模式实例。
string $column: 列的名称。

返回值

string|null

_keySql() ¶ protected

_keySql(string $prefix, array $data): string

用于生成键 SQL 片段的辅助方法。

参数

string $prefix: 键前缀
array $data: 键数据。

返回值

string

addConstraintSql() ¶ public

addConstraintSql(Cake\Database\Schema\TableSchema $schema): array

生成将外键约束添加到表的 SQL 查询

参数

Cake\Database\Schema\TableSchema $schema

返回值

array

columnSql() ¶ public

columnSql(Cake\Database\Schema\TableSchema $schema, string $name): string

为表中的单个列生成 SQL 片段。

参数

Cake\Database\Schema\TableSchema $schema
string $name

返回值

string

constraintSql() ¶ public

constraintSql(Cake\Database\Schema\TableSchema $schema, string $name): string

生成用于定义表约束的 SQL 片段。

参数

Cake\Database\Schema\TableSchema $schema
string $name

返回值

string

convertColumnDescription() ¶ public

convertColumnDescription(Cake\Database\Schema\TableSchema $schema, array $row): void

将字段描述结果转换为抽象模式字段。

参数

Cake\Database\Schema\TableSchema $schema
array $row

返回值

void

convertForeignKeyDescription() ¶ public

convertForeignKeyDescription(Cake\Database\Schema\TableSchema $schema, array $row): void

将外键描述转换为 Table 对象上的约束。

参数

Cake\Database\Schema\TableSchema $schema
array $row

返回值

void

convertIndexDescription() ¶ public

convertIndexDescription(Cake\Database\Schema\TableSchema $schema, array $row): void

将索引描述结果转换为抽象模式索引或约束。

参数

Cake\Database\Schema\TableSchema $schema
array $row

返回值

void

convertOptionsDescription() ¶ public

convertOptionsDescription(Cake\Database\Schema\TableSchema $schema, array $row): void

将选项数据转换为表选项。

参数

Cake\Database\Schema\TableSchema $schema
array $row

返回值

void

createTableSql() ¶ public

createTableSql(Cake\Database\Schema\TableSchema $schema, list<string> $columns, list<string> $constraints, list<string> $indexes): list<string>

生成创建表的 SQL 语句。

参数

Cake\Database\Schema\TableSchema $schema
list<string> $columns
list<string> $constraints
list<string> $indexes

返回值

list<string>

describeColumnSql() ¶ public

describeColumnSql(string $tableName, array<string, mixed> $config): array

生成描述表的 SQL 语句。

参数

string $tableName
array<string, mixed> $config

返回值

array

describeForeignKeySql() ¶ public

describeForeignKeySql(string $tableName, array<string, mixed> $config): array

生成描述表中外键的 SQL 语句。

参数

string $tableName
array<string, mixed> $config

返回值

array

describeIndexSql() ¶ public

describeIndexSql(string $tableName, array<string, mixed> $config): array

生成描述表中索引的 SQL 语句。

参数

string $tableName
array<string, mixed> $config

返回值

array

describeOptionsSql() ¶ public

describeOptionsSql(string $tableName, array<string, mixed> $config): array

生成描述表选项的 SQL 语句

参数

string $tableName
array<string, mixed> $config

返回值

array

dropConstraintSql() ¶ public

dropConstraintSql(Cake\Database\Schema\TableSchema $schema): array

生成从表中删除外键约束所需的 SQL 查询

参数

Cake\Database\Schema\TableSchema $schema

返回值

array

dropTableSql() ¶ public

dropTableSql(Cake\Database\Schema\TableSchema $schema): array

生成删除表的 SQL 语句。

参数

Cake\Database\Schema\TableSchema $schema: Schema 实例

返回值

array

indexSql() ¶ public

indexSql(Cake\Database\Schema\TableSchema $schema, string $name): string

为表中的单个索引生成 SQL 片段。

参数

Cake\Database\Schema\TableSchema $schema
string $name

返回值

string

listTablesSql() ¶ public

listTablesSql(array<string, mixed> $config): array<mixed>

生成列出表和视图的 SQL 语句。

参数

array<string, mixed> $config: 用于获取表的连接配置。

返回值

array<mixed>

listTablesWithoutViewsSql() ¶ public

listTablesWithoutViewsSql(array<string, mixed> $config): array<mixed>

生成列出表（不包括所有视图）的 SQL 语句。

参数

array<string, mixed> $config: 用于获取表的连接配置。

返回值

array<mixed>

truncateTableSql() ¶ public

truncateTableSql(Cake\Database\Schema\TableSchema $schema): array

生成截断表的 SQL 语句。

参数

Cake\Database\Schema\TableSchema $schema

返回值

array

属性详情

`$_driver` ¶ protected

正在使用的驱动程序实例。

类型

Cake\Database\Driver

命名空间

类 MysqlSchemaDialect

属性摘要

方法摘要

__construct() public

_applyTypeSpecificColumnConversion() protected

_convertColumn() protected

_convertConstraintColumns() protected

_convertOnClause() protected

_foreignOnClause() protected

_getTypeSpecificColumnSql() protected

_keySql() protected

addConstraintSql() public

columnSql() public

constraintSql() public

convertColumnDescription() public

convertForeignKeyDescription() public

convertIndexDescription() public

convertOptionsDescription() public

createTableSql() public

describeColumnSql() public

describeForeignKeySql() public

describeIndexSql() public

describeOptionsSql() public

dropConstraintSql() public

dropTableSql() public

indexSql() public

listTablesSql() public

listTablesWithoutViewsSql() public

truncateTableSql() public

方法详情

__construct() ¶ public

参数

_applyTypeSpecificColumnConversion() ¶ protected

参数

返回值

_convertColumn() ¶ protected

参数

返回值

抛出

_convertConstraintColumns() ¶ protected

参数

返回值

_convertOnClause() ¶ protected

参数

返回值

_foreignOnClause() ¶ protected

参数

返回值

_getTypeSpecificColumnSql() ¶ protected

参数

返回值

_keySql() ¶ protected

参数

返回值

addConstraintSql() ¶ public

参数

返回值

columnSql() ¶ public

参数

返回值

constraintSql() ¶ public

参数

返回值

convertColumnDescription() ¶ public

参数

返回值

convertForeignKeyDescription() ¶ public

参数

返回值

convertIndexDescription() ¶ public

参数

返回值

convertOptionsDescription() ¶ public

参数

返回值

createTableSql() ¶ public

参数

返回值

describeColumnSql() ¶ public

`$_driver` ¶ protected