Class TableSchema

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'
• integer
  LENGTH_LONG ¶
  4294967295
• integer
  LENGTH_MEDIUM ¶
  16777215
• integer
  LENGTH_TINY ¶
  255

Inherited Constants

• TYPE_BIGINTEGER, TYPE_BINARY, TYPE_BINARY_UUID, TYPE_BOOLEAN, TYPE_DATE, TYPE_DATETIME, TYPE_DECIMAL, TYPE_FLOAT, TYPE_INTEGER, TYPE_JSON, TYPE_SMALLINTEGER, TYPE_STRING, TYPE_TEXT, TYPE_TIME, TYPE_TIMESTAMP, TYPE_TINYINTEGER, TYPE_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
  boolean
  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

• __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.

• column() public deprecated

  Get column data in the table.

• columnType() public deprecated

  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 deprecated

  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.

• 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.

• hasAutoincrement() public

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

• hasColumn() public

  Returns true if a column exists in the schema.

• index() public deprecated

  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

• isTemporary() public

  Gets whether the table is temporary in the database.

• name() public

  Get the name of the table.

• options() public deprecated

  Get/set the options for a 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.

• temporary() public deprecated

  Get/Set 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

Properties detail

[
    'string' => [
        'fixed' => null,
        'collate' => null,
    ],
    'text' => [
        'collate' => null,
    ],
    'tinyinteger' => [
        'unsigned' => null,
    ],
    'smallinteger' => [
        'unsigned' => null,
    ],
    'integer' => [
        'unsigned' => null,
        'autoIncrement' => null,
    ],
    'biginteger' => [
        'unsigned' => null,
        'autoIncrement' => null,
    ],
    'decimal' => [
        'unsigned' => null,
    ],
    'float' => [
        'unsigned' => null,
    ],
]

[
    'type' => null,
    'baseType' => null,
    'length' => null,
    'precision' => null,
    'null' => null,
    'default' => null,
    'comment' => null,
]

[]

[]

[
    'type' => null,
    'columns' => [],
    'length' => [],
    'references' => [],
    'update' => 'restrict',
    'delete' => 'restrict',
]

[]

[]

false

[]

[
    self::CONSTRAINT_PRIMARY,
    self::CONSTRAINT_UNIQUE,
    self::CONSTRAINT_FOREIGN,
]

[
    self::ACTION_CASCADE,
    self::ACTION_SET_NULL,
    self::ACTION_SET_DEFAULT,
    self::ACTION_NO_ACTION,
    self::ACTION_RESTRICT,
]

[
    self::INDEX_INDEX,
    self::INDEX_FULLTEXT,
]

[
    'tiny' => self::LENGTH_TINY,
    'medium' => self::LENGTH_MEDIUM,
    'long' => self::LENGTH_LONG
]