Class Table
Represents a single table in a database schema.
Can either be populated using the reflection API's or by incrementally building an instance using methods.
Once created Table instances can be added to Schema\Collection objects. They can also be converted into SQL using the createSql(), dropSql() and truncateSql() methods.
Constants
-
stringACTION_CASCADE ¶'cascade'Foreign key cascade action
-
stringACTION_NO_ACTION ¶'noAction'Foreign key no action
-
stringACTION_RESTRICT ¶'restrict'Foreign key restrict action
-
stringACTION_SET_DEFAULT ¶'setDefault'Foreign key restrict default
-
stringACTION_SET_NULL ¶'setNull'Foreign key set null action
-
stringCONSTRAINT_FOREIGN ¶'foreign'Foreign constraint type
-
stringCONSTRAINT_PRIMARY ¶'primary'Primary constraint type
-
stringCONSTRAINT_UNIQUE ¶'unique'Unique constraint type
-
stringINDEX_FULLTEXT ¶'fulltext'Fulltext index type
-
stringINDEX_INDEX ¶'index'Index - index type
Property Summary
-
$_columnExtras protected static
arrayAdditional type specific properties.
-
$_columnKeys protected static
arrayThe valid keys that can be used in a column definition.
-
$_columns protected
arrayColumns in the table.
-
$_constraints protected
arrayConstraints in the table.
-
$_indexKeys protected static
arrayThe valid keys that can be used in an index definition.
-
$_indexes protected
arrayIndexes in the table.
-
$_options protected
arrayOptions for the table.
-
$_table protected
stringThe name of the table
-
$_temporary protected
boolWhether or not the table is temporary
-
$_validConstraintTypes protected static
arrayNames of the valid constraint types.
-
$_validForeignKeyActions protected static
arrayNames of the valid foreign key actions.
-
$_validIndexTypes protected static
arrayNames of the valid index types.
Method Summary
-
__construct() public
Constructor.
-
_checkForeignKey() protected
Helper method to check/validate foreign keys.
-
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.
-
column() public
Get column data in the table.
-
columnType() public
Sets the type of a column, or returns its current type if none is passed.
-
columns() public
Get the column names in the table.
-
constraint() public
Read information about a constraint based on name.
-
constraints() public
Get the names of all the constraints in the table.
-
createSql() public
Generate the SQL to create the Table.
-
defaultValues() public
Get a hash of columns and their default values.
-
dropSql() public
Generate the SQL to drop a table.
-
hasAutoincrement() public
Check whether or not a table has an autoIncrement column defined.
-
index() public
Read information about an index based on name.
-
indexes() public
Get the names of all the indexes in the table.
-
isNullable() public
Check whether or not a field is nullable
-
name() public
Get the name of the table.
-
options() public
Get/set the options for a table.
-
primaryKey() public
Get the column(s) used for the primary key.
-
temporary() public
Get/Set whether the table is temporary in the database
-
truncateSql() public
Generate the SQL statements to truncate a table
Method Detail
__construct() ¶ public
__construct(string $table, array $columns = [])Constructor.
Parameters
-
string$table The table name.
-
array$columns optional The list of columns for the schema.
_checkForeignKey() ¶ protected
_checkForeignKey(array $attrs): arrayHelper method to check/validate foreign keys.
Parameters
-
array$attrs Attributes to set.
Returns
arrayThrows
Cake\Database\ExceptionWhen foreign key definition is not valid.
addColumn() ¶ public
addColumn(string $name, array $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$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
$thisThrows
Cake\Database\ExceptionaddIndex() ¶ 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
$thisThrows
Cake\Database\ExceptionbaseColumnType() ¶ public
baseColumnType(string $column): stringReturns 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
stringcolumn() ¶ public
column(string $name): array|nullGet column data in the table.
Parameters
-
string$name The column name.
Returns
array|nullcolumnType() ¶ public
columnType(string $name, string $type = null): string|nullSets the type of a column, or returns its current type if none is passed.
Parameters
-
string$name The column to get the type of.
-
string$type optional The type to set the column to.
Returns
string|nullconstraint() ¶ public
constraint(string $name): array|nullRead information about a constraint based on name.
Parameters
-
string$name The name of the constraint.
Returns
array|nullconstraints() ¶ public
constraints(): arrayGet the names of all the constraints in the table.
Returns
arraycreateSql() ¶ public
createSql(Connection $connection): arrayGenerate the SQL to create the Table.
Uses the connection to access the schema dialect to generate platform specific SQL.
Parameters
-
Connection$connection The connection to generate SQL for
Returns
arraydefaultValues() ¶ public
defaultValues(): arrayGet a hash of columns and their default values.
Returns
arraydropSql() ¶ public
dropSql(Connection $connection): arrayGenerate the SQL to drop a table.
Uses the connection to access the schema dialect to generate platform specific SQL.
Parameters
-
Connection$connection The connection to generate SQL for.
Returns
arrayhasAutoincrement() ¶ public
hasAutoincrement(): boolCheck whether or not a table has an autoIncrement column defined.
Returns
boolindex() ¶ public
index(string $name): array|nullRead information about an index based on name.
Parameters
-
string$name The name of the index.
Returns
array|nullisNullable() ¶ 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
booloptions() ¶ public
options(array|null $options = null): $this|arrayGet/set 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|null$options optional The options to set, or null to read options.
Returns
$this|arraytemporary() ¶ public
temporary(bool|null $set = null): $this|boolGet/Set whether the table is temporary in the database
Parameters
-
bool|null$set optional whether or not the table is to be temporary
Returns
$this|booltruncateSql() ¶ public
truncateSql(Connection $connection): arrayGenerate the SQL statements to truncate a table
Parameters
-
Connection$connection The connection to generate SQL for.
Returns
array