Interface TableSchemaInterface

An interface used by database TableSchema objects.

Namespace: Cake\Database\Schema

Constants

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

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.
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.
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, 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: The name of the column
array<string, mixed>|string $attrs: The attributes for the column or the type name.

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: The name of the constraint.
array<string, mixed>|string $attrs: The attributes for the constraint. If string it will be used as type.

Returns

$this

Throws

Cake\Database\Exception\DatabaseException

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: The name of the index.
array<string, mixed>|string $attrs: The attributes for the index. If string it will be used as type.

Returns

$this

Throws

Cake\Database\Exception\DatabaseException

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: The column name to get the base type from

Returns

string|null

The base type name

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>

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: Name of the constraint to remove

Returns

$this

getColumn() ¶ public

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

Get column data in the table.

Parameters

string $name: The column name.

Returns

array<string, mixed>|null

Column data or null.

getColumnType() ¶ public

getColumnType(string $name): string|null

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

Parameters

string $name: The column to get the type of.

Returns

string|null

getConstraint() ¶ public

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

Read information about a constraint based on name.

Parameters

string $name: The name of the constraint.

Returns

array<string, mixed>|null

Array of constraint data, or null

getIndex() ¶ public

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

Read information about an index based on name.

Parameters

string $name: The name of the index.

Returns

array<string, mixed>|null

Array of index data, or 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>

An array of options.

getPrimaryKey() ¶ public

getPrimaryKey(): array<string>

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

Returns

array<string>

Column name(s) for the primary key. An empty list will be returned when the table has no primary key.

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: Column 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: The column to get the type of.

Returns

bool

Whether the field is nullable.

isTemporary() ¶ public

isTemporary(): bool

Gets whether the table is temporary in the database.

Returns

bool

The current temporary setting.

name() ¶ public

name(): string

Get the name of the table.

Returns

string

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: The name of the column

Returns

$this

setColumnType() ¶ public

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

Sets 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

$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: The options to set, or null to read options.

Returns

$this

setTemporary() ¶ public

setTemporary(bool $temporary): $this

Sets whether the table is temporary in the database.

Parameters

bool $temporary: Whether the table is to be temporary.

Returns

$this

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>

Namespaces

Interface TableSchemaInterface

Constants

Method Summary

addColumn() public

addConstraint() public

addIndex() public

baseColumnType() public

columns() public

constraints() public

defaultValues() public

dropConstraint() 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

removeColumn() public

setColumnType() public

setOptions() public

setTemporary() public

typeMap() public

Method Detail

addColumn() ¶ public

Attributes

Parameters

Returns

addConstraint() ¶ public

Attributes

Parameters

Returns

Throws

addIndex() ¶ public

Attributes

Parameters

Returns

Throws

baseColumnType() ¶ public

Parameters

Returns

columns() ¶ public

Returns

constraints() ¶ public

Returns

defaultValues() ¶ public

Returns

dropConstraint() ¶ public

Parameters

Returns

getColumn() ¶ public

Parameters

Returns

getColumnType() ¶ public

Parameters

Returns

getConstraint() ¶ public

Parameters

Returns

getIndex() ¶ public

Parameters

Returns

getOptions() ¶ public

Returns

getPrimaryKey() ¶ public

Returns

hasAutoincrement() ¶ public

Returns

hasColumn() ¶ public

Parameters

Returns

indexes() ¶ public

Returns

isNullable() ¶ public