Trait yii\db\SchemaBuilderTrait

Все классы | Методы

Реализовано в	yii\db\Migration
Доступно с версии	2.0.6
Исходный код	https://github.com/yiisoft/yii2/blob/master/framework/db/SchemaBuilderTrait.php

Trait SchemaBuilderTrait содержит методы-короткоходы для создания экземпляров yii\db\ColumnSchemaBuilder.

Эти методы можно использовать в миграциях баз данных для определения типов схем баз данных с помощью PHP-интерфейса. Это полезно для определения схемы независимо от СУБД, чтобы приложение работало одинаково на разных СУБД.

Например, вы можете использовать следующий код в файлах миграций:

$this->createTable('example_table', [
  'id' => $this->primaryKey(),
  'name' => $this->string(64)->notNull(),
  'type' => $this->integer()->notNull()->defaultValue(10),
  'description' => $this->text(),
  'rule_name' => $this->string(64),
  'data' => $this->text(),
  'created_at' => $this->datetime()->notNull(),
  'updated_at' => $this->datetime(),
]);

Публичные методы

Метод	Описание	Определено в
bigInteger()	Создаёт столбец типа bigint.	yii\db\SchemaBuilderTrait
bigPrimaryKey()	Создаёт столбец типа big primary key.	yii\db\SchemaBuilderTrait
binary()	Создаёт столбец типа binary.	yii\db\SchemaBuilderTrait
boolean()	Создаёт столбец типа boolean.	yii\db\SchemaBuilderTrait
char()	Создаёт столбец типа char.	yii\db\SchemaBuilderTrait
date()	Создаёт столбец типа date.	yii\db\SchemaBuilderTrait
dateTime()	Создаёт столбец типа datetime.	yii\db\SchemaBuilderTrait
decimal()	Создаёт столбец типа decimal.	yii\db\SchemaBuilderTrait
double()	Создаёт столбец типа double.	yii\db\SchemaBuilderTrait
float()	Создаёт столбец типа float.	yii\db\SchemaBuilderTrait
integer()	Создаёт столбец типа integer.	yii\db\SchemaBuilderTrait
money()	Создаёт столбец типа money.	yii\db\SchemaBuilderTrait
primaryKey()	Создаёт столбец типа primary key.	yii\db\SchemaBuilderTrait
smallInteger()	Создаёт столбец типа smallint.	yii\db\SchemaBuilderTrait
string()	Создаёт столбец типа string.	yii\db\SchemaBuilderTrait
text()	Создаёт столбец типа text.	yii\db\SchemaBuilderTrait
time()	Создаёт столбец типа time.	yii\db\SchemaBuilderTrait
timestamp()	Создаёт столбец типа timestamp.	yii\db\SchemaBuilderTrait

Защищённые методы

Метод	Описание	Определено в
getDb()		yii\db\SchemaBuilderTrait

Подробное описание методов

bigInteger() public method (available since version 2.0.6)

Создаёт столбец bigint.

public yii\db\ColumnSchemaBuilder bigInteger ( $length = null )
$length	integer	Определение размера или точности столбца. Этот параметр будет проигнорирован, если он не поддерживается СУБД.
return	yii\db\ColumnSchemaBuilder	Экземпляр столбца, который можно дополнительно настроить.

bigPrimaryKey() public method (available since version 2.0.6)

Создаёт столбец большого первичного ключа.

public yii\db\ColumnSchemaBuilder bigPrimaryKey ( $length = null )
$length	integer	Определение размера или точности столбца. Этот параметр будет проигнорирован, если он не поддерживается СУБД.
return	yii\db\ColumnSchemaBuilder	Экземпляр столбца, который можно дополнительно настроить.

binary() public method (available since version 2.0.6)

Создаёт столбец типа binary.

public yii\db\ColumnSchemaBuilder binary ( $length = null )
$length	integer	Определение размера или точности столбца. Этот параметр будет проигнорирован, если он не поддерживается СУБД.
return	yii\db\ColumnSchemaBuilder	Экземпляр столбца, который можно дополнительно настроить.

boolean() public method (available since version 2.0.6)

Создаёт столбец boolean.

public yii\db\ColumnSchemaBuilder boolean ( )
return	yii\db\ColumnSchemaBuilder	Экземпляр столбца, который можно дополнительно настроить.

char() public method (available since version 2.0.8)

Создаёт столбец char.

public yii\db\ColumnSchemaBuilder char ( $length = null )
$length	integer	Определение размера столбца, то есть максимальной длины строки. Этот параметр будет проигнорирован, если он не поддерживается СУБД.
return	yii\db\ColumnSchemaBuilder	Экземпляр столбца, который можно дополнительно настроить.

date() public method (available since version 2.0.6)

Создаёт столбец date.

public yii\db\ColumnSchemaBuilder date ( )
return	yii\db\ColumnSchemaBuilder	Экземпляр столбца, который можно дополнительно настроить.

dateTime() public method (available since version 2.0.6)

Создаёт столбец datetime.

public yii\db\ColumnSchemaBuilder dateTime ( $precision = null )
$precision	integer	Точность значения столбца. Первый параметр, передаваемый в тип столбца, например, DATETIME(точность). Этот параметр будет проигнорирован, если он не поддерживается СУБД.
return	yii\db\ColumnSchemaBuilder	Экземпляр столбца, который можно дополнительно настроить.

decimal() public method (available since version 2.0.6)

Создаёт столбец decimal.

public yii\db\ColumnSchemaBuilder decimal ( $precision = null, $scale = null )
$precision	integer	Точность значения столбца, которая обычно является общим количеством цифр. Первый параметр, передаваемый в тип столбца, например, DECIMAL(точность, масштаб). Этот параметр будет проигнорирован, если он не поддерживается СУБД.
$scale	integer	Масштаб значения столбца, который обычно является количеством цифр после десятичной точки. Второй параметр, передаваемый в тип столбца, например, DECIMAL(точность, масштаб). Этот параметр будет проигнорирован, если он не поддерживается СУБД.
return	yii\db\ColumnSchemaBuilder	Экземпляр столбца, который можно дополнительно настроить.

double() public method (available since version 2.0.6)

Создаёт столбец double.

public yii\db\ColumnSchemaBuilder double ( $precision = null )
$precision	integer	Точность значения столбца. Первый параметр, передаваемый в тип столбца, например, DOUBLE(точность). Этот параметр будет проигнорирован, если он не поддерживается СУБД.
return	yii\db\ColumnSchemaBuilder	Экземпляр столбца, который можно дополнительно настроить.

float() public method (available since version 2.0.6)

Создаёт столбец float.

public yii\db\ColumnSchemaBuilder float ( $precision = null )
$precision	integer	Точность значения столбца. Первый параметр, передаваемый в тип столбца, например, FLOAT(точность). Этот параметр будет проигнорирован, если он не поддерживается СУБД.
return	yii\db\ColumnSchemaBuilder	Экземпляр столбца, который можно дополнительно настроить.

getDb() protected abstract method

protected abstract yii\db\Connection getDb ( )
return	yii\db\Connection	Подключение к базе данных, используемое для построения схемы.

integer() public method (available since version 2.0.6)

Создаёт столбец integer.

public yii\db\ColumnSchemaBuilder integer ( $length = null )
$length	integer	Определение размера или точности столбца. Этот параметр будет проигнорирован, если он не поддерживается СУБД.
return	yii\db\ColumnSchemaBuilder	Экземпляр столбца, который можно дополнительно настроить.

money() public method (available since version 2.0.6)

Создаёт столбец money.

public yii\db\ColumnSchemaBuilder money ( $precision = null, $scale = null )
$precision	integer	Точность значения столбца, которая обычно является общим количеством цифр. Первый параметр, передаваемый в тип столбца, например, DECIMAL(точность, масштаб). Этот параметр будет проигнорирован, если он не поддерживается СУБД.
$scale	integer	Масштаб значения столбца, который обычно является количеством цифр после десятичной точки. Второй параметр, передаваемый в тип столбца, например, DECIMAL(точность, масштаб). Этот параметр будет проигнорирован, если он не поддерживается СУБД.
return	yii\db\ColumnSchemaBuilder	Экземпляр столбца, который можно дополнительно настроить.

primaryKey() public method (available since version 2.0.6)

Создаёт столбец первичного ключа.

public yii\db\ColumnSchemaBuilder primaryKey ( $length = null )
$length	integer	Определение размера или точности столбца. Этот параметр будет проигнорирован, если он не поддерживается СУБД.
return	yii\db\ColumnSchemaBuilder	Экземпляр столбца, который можно дополнительно настроить.

smallInteger() public method (available since version 2.0.6)

Создаёт столбец smallint.

public yii\db\ColumnSchemaBuilder smallInteger ( $length = null )
$length	целое число	Определение размера или точности столбца. Этот параметр будет проигнорирован, если не поддерживается СУБД.
return	yii\db\ColumnSchemaBuilder	Экземпляр столбца, который можно дополнительно настроить.

string() общедоступный метод (доступен с версии 2.0.6)

Создаёт столбец строкового типа.

public yii\db\ColumnSchemaBuilder string ( $length = null )
$length	целое число	Определение размера столбца, т.е. максимальная длина строки. Этот параметр будет проигнорирован, если не поддерживается СУБД.
return	yii\db\ColumnSchemaBuilder	Экземпляр столбца, который можно дополнительно настроить.

text() общедоступный метод (доступен с версии 2.0.6)

Создаёт столбец типа текст.

public yii\db\ColumnSchemaBuilder text ( )
return	yii\db\ColumnSchemaBuilder	Экземпляр столбца, который можно дополнительно настроить.

time() общедоступный метод (доступен с версии 2.0.6)

Создаёт столбец типа время.

public yii\db\ColumnSchemaBuilder time ( $precision = null )
$precision	целое число	Точность значения столбца. Первый параметр, передаваемый в тип столбца, например, TIME(точность). Этот параметр будет проигнорирован, если не поддерживается СУБД.
return	yii\db\ColumnSchemaBuilder	Экземпляр столбца, который можно дополнительно настроить.

timestamp() общедоступный метод (доступен с версии 2.0.6)

Создаёт столбец типа метка времени.

public yii\db\ColumnSchemaBuilder timestamp ( $precision = null )
$precision	целое число	Точность значения столбца. Первый параметр, передаваемый в тип столбца, например, TIMESTAMP(точность). Этот параметр будет проигнорирован, если не поддерживается СУБД.
return	yii\db\ColumnSchemaBuilder	Экземпляр столбца, который можно дополнительно настроить.

© 2008–2017 by Yii Software LLC
Licensed under the three clause BSD license.
http://www.yiiframework.com/doc-2.0/yii-db-schemabuildertrait.html