W3cubDocs

/CakePHP 4.1

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 summary

  • string
    ACTION_CASCADE
    'cascade'
  • string
    ACTION_NO_ACTION
    'noAction'
  • string
    ACTION_RESTRICT
    'restrict'
  • string
    ACTION_SET_DEFAULT
    'setDefault'
  • string
    ACTION_SET_NULL
    'setNull'
  • string
    CONSTRAINT_FOREIGN
    'foreign'
  • string
    CONSTRAINT_PRIMARY
    'primary'
  • string
    CONSTRAINT_UNIQUE
    'unique'
  • string
    INDEX_FULLTEXT
    'fulltext'
  • string
    INDEX_INDEX
    'index'
  • int
    LENGTH_LONG
    4294967295
  • int
    LENGTH_MEDIUM
    16777215
  • int
    LENGTH_TINY
    255
  • string
    TYPE_BIGINTEGER
    'biginteger'
  • string
    TYPE_BINARY
    'binary'
  • string
    TYPE_BINARY_UUID
    'binaryuuid'
  • string
    TYPE_BOOLEAN
    'boolean'
  • string
    TYPE_CHAR
    'char'
  • string
    TYPE_DATE
    'date'
  • string
    TYPE_DATETIME
    'datetime'
  • string
    TYPE_DATETIME_FRACTIONAL
    'datetimefractional'
  • string
    TYPE_DECIMAL
    'decimal'
  • string
    TYPE_FLOAT
    'float'
  • string
    TYPE_INTEGER
    'integer'
  • string
    TYPE_JSON
    'json'
  • string
    TYPE_SMALLINTEGER
    'smallinteger'
  • string
    TYPE_STRING
    'string'
  • string
    TYPE_TEXT
    'text'
  • string
    TYPE_TIME
    'time'
  • string
    TYPE_TIMESTAMP
    'timestamp'
  • string
    TYPE_TIMESTAMP_FRACTIONAL
    'timestampfractional'
  • string
    TYPE_TIMESTAMP_TIMEZONE
    'timestamptimezone'
  • string
    TYPE_TINYINTEGER
    'tinyinteger'
  • string
    TYPE_UUID
    'uuid'

Properties summary

  • $_columnExtras protected static
    array

    Additional type specific properties.

  • $_columnKeys protected static
    array

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

  • $_columns protected
    array

    Columns in the table.

  • $_constraints protected
    array

    Constraints in the table.

  • $_indexKeys protected static
    array

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

  • $_indexes protected
    array

    Indexes in the table.

  • $_options protected
    array

    Options for the table.

  • $_table protected
    string

    The name of the table

  • $_temporary protected
    bool

    Whether or not the table is temporary

  • $_typeMap protected
    array

    A map with columns to types

  • $_validConstraintTypes protected static
    array

    Names of the valid constraint types.

  • $_validForeignKeyActions protected static
    array

    Names of the valid foreign key actions.

  • $_validIndexTypes protected static
    array

    Names of the valid index types.

  • $columnLengths public static
    array

    Valid column length that can be used with text type columns

Method Summary

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.

__debugInfo() public 

__debugInfo()

Returns an array of the table schema.

Returns

array

_checkForeignKey() protected 

_checkForeignKey(array $attrs)

Helper method to check/validate foreign keys.

Parameters

array $attrs

Attributes to set.

Returns

array

Throws

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

addColumn() public 

addColumn(string $name, mixed $attrs)

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 or not the column can hold nulls.
  • fixed Whether or not the column is a fixed length column. This is only present/valid with string columns.
  • unsigned Whether 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:

  • comment The comment for the column.

Parameters

string $name

The name of the column

string|array $attrs

The attributes for the column or the type name.

Returns

$this

addConstraint() public 

addConstraint(string $name, mixed $attrs)

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 $attrs

The attributes for the constraint. If string it will be used as type.

Returns

$this

Throws

Cake\Database\Exception

addConstraintSql() public 

addConstraintSql(\Cake\Database\Connection $connection)

Generate the SQL statements to add the constraints to the table

Parameters

\Cake\Database\Connection $connection

The connection to generate SQL for.

Returns

array

SQL to add the constraints.

addIndex() public 

addIndex(string $name, mixed $attrs)

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 $attrs

The attributes for the index. If string it will be used as type.

Returns

$this

Throws

Cake\Database\Exception

baseColumnType() public 

baseColumnType(string $column)

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

Get the column names in the table.

Returns

string[]

constraints() public 

constraints()

Get the names of all the constraints in the table.

Returns

string[]

createSql() public 

createSql(\Cake\Database\Connection $connection)

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

The connection to generate SQL for.

Returns

array

List of SQL statements to create the table and the required indexes.

defaultValues() public 

defaultValues()

Get a hash of columns and their default values.

Returns

array

dropConstraint() public 

dropConstraint(string $name)

Remove a constraint.

Parameters

string $name

Name of the constraint to remove

Returns

$this

dropConstraintSql() public 

dropConstraintSql(\Cake\Database\Connection $connection)

Generate the SQL statements to drop the constraints to the table

Parameters

\Cake\Database\Connection $connection

The connection to generate SQL for.

Returns

array

SQL to drop a table.

dropSql() public 

dropSql(\Cake\Database\Connection $connection)

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

The connection to generate SQL for.

Returns

array

SQL to drop a table.

getColumn() public 

getColumn(string $name)

Get column data in the table.

Parameters

string $name

The column name.

Returns

array|null

Column data or null.

getColumnType() public 

getColumnType(string $name)

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)

Read information about a constraint based on name.

Parameters

string $name

The name of the constraint.

Returns

array|null

Array of constraint data, or null

getIndex() public 

getIndex(string $name)

Read information about an index based on name.

Parameters

string $name

The name of the index.

Returns

array|null

Array of index data, or null

getOptions() public 

getOptions()

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

An array of options.

getPrimaryKey() public 

getPrimaryKey()

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

Returns

array

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

hasAutoincrement() public 

hasAutoincrement()

Check whether or not a table has an autoIncrement column defined.

Returns

bool

hasColumn() public 

hasColumn(string $name)

Returns true if a column exists in the schema.

Parameters

string $name

Column name.

Returns

bool

indexes() public 

indexes()

Get the names of all the indexes in the table.

Returns

string[]

isNullable() public 

isNullable(string $name)

Check whether or not a field is nullable

Missing columns are nullable.

Parameters

string $name

The column to get the type of.

Returns

bool

Whether or not the field is nullable.

isTemporary() public 

isTemporary()

Gets whether the table is temporary in the database.

Returns

bool

The current temporary setting.

name() public 

name()

Get the name of the table.

Returns

string

primaryKey() public 

primaryKey()

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

Returns

array

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

removeColumn() public 

removeColumn(string $name)

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)

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 $options)

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 $options

The options to set, or null to read options.

Returns

$this

setTemporary() public 

setTemporary(bool $temporary)

Sets whether the table is temporary in the database.

Parameters

bool $temporary

Whether or not the table is to be temporary.

Returns

$this

truncateSql() public 

truncateSql(\Cake\Database\Connection $connection)

Generate the SQL statements to truncate a table

Parameters

\Cake\Database\Connection $connection

The connection to generate SQL for.

Returns

array

SQL to truncate a table.

typeMap() public 

typeMap()

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

Returns

array

Property Detail

$_columnExtras protected static

Additional type specific properties.

Type

array

$_columnKeys protected static

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

Type

array

$_columns protected

Columns in the table.

Type

array

$_constraints protected

Constraints in the table.

Type

array

$_indexKeys protected static

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

Type

array

$_indexes protected

Indexes in the table.

Type

array

$_options protected

Options for the table.

Type

array

$_table protected

The name of the table

Type

string

$_temporary protected

Whether or not the table is temporary

Type

bool

$_typeMap protected

A map with columns to types

Type

array

$_validConstraintTypes protected static

Names of the valid constraint types.

Type

array

$_validForeignKeyActions protected static

Names of the valid foreign key actions.

Type

array

$_validIndexTypes protected static

Names of the valid index types.

Type

array

$columnLengths public static

Valid column length that can be used with text type columns

Type

array

© 2005–present The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
https://api.cakephp.org/4.1/class-Cake.Database.Schema.TableSchema.html