Class SqliteSchema
Schema management/reflection features for Sqlite
Property Summary
-
$_constraintsIdMap protected
arrayArray containing the foreign keys constraints names Necessary for composite foreign keys to be handled
-
$_driver protected
Cake\Database\DriverInterfaceThe driver instance being used.
-
$_hasSequences protected
boolWhether there is any table in this connection to SQLite containing sequences.
Method Summary
-
__construct() public
Constructor
-
_convertColumn() protected
Convert a column definition to the abstract types.
-
_convertConstraintColumns() protected
Convert foreign key constraints references to a valid stringified list
-
_convertOnClause() protected
Convert string on clauses to the abstract ones.
-
_defaultValue() protected
Manipulate the default value.
-
_foreignOnClause() protected
Generate an ON clause for a foreign key.
-
addConstraintSql() public
Generate the SQL queries needed to add foreign key constraints to the table
-
columnSql() public
Generate the SQL fragment for a single column in a table.
-
constraintSql() public
Generate the SQL fragments for defining table constraints.
-
convertColumnDescription() public
Convert field description results into abstract schema fields.
-
convertForeignKeyDescription() public
Convert a foreign key description into constraints on the Table object.
-
convertIndexDescription() public
Convert an index description results into abstract schema indexes or constraints.
-
convertOptionsDescription() public
Convert options data into table options.
-
createTableSql() public
Generate the SQL to create a table.
-
describeColumnSql() public
Generate the SQL to describe a table.
-
describeForeignKeySql() public
Generate the SQL to describe the foreign keys in a table.
-
describeIndexSql() public
Generate the SQL to describe the indexes in a table.
-
describeOptionsSql() public
Generate the SQL to describe table options
-
dropConstraintSql() public
Generate the SQL queries needed to drop foreign key constraints from the table
-
dropTableSql() public
Generate the SQL to drop a table.
-
hasSequences() public
Returns whether there is any table in this connection to SQLite containing sequences
-
indexSql() public
Generate the SQL fragment for a single index in a table.
-
listTablesSql() public
Generate the SQL to list the tables.
-
truncateTableSql() public
Generate the SQL to truncate a table.
Method Detail
__construct() ¶ public
__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.
Parameters
-
Cake\Database\DriverInterface$driver The driver to use.
_convertColumn() ¶ protected
_convertColumn(string $column): arrayConvert a column definition to the abstract types.
The returned type will be a type that Cake\Database\TypeFactory can handle.
Parameters
-
string$column The column type + length
Returns
arrayThrows
Cake\Database\Exceptionwhen unable to parse column type
_convertConstraintColumns() ¶ protected
_convertConstraintColumns(string|array $references): stringConvert foreign key constraints references to a valid stringified list
Parameters
-
string|array$references The referenced columns of a foreign key constraint statement
Returns
string_convertOnClause() ¶ protected
_convertOnClause(string $clause): stringConvert string on clauses to the abstract ones.
Parameters
-
string$clause The on clause to convert.
Returns
string_defaultValue() ¶ protected
_defaultValue(string|int|null $default): string|int|nullManipulate the default value.
Sqlite includes quotes and bared NULLs in default values. We need to remove those.
Parameters
-
string|int|null$default The default value.
Returns
string|int|null_foreignOnClause() ¶ protected
_foreignOnClause(string $on): stringGenerate an ON clause for a foreign key.
Parameters
-
string$on The on clause
Returns
stringaddConstraintSql() ¶ public
addConstraintSql(Cake\Database\Schema\TableSchema $schema): arrayGenerate the SQL queries needed to add foreign key constraints to the table
SQLite can not properly handle adding a constraint to an existing table. This method is no-op
Parameters
-
Cake\Database\Schema\TableSchema$schema The table instance the foreign key constraints are.
Returns
arraycolumnSql() ¶ public
columnSql(Cake\Database\Schema\TableSchema $schema, string $name): stringGenerate the SQL fragment for a single column in a table.
Parameters
-
Cake\Database\Schema\TableSchema$schema The table instance the column is in.
-
string$name The name of the column.
Returns
stringThrows
Cake\Database\Exceptionwhen the column type is unknown
constraintSql() ¶ public
constraintSql(Cake\Database\Schema\TableSchema $schema, string $name): stringGenerate the SQL fragments for defining table constraints.
Note integer primary keys will return ''. This is intentional as Sqlite requires that integer primary keys be defined in the column definition.
Parameters
-
Cake\Database\Schema\TableSchema$schema The table instance the column is in.
-
string$name The name of the column.
Returns
stringconvertColumnDescription() ¶ public
convertColumnDescription(Cake\Database\Schema\TableSchema $schema, array $row): voidConvert field description results into abstract schema fields.
Parameters
-
Cake\Database\Schema\TableSchema$schema -
array$row
Returns
voidconvertForeignKeyDescription() ¶ public
convertForeignKeyDescription(Cake\Database\Schema\TableSchema $schema, array $row): voidConvert a foreign key description into constraints on the Table object.
Parameters
-
Cake\Database\Schema\TableSchema$schema -
array$row
Returns
voidconvertIndexDescription() ¶ public
convertIndexDescription(Cake\Database\Schema\TableSchema $schema, array $row): voidConvert an index description results into abstract schema indexes or constraints.
Since SQLite does not have a way to get metadata about all indexes at once, additional queries are done here. Sqlite constraint names are not stable, and the names for constraints will not match those used to create the table. This is a limitation in Sqlite's metadata features.
Parameters
-
Cake\Database\Schema\TableSchema$schema The table object to append an index or constraint to.
-
array$row The row data from
describeIndexSql.
Returns
voidconvertOptionsDescription() ¶ public
convertOptionsDescription(Cake\Database\Schema\TableSchema $schema, array $row): voidConvert options data into table options.
Parameters
-
Cake\Database\Schema\TableSchema$schema Table instance.
-
array$row The row of data.
Returns
voidcreateTableSql() ¶ public
createTableSql(Cake\Database\Schema\TableSchema $schema, string[] $columns, string[] $constraints, string[] $indexes): string[]Generate the SQL to create a table.
Parameters
-
Cake\Database\Schema\TableSchema$schema -
string[]$columns -
string[]$constraints -
string[]$indexes
Returns
string[]describeColumnSql() ¶ public
describeColumnSql(string $tableName, array $config): arrayGenerate the SQL to describe a table.
Parameters
-
string$tableName -
array$config
Returns
arraydescribeForeignKeySql() ¶ public
describeForeignKeySql(string $tableName, array $config): arrayGenerate the SQL to describe the foreign keys in a table.
Parameters
-
string$tableName -
array$config
Returns
arraydescribeIndexSql() ¶ public
describeIndexSql(string $tableName, array $config): arrayGenerate the SQL to describe the indexes in a table.
Parameters
-
string$tableName -
array$config
Returns
arraydescribeOptionsSql() ¶ public
describeOptionsSql(string $tableName, array $config): arrayGenerate the SQL to describe table options
Parameters
-
string$tableName Table name.
-
array$config The connection configuration.
Returns
arraydropConstraintSql() ¶ public
dropConstraintSql(Cake\Database\Schema\TableSchema $schema): arrayGenerate the SQL queries needed to drop foreign key constraints from the table
SQLite can not properly handle dropping a constraint to an existing table. This method is no-op
Parameters
-
Cake\Database\Schema\TableSchema$schema The table instance the foreign key constraints are.
Returns
arraydropTableSql() ¶ public
dropTableSql(Cake\Database\Schema\TableSchema $schema): arrayGenerate the SQL to drop a table.
Parameters
-
Cake\Database\Schema\TableSchema$schema Schema instance
Returns
arrayhasSequences() ¶ public
hasSequences(): boolReturns whether there is any table in this connection to SQLite containing sequences
Returns
boolindexSql() ¶ public
indexSql(Cake\Database\Schema\TableSchema $schema, string $name): stringGenerate the SQL fragment for a single index in a table.
Parameters
-
Cake\Database\Schema\TableSchema$schema -
string$name
Returns
stringlistTablesSql() ¶ public
listTablesSql(array $config): arrayGenerate the SQL to list the tables.
Parameters
-
array$config
Returns
arraytruncateTableSql() ¶ public
truncateTableSql(Cake\Database\Schema\TableSchema $schema): arrayGenerate the SQL to truncate a table.
Parameters
-
Cake\Database\Schema\TableSchema$schema
Returns
array