Interface Yiisoft\Db\QueryBuilder\ColumnDefinitionBuilderInterface
| Implemented by | Yiisoft\Db\QueryBuilder\AbstractColumnDefinitionBuilder |
|---|
Public Methods
| Method | Description | Defined By |
|---|---|---|
| build() | Builds column definition based on given column instance. | Yiisoft\Db\QueryBuilder\ColumnDefinitionBuilderInterface |
| buildAlter() | Builds column definition for ALTER operation based on given column instance. |
Yiisoft\Db\QueryBuilder\ColumnDefinitionBuilderInterface |
| buildType() | Builds the type definition for the column. For example: varchar(128) or decimal(10,2). |
Yiisoft\Db\QueryBuilder\ColumnDefinitionBuilderInterface |
Method Details
Builds column definition based on given column instance.
| public abstract string build ( Yiisoft\Db\Schema\Column\ColumnInterface $column ) | ||
| $column | Yiisoft\Db\Schema\Column\ColumnInterface |
The column instance which should be converted into a string representation. |
| return | string |
The column SQL definition. |
|---|---|---|
| throws | Yiisoft\Db\Exception\NotSupportedException |
If the column definition cannot be built for the specific DBMS. |
public function build(ColumnInterface $column): string;
Builds column definition for ALTER operation based on given column instance.
| public abstract string buildAlter ( Yiisoft\Db\Schema\Column\ColumnInterface $column ) | ||
| $column | Yiisoft\Db\Schema\Column\ColumnInterface | |
public function buildAlter(ColumnInterface $column): string;
Builds the type definition for the column. For example: varchar(128) or decimal(10,2).
| public abstract string buildType ( Yiisoft\Db\Schema\Column\ColumnInterface $column ) | ||
| $column | Yiisoft\Db\Schema\Column\ColumnInterface | |
| return | string |
A string containing the column type definition. |
|---|---|---|
public function buildType(ColumnInterface $column): string;
Signup or Login in order to comment.