Schema management/reflection features for SQLServer.
string
'dbo'
\Cake\Database\DriverInterface
The driver instance being used.
Convert foreign key constraints references to a valid stringified list
Generate the SQL queries needed to add foreign key constraints to the table
Convert a foreign key description into constraints on the Table object.
Convert an index description results into abstract schema indexes or constraints.
Generate the SQL queries needed to drop foreign key constraints from the table
__construct(\Cake\Database\DriverInterface $driver)
Constructor
This constructor will connect the driver so that methods like columnSql() and others will fail when the driver has not been connected.
\Cake\Database\DriverInterface
$driver The driver to use.
_convertColumn(string $col, ?int $length, ?int $precision, ?int $scale)
Convert a column definition to the abstract types.
The returned type will be a type that Cake\Database\TypeFactory can handle.
string
$col The column type
int|null
$length optional the column length
int|null
$precision optional The column precision
int|null
$scale optional The column scale
array
Array of column information.
_convertConstraintColumns(mixed $references)
Convert foreign key constraints references to a valid stringified list
string|array
$references The referenced columns of a foreign key constraint statement
string
_convertOnClause(string $clause)
Convert string on clauses to the abstract ones.
string
$clause The on clause to convert.
string
_defaultValue(mixed $type, mixed $default)
Manipulate the default value.
Removes () wrapping default values, extracts strings from N'' wrappers and collation text and converts NULL strings.
string
$type The schema type
string|null
$default The default value.
string|int|null
_foreignOnClause(string $on)
Generate an ON clause for a foreign key.
string
$on The on clause
string
_keySql(string $prefix, array $data)
Helper method for generating key SQL snippets.
string
$prefix The key prefix
array
$data Key data.
string
addConstraintSql(\Cake\Database\Schema\TableSchema $schema)
Generate the SQL queries needed to add foreign key constraints to the table
\Cake\Database\Schema\TableSchema
$schema The table instance the foreign key constraints are.
array
SQL fragment.
columnSql(\Cake\Database\Schema\TableSchema $schema, string $name)
Generate the SQL fragment for a single column in a table.
\Cake\Database\Schema\TableSchema
$schema The table instance the column is in.
string
$name The name of the column.
string
SQL fragment.
constraintSql(\Cake\Database\Schema\TableSchema $schema, string $name)
Generate the SQL fragments for defining table constraints.
\Cake\Database\Schema\TableSchema
$schema The table instance the column is in.
string
$name The name of the column.
string
SQL fragment.
convertColumnDescription(\Cake\Database\Schema\TableSchema $schema, array $row)
Convert field description results into abstract schema fields.
\Cake\Database\Schema\TableSchema
$schema The table object to append fields to.
array
$row The row data from describeColumnSql
.
convertForeignKeyDescription(\Cake\Database\Schema\TableSchema $schema, array $row)
Convert a foreign key description into constraints on the Table object.
\Cake\Database\Schema\TableSchema
$schema The table object to append a constraint to.
array
$row The row data from describeForeignKeySql
.
convertIndexDescription(\Cake\Database\Schema\TableSchema $schema, array $row)
Convert an index description results into abstract schema indexes or constraints.
\Cake\Database\Schema\TableSchema
$schema The table object to append an index or constraint to.
array
$row The row data from describeIndexSql
.
convertOptionsDescription(\Cake\Database\Schema\TableSchema $schema, array $row)
Convert options data into table options.
\Cake\Database\Schema\TableSchema
$schema Table instance.
array
$row The row of data.
createTableSql(\Cake\Database\Schema\TableSchema $schema, array $columns, array $constraints, array $indexes)
Generate the SQL to create a table.
\Cake\Database\Schema\TableSchema
$schema Table instance.
string[]
$columns The columns to go inside the table.
string[]
$constraints The constraints for the table.
string[]
$indexes The indexes for the table.
string[]
SQL statements to create a table.
describeColumnSql(string $tableName, array $config)
Generate the SQL to describe a table.
string
$tableName The table name to get information on.
array
$config The connection configuration.
array
An array of (sql, params) to execute.
describeForeignKeySql(string $tableName, array $config)
Generate the SQL to describe the foreign keys in a table.
string
$tableName The table name to get information on.
array
$config The connection configuration.
array
An array of (sql, params) to execute.
describeIndexSql(string $tableName, array $config)
Generate the SQL to describe the indexes in a table.
string
$tableName The table name to get information on.
array
$config The connection configuration.
array
An array of (sql, params) to execute.
describeOptionsSql(string $tableName, array $config)
Generate the SQL to describe table options
string
$tableName Table name.
array
$config The connection configuration.
array
SQL statements to get options for a table.
dropConstraintSql(\Cake\Database\Schema\TableSchema $schema)
Generate the SQL queries needed to drop foreign key constraints from the table
\Cake\Database\Schema\TableSchema
$schema The table instance the foreign key constraints are.
array
SQL fragment.
dropTableSql(\Cake\Database\Schema\TableSchema $schema)
Generate the SQL to drop a table.
\Cake\Database\Schema\TableSchema
$schema Schema instance
array
SQL statements to drop a table.
indexSql(\Cake\Database\Schema\TableSchema $schema, string $name)
Generate the SQL fragment for a single index in a table.
\Cake\Database\Schema\TableSchema
$schema The table object the column is in.
string
$name The name of the column.
string
SQL fragment.
listTablesSql(array $config)
Generate the SQL to list the tables.
array
$config The connection configuration to use for getting tables from.
array
An array of (sql, params) to execute.
truncateTableSql(\Cake\Database\Schema\TableSchema $schema)
Generate the SQL to truncate a table.
\Cake\Database\Schema\TableSchema
$schema Table instance.
array
SQL statements to truncate a table.
The driver instance being used.
\Cake\Database\DriverInterface
© 2005–present The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
https://api.cakephp.org/4.1/class-Cake.Database.Schema.SqlserverSchemaDialect.html