Interface TableSchemaInterface
An interface used by database TableSchema objects.
Constants
-
stringTYPE_BIGINTEGER ¶'biginteger'Big Integer column type
-
stringTYPE_BINARY ¶'binary'Binary column type
-
stringTYPE_BINARY_UUID ¶'binaryuuid'Binary UUID column type
-
stringTYPE_BOOLEAN ¶'boolean'Boolean column type
-
stringTYPE_DATE ¶'date'Date column type
-
stringTYPE_DATETIME ¶'datetime'Datetime column type
-
stringTYPE_DECIMAL ¶'decimal'Decimal column type
-
stringTYPE_FLOAT ¶'float'Float column type
-
stringTYPE_INTEGER ¶'integer'Integer column type
-
stringTYPE_JSON ¶'json'JSON column type
-
stringTYPE_SMALLINTEGER ¶'smallinteger'Small Integer column type
-
stringTYPE_STRING ¶'string'String column type
-
stringTYPE_TEXT ¶'text'Text column type
-
stringTYPE_TIME ¶'time'Time column type
-
stringTYPE_TIMESTAMP ¶'timestamp'Timestamp column type
-
stringTYPE_TINYINTEGER ¶'tinyinteger'Tiny Integer column type
-
stringTYPE_UUID ¶'uuid'UUID column type
Method Summary
-
addColumn() public
Add a column to the table.
-
addConstraint() public
Add a constraint.
-
addIndex() public
Add an index.
-
baseColumnType() public
Returns the base type name for the provided column. This represent the database type a more complex class is based upon.
-
columns() public
Get the column names in the table.
-
constraints() public
Get the names of all the constraints in the table.
-
defaultValues() public
Get a hash of columns and their default values.
-
dropConstraint() public
Remove a constraint.
-
getColumn() public
Get column data in the table.
-
getColumnType() public
Returns column type or null if a column does not exist.
-
getConstraint() public
Read information about a constraint based on name.
-
getIndex() public
Read information about an index based on name.
-
getOptions() public
Gets the options for a table.
-
hasAutoincrement() public
Check whether or not a table has an autoIncrement column defined.
-
hasColumn() public
Returns true if a column exists in the schema.
-
indexes() public
Get the names of all the indexes in the table.
-
isNullable() public
Check whether or not a field is nullable
-
isTemporary() public
Gets whether the table is temporary in the database.
-
name() public
Get the name of the table.
-
primaryKey() public
Get the column(s) used for the primary key.
-
removeColumn() public
Remove a column from the table schema.
-
setColumnType() public
Sets the type of a column.
-
setOptions() public
Sets the options for a table.
-
setTemporary() public
Sets whether the table is temporary in the database.
-
typeMap() public
Returns an array where the keys are the column names in the schema and the values the database type they have.
Method Detail
addColumn() ¶ public
addColumn(string $name, array|string $attrs): $thisAdd a column to the table.
Attributes
Columns can have several attributes:
typeThe type of the column. This should be one of CakePHP's abstract types.lengthThe length of the column.precisionThe number of decimal places to store for float and decimal types.defaultThe default value of the column.nullWhether or not the column can hold nulls.fixedWhether or not the column is a fixed length column. This is only present/valid with string columns.unsignedWhether or not the column is an unsigned column. This is only present/valid for integer, decimal, float columns.
In addition to the above keys, the following keys are implemented in some database dialects, but not all:
commentThe comment for the column.
Parameters
-
string$name The name of the column
-
array|string$attrs The attributes for the column.
Returns
$thisaddConstraint() ¶ public
addConstraint(string $name, array $attrs): $thisAdd a constraint.
Used to add constraints to a table. For example primary keys, unique keys and foreign keys.
Attributes
typeThe type of constraint being added.columnsThe columns in the index.referencesThe table, column a foreign key references.updateThe behavior on update. Options are 'restrict', 'setNull', 'cascade', 'noAction'.deleteThe behavior on delete. Options are 'restrict', 'setNull', 'cascade', 'noAction'.
The default for 'update' & 'delete' is 'cascade'.
Parameters
-
string$name The name of the constraint.
-
array$attrs The attributes for the constraint.
Returns
$thisaddIndex() ¶ public
addIndex(string $name, array $attrs): $thisAdd an index.
Used to add indexes, and full text indexes in platforms that support them.
Attributes
typeThe type of index being added.columnsThe columns in the index.
Parameters
-
string$name The name of the index.
-
array$attrs The attributes for the index.
Returns
$thisbaseColumnType() ¶ public
baseColumnType(string $column): string|nullReturns the base type name for the provided column. This represent the database type a more complex class is based upon.
Parameters
-
string$column The column name to get the base type from
Returns
string|nullconstraints() ¶ public
constraints(): string[]Get the names of all the constraints in the table.
Returns
string[]defaultValues() ¶ public
defaultValues(): arrayGet a hash of columns and their default values.
Returns
arraydropConstraint() ¶ public
dropConstraint(string $name): $thisRemove a constraint.
Parameters
-
string$name Name of the constraint to remove
Returns
$thisgetColumn() ¶ public
getColumn(string $name): array|nullGet column data in the table.
Parameters
-
string$name The column name.
Returns
array|nullgetColumnType() ¶ public
getColumnType(string $name): string|nullReturns column type or null if a column does not exist.
Parameters
-
string$name The column to get the type of.
Returns
string|nullgetConstraint() ¶ public
getConstraint(string $name): array|nullRead information about a constraint based on name.
Parameters
-
string$name The name of the constraint.
Returns
array|nullgetIndex() ¶ public
getIndex(string $name): array|nullRead information about an index based on name.
Parameters
-
string$name The name of the index.
Returns
array|nullgetOptions() ¶ public
getOptions(): arrayGets the options for a table.
Table options allow you to set platform specific table level options. For example the engine type in MySQL.
Returns
arrayhasAutoincrement() ¶ public
hasAutoincrement(): boolCheck whether or not a table has an autoIncrement column defined.
Returns
boolhasColumn() ¶ public
hasColumn(string $name): boolReturns true if a column exists in the schema.
Parameters
-
string$name Column name.
Returns
boolindexes() ¶ public
indexes(): string[]Get the names of all the indexes in the table.
Returns
string[]isNullable() ¶ public
isNullable(string $name): boolCheck whether or not a field is nullable
Missing columns are nullable.
Parameters
-
string$name The column to get the type of.
Returns
boolisTemporary() ¶ public
isTemporary(): boolGets whether the table is temporary in the database.
Returns
boolremoveColumn() ¶ public
removeColumn(string $name): $thisRemove a column from the table schema.
If the column is not defined in the table, no error will be raised.
Parameters
-
string$name The name of the column
Returns
$thissetColumnType() ¶ public
setColumnType(string $name, string $type): $thisSets the type of a column.
Parameters
-
string$name The column to set the type of.
-
string$type The type to set the column to.
Returns
$thissetOptions() ¶ public
setOptions(array $options): $thisSets the options for a table.
Table options allow you to set platform specific table level options. For example the engine type in MySQL.
Parameters
-
array$options The options to set, or null to read options.
Returns
$thissetTemporary() ¶ public
setTemporary(bool $temporary): $thisSets whether the table is temporary in the database.
Parameters
-
bool$temporary Whether or not the table is to be temporary.
Returns
$thistypeMap() ¶ public
typeMap(): arrayReturns an array where the keys are the column names in the schema and the values the database type they have.
Returns
array