Class SqlserverSchema
Schema management/reflection features for SQLServer.
- Cake\Database\Schema\BaseSchema
 -  
 Cake\Database\Schema\SqlserverSchema  
Constants summary
-   
string'dbo' 
Inherited Properties
Method Summary
-  _convertColumn() protectedConvert a column definition to the abstract types.
 -  _convertOnClause() protectedConvert string on clauses to the abstract ones.
 -  _defaultValue() protectedManipulate the default value.
 -  _foreignOnClause() protectedGenerate an ON clause for a foreign key.
 -  _keySql() protectedHelper method for generating key SQL snippets.
 -  addConstraintSql() publicGenerate the SQL queries needed to add foreign key constraints to the table
 -  columnSql() publicGenerate the SQL fragment for a single column in a table.
 -  constraintSql() publicGenerate the SQL fragments for defining table constraints.
 -  convertColumnDescription() publicConvert field description results into abstract schema fields.
 - Convert a foreign key description into constraints on the Table object.
 -  convertIndexDescription() publicConvert an index description results into abstract schema indexes or constraints.
 -  createTableSql() publicGenerate the SQL to create a table.
 -  describeColumnSql() publicGenerate the SQL to describe a table.
 -  describeForeignKeySql() publicGenerate the SQL to describe the foreign keys in a table.
 -  describeIndexSql() publicGenerate the SQL to describe the indexes in a table.
 -  dropConstraintSql() publicGenerate the SQL queries needed to drop foreign key constraints from the table
 -  indexSql() publicGenerate the SQL fragment for a single index in a table.
 -  listTablesSql() publicGenerate the SQL to list the tables.
 -  truncateTableSql() publicGenerate the SQL to truncate a table.
 
Method Detail
_convertColumn()source protected
_convertColumn( string $col , integer|null $length null , integer|null $precision null , integer|null $scale null )
Convert a column definition to the abstract types.
The returned type will be a type that Cake\Database\Type can handle.
Parameters
-  string 
$col - The column type
 -  integer|null 
$lengthoptional null - the column length
 -  integer|null 
$precisionoptional null - The column precision
 -  integer|null 
$scaleoptional null - The column scale
 
Returns
arrayArray of column information.
Link
http://technet.microsoft.com/en-us/library/ms187752.aspx_convertOnClause()source protected
_convertOnClause( string $clause )
Convert string on clauses to the abstract ones.
Parameters
-  string 
$clause - The on clause to convert.
 
Returns
string|nullOverrides
Cake\Database\Schema\BaseSchema::_convertOnClause()  _defaultValue()source protected
_defaultValue( string|null $default )
Manipulate the default value.
Sqlite includes quotes and bared NULLs in default values. We need to remove those.
Parameters
-  string|null 
$default - The default value.
 
Returns
string|null_foreignOnClause()source protected
_foreignOnClause( string|null $on )
Generate an ON clause for a foreign key.
Parameters
-  string|null 
$on - The on clause
 
Returns
stringOverrides
Cake\Database\Schema\BaseSchema::_foreignOnClause()  _keySql()source protected
_keySql( string $prefix , array $data )
Helper method for generating key SQL snippets.
Parameters
-  string 
$prefix - The key prefix
 -  array 
$data - Key data.
 
Returns
stringaddConstraintSql()source public
addConstraintSql( Cake\Database\Schema\Table $table )
Generate the SQL queries needed to add foreign key constraints to the table
Parameters
-  
Cake\Database\Schema\Table$table - The table instance the foreign key constraints are.
 
Returns
arraySQL fragment.
columnSql()source public
columnSql( Cake\Database\Schema\Table $table , string $name )
Generate the SQL fragment for a single column in a table.
Parameters
-  
Cake\Database\Schema\Table$table - The table instance the column is in.
 -  string 
$name - The name of the column.
 
Returns
stringSQL fragment.
constraintSql()source public
constraintSql( Cake\Database\Schema\Table $table , string $name )
Generate the SQL fragments for defining table constraints.
Parameters
-  
Cake\Database\Schema\Table$table - The table instance the column is in.
 -  string 
$name - The name of the column.
 
Returns
stringSQL fragment.
convertColumnDescription()source public
convertColumnDescription( Cake\Database\Schema\Table $table , array $row )
Convert field description results into abstract schema fields.
Parameters
-  
Cake\Database\Schema\Table$table - The table object to append fields to.
 -  array 
$row - The row data from 
describeColumnSql. 
convertForeignKeyDescription()source public
convertForeignKeyDescription( Cake\Database\Schema\Table $table , array $row )
Convert a foreign key description into constraints on the Table object.
Parameters
-  
Cake\Database\Schema\Table$table The table object to append a constraint to.
-  array 
$row - The row data from 
describeForeignKeySql. 
convertIndexDescription()source public
convertIndexDescription( Cake\Database\Schema\Table $table , array $row )
Convert an index description results into abstract schema indexes or constraints.
Parameters
-  
Cake\Database\Schema\Table$table The table object to append an index or constraint to.
-  array 
$row - The row data from 
describeIndexSql. 
createTableSql()source public
createTableSql( Cake\Database\Schema\Table $table , array $columns , array $constraints , array $indexes )
Generate the SQL to create a table.
Parameters
-  
Cake\Database\Schema\Table$table - Table instance.
 -  array 
$columns - The columns to go inside the table.
 -  array 
$constraints - The constraints for the table.
 -  array 
$indexes - The indexes for the table.
 
Returns
arraySQL statements to create a table.
describeColumnSql()source public
describeColumnSql( string $tableName , array $config )
Generate the SQL to describe a table.
Parameters
-  string 
$tableName - The table name to get information on.
 -  array 
$config - The connection configuration.
 
Returns
arrayAn array of (sql, params) to execute.
describeForeignKeySql()source public
describeForeignKeySql( string $tableName , array $config )
Generate the SQL to describe the foreign keys in a table.
Parameters
-  string 
$tableName - The table name to get information on.
 -  array 
$config - The connection configuration.
 
Returns
arrayAn array of (sql, params) to execute.
describeIndexSql()source public
describeIndexSql( string $tableName , array $config )
Generate the SQL to describe the indexes in a table.
Parameters
-  string 
$tableName - The table name to get information on.
 -  array 
$config - The connection configuration.
 
Returns
arrayAn array of (sql, params) to execute.
dropConstraintSql()source public
dropConstraintSql( Cake\Database\Schema\Table $table )
Generate the SQL queries needed to drop foreign key constraints from the table
Parameters
-  
Cake\Database\Schema\Table$table - The table instance the foreign key constraints are.
 
Returns
arraySQL fragment.
indexSql()source public
indexSql( Cake\Database\Schema\Table $table , string $name )
Generate the SQL fragment for a single index in a table.
Parameters
-  
Cake\Database\Schema\Table$table - The table object the column is in.
 -  string 
$name - The name of the column.
 
Returns
stringSQL fragment.
listTablesSql()source public
listTablesSql( array $config )
Generate the SQL to list the tables.
Parameters
-  array 
$config The connection configuration to use for getting tables from.
Returns
arrayAn array of (sql, params) to execute.
truncateTableSql()source public
truncateTableSql( Cake\Database\Schema\Table $table )
Generate the SQL to truncate a table.
Parameters
-  
Cake\Database\Schema\Table$table - Table instance.
 
Returns
arraySQL statements to truncate a table.
Methods inherited from Cake\Database\Schema\BaseSchema
__construct()source public
__construct( Cake\Database\Driver $driver )
Constructor
This constructor will connect the driver so that methods like columnSql() and others will fail when the driver has not been connected.
Parameters
-  
Cake\Database\Driver$driver - The driver to use.
 
_convertConstraintColumns()source protected
_convertConstraintColumns( string|array $references )
Convert foreign key constraints references to a valid stringified list
Parameters
-  string|array 
$references - The referenced columns of a foreign key constraint statement
 
Returns
stringconvertOptionsDescription()source public
convertOptionsDescription( Cake\Database\Schema\Table $table , array $row )
Convert options data into table options.
Parameters
-  
Cake\Database\Schema\Table$table - Table instance.
 -  array 
$row - The row of data.
 
describeOptionsSql()source public
describeOptionsSql( string $tableName , array $config )
Generate the SQL to describe table options
Parameters
-  string 
$tableName - Table name.
 -  array 
$config - The connection configuration.
 
Returns
arraySQL statements to get options for a table.
dropTableSql()source public
dropTableSql( Cake\Database\Schema\Table $table )
Generate the SQL to drop a table.
Parameters
-  
Cake\Database\Schema\Table$table - Table instance
 
Returns
arraySQL statements to drop a table.
    © 2005–2017 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/3.3/class-Cake.Database.Schema.SqlserverSchema.html