Class TableSchema

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 TableSchema instances can be added to Schema\Collection objects. They can also be converted into SQL using the createSql(), dropSql() and truncateSql() methods.

Namespace: Cake\Database\Schema

Constants

string

ACTION_CASCADE ¶
```
'cascade'
```
Foreign key cascade action
string

ACTION_NO_ACTION ¶
```
'noAction'
```
Foreign key no action
string

ACTION_RESTRICT ¶
```
'restrict'
```
Foreign key restrict action
string

ACTION_SET_DEFAULT ¶
```
'setDefault'
```
Foreign key restrict default
string

ACTION_SET_NULL ¶
```
'setNull'
```
Foreign key set null action
string

CONSTRAINT_FOREIGN ¶
```
'foreign'
```
Foreign constraint type
string

CONSTRAINT_PRIMARY ¶
```
'primary'
```
Primary constraint type
string

CONSTRAINT_UNIQUE ¶
```
'unique'
```
Unique constraint type
string

INDEX_FULLTEXT ¶
```
'fulltext'
```
Fulltext index type
string

INDEX_INDEX ¶
```
'index'
```
Index - index type
int

LENGTH_LONG ¶
```
4294967295
```
Column length when using a long column type
int

LENGTH_MEDIUM ¶
```
16777215
```
Column length when using a medium column type
int

LENGTH_TINY ¶
```
255
```
Column length when using a tiny column type
string

TYPE_BIGINTEGER ¶
```
'biginteger'
```
Big Integer column type
string

TYPE_BINARY ¶
```
'binary'
```
Binary column type
string

TYPE_BINARY_UUID ¶
```
'binaryuuid'
```
Binary UUID column type
string

TYPE_BOOLEAN ¶
```
'boolean'
```
Boolean column type
string

TYPE_CHAR ¶
```
'char'
```
Char column type
string

TYPE_DATE ¶
```
'date'
```
Date column type
string

TYPE_DATETIME ¶
```
'datetime'
```
Datetime column type
string

TYPE_DATETIME_FRACTIONAL ¶
```
'datetimefractional'
```
Datetime with fractional seconds column type
string

TYPE_DECIMAL ¶
```
'decimal'
```
Decimal column type
string

TYPE_FLOAT ¶
```
'float'
```
Float column type
string

TYPE_INTEGER ¶
```
'integer'
```
Integer column type
string

TYPE_JSON ¶
```
'json'
```
JSON column type
string

TYPE_SMALLINTEGER ¶
```
'smallinteger'
```
Small Integer column type
string

TYPE_STRING ¶
```
'string'
```
String column type
string

TYPE_TEXT ¶
```
'text'
```
Text column type
string

TYPE_TIME ¶
```
'time'
```
Time column type
string

TYPE_TIMESTAMP ¶
```
'timestamp'
```
Timestamp column type
string

TYPE_TIMESTAMP_FRACTIONAL ¶
```
'timestampfractional'
```
Timestamp with fractional seconds column type
string

TYPE_TIMESTAMP_TIMEZONE ¶
```
'timestamptimezone'
```
Timestamp with time zone column type
string

TYPE_TINYINTEGER ¶
```
'tinyinteger'
```
Tiny Integer column type
string

TYPE_UUID ¶
```
'uuid'
```
UUID column type

Property Summary

$_columnExtras protected static

array<string, array<string, mixed>>

Additional type specific properties.
$_columnKeys protected static

array<string, mixed>

The valid keys that can be used in a column definition.
$_columns protected

array<string, array>

Columns in the table.
$_constraints protected

array<string, array<string, mixed>>

Constraints in the table.
$_indexKeys protected static

array<string, mixed>

The valid keys that can be used in an index definition.
$_indexes protected

array<string, array>

Indexes in the table.
$_options protected

array

Options for the table.
$_table protected

string

The name of the table
$_temporary protected

bool

Whether the table is temporary
$_typeMap protected

array<string, string>

A map with columns to types
$_validConstraintTypes protected static

array<string>

Names of the valid constraint types.
$_validForeignKeyActions protected static

array<string>

Names of the valid foreign key actions.
$_validIndexTypes protected static

array<string>

Names of the valid index types.
$columnLengths public static

array<string, int>

Valid column length that can be used with text type columns

Method Summary

__construct() public

Constructor.
__debugInfo() public

Returns an array of the table schema.
_checkForeignKey() protected

Helper method to check/validate foreign keys.
addColumn() public

Add a column to the table.
addConstraint() public

Add a constraint.
addConstraintSql() public

Generate the SQL statements to add the constraints to the table
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.
createSql() public

Generate the SQL to create the Table.
defaultValues() public

Get a hash of columns and their default values.
dropConstraint() public

Remove a constraint.
dropConstraintSql() public

Generate the SQL statements to drop the constraints to the table
dropSql() public

Generate the SQL to drop a table.
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.
getPrimaryKey() public

Get the column(s) used for the primary key.
hasAutoincrement() public

Check whether 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 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 deprecated

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.
truncateSql() public

Generate the SQL statements to truncate a table
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

__construct() ¶ public

__construct(string $table, array<string, array|string> $columns = [])

Constructor.

Parameters

string $table: The table name.
array<string, array|string> $columns optional: The list of columns for the schema.

__debugInfo() ¶ public

__debugInfo(): array<string, mixed>

Returns an array of the table schema.

Returns

array<string, mixed>

_checkForeignKey() ¶ protected

_checkForeignKey(array<string, mixed> $attrs): array<string, mixed>

Helper method to check/validate foreign keys.

Parameters

array<string, mixed> $attrs: Attributes to set.

Returns

array<string, mixed>

Throws

Cake\Database\Exception\DatabaseException
When foreign key definition is not valid.

addColumn() ¶ public

addColumn(string $name, array<string, mixed>|string $attrs): $this

Add a column to the table.

Attributes

Columns can have several attributes:

type The type of the column. This should be one of CakePHP's abstract types.
length The length of the column.
precision The number of decimal places to store for float and decimal types.
default The default value of the column.
null Whether the column can hold nulls.
fixed Whether the column is a fixed length column. This is only present/valid with string columns.
unsigned Whether 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:

comment The comment for the column.

Parameters

string $name
array<string, mixed>|string $attrs

Returns

$this

addConstraint() ¶ public

addConstraint(string $name, array<string, mixed>|string $attrs): $this

Add a constraint.

Used to add constraints to a table. For example primary keys, unique keys and foreign keys.

Attributes

type The type of constraint being added.
columns The columns in the index.
references The table, column a foreign key references.
update The behavior on update. Options are 'restrict', 'setNull', 'cascade', 'noAction'.
delete The behavior on delete. Options are 'restrict', 'setNull', 'cascade', 'noAction'.

The default for 'update' & 'delete' is 'cascade'.

Parameters

string $name
array<string, mixed>|string $attrs

Returns

$this

addConstraintSql() ¶ public

addConstraintSql(Cake\Database\Connection $connection): array

Generate the SQL statements to add the constraints to the table

Parameters

Cake\Database\Connection $connection

Returns

array

addIndex() ¶ public

addIndex(string $name, array<string, mixed>|string $attrs): $this

Add an index.

Used to add indexes, and full text indexes in platforms that support them.

Attributes

type The type of index being added.
columns The columns in the index.

Parameters

string $name
array<string, mixed>|string $attrs

Returns

$this

baseColumnType() ¶ public

baseColumnType(string $column): string|null

Returns the base type name for the provided column. This represent the database type a more complex class is based upon.

Parameters

string $column

Returns

string|null

columns() ¶ public

columns(): array<string>

Get the column names in the table.

Returns

array<string>

constraints() ¶ public

constraints(): array<string>

Get the names of all the constraints in the table.

Returns

array<string>

createSql() ¶ public

createSql(Cake\Database\Connection $connection): array

Generate the SQL to create the Table.

Uses the connection to access the schema dialect to generate platform specific SQL.

Parameters

Cake\Database\Connection $connection

Returns

array

defaultValues() ¶ public

defaultValues(): array<string, mixed>

Get a hash of columns and their default values.

Returns

array<string, mixed>

dropConstraint() ¶ public

dropConstraint(string $name): $this

Remove a constraint.

Parameters

string $name

Returns

$this

dropConstraintSql() ¶ public

dropConstraintSql(Cake\Database\Connection $connection): array

Generate the SQL statements to drop the constraints to the table

Parameters

Cake\Database\Connection $connection

Returns

array

dropSql() ¶ public

dropSql(Cake\Database\Connection $connection): array

Generate the SQL to drop a table.

Uses the connection to access the schema dialect to generate platform specific SQL.

Parameters

Cake\Database\Connection $connection

Returns

array

getColumn() ¶ public

getColumn(string $name): array<string, mixed>|null

Get column data in the table.

Parameters

string $name

Returns

array<string, mixed>|null

getColumnType() ¶ public

getColumnType(string $name): string|null

Returns column type or null if a column does not exist.

Parameters

string $name

Returns

string|null

getConstraint() ¶ public

getConstraint(string $name): array<string, mixed>|null

Read information about a constraint based on name.

Parameters

string $name

Returns

array<string, mixed>|null

getIndex() ¶ public

getIndex(string $name): array<string, mixed>|null

Read information about an index based on name.

Parameters

string $name

Returns

array<string, mixed>|null

getOptions() ¶ public

getOptions(): array<string, mixed>

Gets the options for a table.

Table options allow you to set platform specific table level options. For example the engine type in MySQL.

Returns

array<string, mixed>

getPrimaryKey() ¶ public

getPrimaryKey(): array<string>

Get the column(s) used for the primary key.

Returns

array<string>

hasAutoincrement() ¶ public

hasAutoincrement(): bool

Check whether a table has an autoIncrement column defined.

Returns

bool

hasColumn() ¶ public

hasColumn(string $name): bool

Returns true if a column exists in the schema.

Parameters

string $name

Returns

bool

indexes() ¶ public

indexes(): array<string>

Get the names of all the indexes in the table.

Returns

array<string>

isNullable() ¶ public

isNullable(string $name): bool

Check whether a field is nullable

Missing columns are nullable.

Parameters

string $name

Returns

bool

isTemporary() ¶ public

isTemporary(): bool

Gets whether the table is temporary in the database.

Returns

bool

name() ¶ public

name(): string

Get the name of the table.

Returns

string

primaryKey() ¶ public

primaryKey(): array

Get the column(s) used for the primary key.

Returns

array

removeColumn() ¶ public

removeColumn(string $name): $this

Remove a column from the table schema.

If the column is not defined in the table, no error will be raised.

Parameters

string $name

Returns

$this

setColumnType() ¶ public

setColumnType(string $name, string $type): $this

Sets the type of a column.

Parameters

string $name
string $type

Returns

$this

setOptions() ¶ public

setOptions(array<string, mixed> $options): $this

Sets 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<string, mixed> $options

Returns

$this

setTemporary() ¶ public

setTemporary(bool $temporary): $this

Sets whether the table is temporary in the database.

Parameters

bool $temporary

Returns

$this

truncateSql() ¶ public

truncateSql(Cake\Database\Connection $connection): array

Generate the SQL statements to truncate a table

Parameters

Cake\Database\Connection $connection

Returns

array

typeMap() ¶ public

typeMap(): array<string, string>

Returns an array where the keys are the column names in the schema and the values the database type they have.

Returns

array<string, string>

Property Detail

`$_columnExtras` ¶ protected static

Additional type specific properties.

Type

array<string, array<string, mixed>>

`$_columnKeys` ¶ protected static

The valid keys that can be used in a column definition.

Type

array<string, mixed>

`$_columns` ¶ protected

Columns in the table.

Type

array<string, array>

`$_constraints` ¶ protected

Constraints in the table.

Type

array<string, array<string, mixed>>

`$_indexKeys` ¶ protected static

The valid keys that can be used in an index definition.

Type

array<string, mixed>

`$_indexes` ¶ protected

Indexes in the table.

Type

array<string, array>

`$_options` ¶ protected

Options for the table.

Type

array

`$_table` ¶ protected

The name of the table

Type

string

`$_temporary` ¶ protected

Whether the table is temporary

Type

bool

`$_typeMap` ¶ protected

A map with columns to types

Type

array<string, string>

`$_validConstraintTypes` ¶ protected static

Names of the valid constraint types.

Type

array<string>

`$_validForeignKeyActions` ¶ protected static

Names of the valid foreign key actions.

Type

array<string>

`$_validIndexTypes` ¶ protected static

Names of the valid index types.

Type

array<string>

`$columnLengths` ¶ public static

Valid column length that can be used with text type columns

Type

array<string, int>

Namespaces

Class TableSchema

Constants

Property Summary

Method Summary

__construct() public

__debugInfo() public

_checkForeignKey() protected

addColumn() public

addConstraint() public

addConstraintSql() public

addIndex() public

baseColumnType() public

columns() public

constraints() public

createSql() public

defaultValues() public

dropConstraint() public

dropConstraintSql() public

dropSql() public

getColumn() public

getColumnType() public

getConstraint() public

getIndex() public

getOptions() public

getPrimaryKey() public

hasAutoincrement() public

hasColumn() public

indexes() public

isNullable() public

isTemporary() public

name() public

primaryKey() public deprecated

removeColumn() public

setColumnType() public

setOptions() public

setTemporary() public

truncateSql() public

typeMap() public

Method Detail

__construct() ¶ public

Parameters

__debugInfo() ¶ public

Returns

_checkForeignKey() ¶ protected

Parameters

Returns

Throws

addColumn() ¶ public

Attributes

Parameters

Returns

addConstraint() ¶ public

Attributes

Parameters

Returns

addConstraintSql() ¶ public

Parameters

Returns

addIndex() ¶ public

Attributes

Parameters

Returns

baseColumnType() ¶ public

Parameters

Returns

columns() ¶ public

Returns

constraints() ¶ public

Returns

createSql() ¶ public

Parameters

Returns

defaultValues() ¶ public

Returns

dropConstraint() ¶ public

Parameters

Returns

dropConstraintSql() ¶ public

Parameters

`$_columnExtras` ¶ protected static

`$_columnKeys` ¶ protected static

`$_columns` ¶ protected

`$_constraints` ¶ protected

`$_indexKeys` ¶ protected static

`$_indexes` ¶ protected