1 關注者

Trait yii\db\SchemaBuilderTrait

實作於	yii\db\Migration
自版本起可用	2.0.6
原始碼	https://github.com/yiisoft/yii2/blob/master/framework/db/SchemaBuilderTrait.php

SchemaBuilderTrait 包含建立 yii\db\ColumnSchemaBuilder 實例的快捷方法。

這些方法可用於資料庫遷移中，以使用 PHP 介面定義資料庫結構描述類型。這對於以 DBMS 獨立的方式定義結構描述非常有用，以便應用程式可以在不同的 DBMS 上以相同的方式運行。

例如，您可以在遷移檔案內使用以下程式碼

$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
json()	建立一個 JSON 欄位。	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
tinyInteger()	建立一個 tinyint 欄位。如果 DBMS 不支援 tinyint，將會使用 smallint。	yii\db\SchemaBuilderTrait

受保護的方法

隱藏繼承的方法

方法	描述	定義於
getDb()		yii\db\SchemaBuilderTrait

方法詳情

隱藏繼承的方法

bigInteger() public 方法 (自版本 2.0.6 起可用)

建立一個 bigint 欄位。

public yii\db\ColumnSchemaBuilder bigInteger ( $length = null )
$length	integer\|null	欄位大小或精確度定義。如果 DBMS 不支援此參數，將會被忽略。
回傳	yii\db\ColumnSchemaBuilder	可以進一步自訂的欄位實例。

原始碼

                public function bigInteger($length = null)
{
    return $this->getDb()->getSchema()->createColumnSchemaBuilder(Schema::TYPE_BIGINT, $length);
}

bigPrimaryKey() public 方法 (自版本 2.0.6 起可用)

建立一個 big primary key 欄位。

public yii\db\ColumnSchemaBuilder bigPrimaryKey ( $length = null )
$length	integer\|null	欄位大小或精確度定義。如果 DBMS 不支援此參數，將會被忽略。
回傳	yii\db\ColumnSchemaBuilder	可以進一步自訂的欄位實例。

原始碼

                public function bigPrimaryKey($length = null)
{
    return $this->getDb()->getSchema()->createColumnSchemaBuilder(Schema::TYPE_BIGPK, $length);
}

建立一個 binary 欄位。

public
$length	integer\|null	欄位大小或精確度定義。如果 DBMS 不支援此參數，將會被忽略。
回傳	yii\db\ColumnSchemaBuilder	可以進一步自訂的欄位實例。

原始碼

                public function binary($length = null)
{
    return $this->getDb()->getSchema()->createColumnSchemaBuilder(Schema::TYPE_BINARY, $length);
}

建立一個 boolean 欄位。

public
回傳	yii\db\ColumnSchemaBuilder	可以進一步自訂的欄位實例。

原始碼

                public function boolean()
{
    return $this->getDb()->getSchema()->createColumnSchemaBuilder(Schema::TYPE_BOOLEAN);
}

建立一個 char 欄位。

public
$length	integer\|null	欄位尺寸定義，即最大字串長度。如果 DBMS 不支援此參數，則會忽略此參數。
回傳	yii\db\ColumnSchemaBuilder	可以進一步自訂的欄位實例。

原始碼

                public function char($length = null)
{
    return $this->getDb()->getSchema()->createColumnSchemaBuilder(Schema::TYPE_CHAR, $length);
}

建立一個 date 欄位。

public
回傳	yii\db\ColumnSchemaBuilder	可以進一步自訂的欄位實例。

原始碼

                public function date()
{
    return $this->getDb()->getSchema()->createColumnSchemaBuilder(Schema::TYPE_DATE);
}

建立一個 datetime 欄位。

public
$precision	integer\|null	欄位值精確度。傳遞給欄位類型的第一個參數，例如 DATETIME(precision)。如果 DBMS 不支援此參數，則會忽略此參數。
回傳	yii\db\ColumnSchemaBuilder	可以進一步自訂的欄位實例。

原始碼

                public function dateTime($precision = null)
{
    return $this->getDb()->getSchema()->createColumnSchemaBuilder(Schema::TYPE_DATETIME, $precision);
}

建立一個 decimal 欄位。

public
$precision	integer\|null	欄位值精確度，通常是總位數。傳遞給欄位類型的第一個參數，例如 DECIMAL(precision, scale)。如果 DBMS 不支援此參數，則會忽略此參數。
$scale	integer\|null	欄位值小數位數，通常是小數點後的位數。傳遞給欄位類型的第二個參數，例如 DECIMAL(precision, scale)。如果 DBMS 不支援此參數，則會忽略此參數。
回傳	yii\db\ColumnSchemaBuilder	可以進一步自訂的欄位實例。

原始碼

                public function decimal($precision = null, $scale = null)
{
    $length = [];
    if ($precision !== null) {
        $length[] = $precision;
    }
    if ($scale !== null) {
        $length[] = $scale;
    }
    return $this->getDb()->getSchema()->createColumnSchemaBuilder(Schema::TYPE_DECIMAL, $length);
}

建立一個 double 欄位。

public
$precision	integer\|null	欄位值精確度。傳遞給欄位類型的第一個參數，例如 DOUBLE(precision)。如果 DBMS 不支援此參數，則會忽略此參數。
回傳	yii\db\ColumnSchemaBuilder	可以進一步自訂的欄位實例。

原始碼

                public function double($precision = null)
{
    return $this->getDb()->getSchema()->createColumnSchemaBuilder(Schema::TYPE_DOUBLE, $precision);
}

建立一個 float 欄位。

public
$precision	integer\|null	欄位值精確度。傳遞給欄位類型的第一個參數，例如 FLOAT(precision)。如果 DBMS 不支援此參數，則會忽略此參數。
回傳	yii\db\ColumnSchemaBuilder	可以進一步自訂的欄位實例。

原始碼

                public function float($precision = null)
{
    return $this->getDb()->getSchema()->createColumnSchemaBuilder(Schema::TYPE_FLOAT, $precision);
}

protected abstract
回傳	yii\db\Connection	用於架構建立的資料庫連線。

原始碼

                abstract protected function getDb();

建立一個 integer 欄位。

public
$length	integer\|null	欄位大小或精確度定義。如果 DBMS 不支援此參數，將會被忽略。
回傳	yii\db\ColumnSchemaBuilder	可以進一步自訂的欄位實例。

原始碼

                public function integer($length = null)
{
    return $this->getDb()->getSchema()->createColumnSchemaBuilder(Schema::TYPE_INTEGER, $length);
}

建立一個 JSON 欄位。

public
回傳	yii\db\ColumnSchemaBuilder	可以進一步自訂的欄位實例。
throws	yii\base\Exception

原始碼

                public function json()
{
    /*
     * TODO Remove in Yii 2.1
     *
     * Disabled due to bug in MySQL extension
     * @link https://bugs.php.net/bug.php?id=70384
     */
    if (version_compare(PHP_VERSION, '5.6', '<') && $this->getDb()->getDriverName() === 'mysql') {
        throw new \yii\base\Exception('JSON column type is not supported in PHP < 5.6');
    }
    return $this->getDb()->getSchema()->createColumnSchemaBuilder(Schema::TYPE_JSON);
}

建立一個 money 欄位。

public
$precision	integer\|null	欄位值精確度，通常是總位數。傳遞給欄位類型的第一個參數，例如 DECIMAL(precision, scale)。如果 DBMS 不支援此參數，則會忽略此參數。
$scale	integer\|null	欄位值小數位數，通常是小數點後的位數。傳遞給欄位類型的第二個參數，例如 DECIMAL(precision, scale)。如果 DBMS 不支援此參數，則會忽略此參數。
回傳	yii\db\ColumnSchemaBuilder	可以進一步自訂的欄位實例。

原始碼

                public function money($precision = null, $scale = null)
{
    $length = [];
    if ($precision !== null) {
        $length[] = $precision;
    }
    if ($scale !== null) {
        $length[] = $scale;
    }
    return $this->getDb()->getSchema()->createColumnSchemaBuilder(Schema::TYPE_MONEY, $length);
}

建立一個 primary key 欄位。

public
$length	integer\|null	欄位大小或精確度定義。如果 DBMS 不支援此參數，將會被忽略。
回傳	yii\db\ColumnSchemaBuilder	可以進一步自訂的欄位實例。

原始碼

                public function primaryKey($length = null)
{
    return $this->getDb()->getSchema()->createColumnSchemaBuilder(Schema::TYPE_PK, $length);
}

建立一個 smallint 欄位。

public
$length	integer\|null	欄位大小或精確度定義。如果 DBMS 不支援此參數，將會被忽略。
回傳	yii\db\ColumnSchemaBuilder	可以進一步自訂的欄位實例。

原始碼

                public function smallInteger($length = null)
{
    return $this->getDb()->getSchema()->createColumnSchemaBuilder(Schema::TYPE_SMALLINT, $length);
}

建立一個 string 欄位。

public
$length	integer\|null	欄位尺寸定義，即最大字串長度。如果 DBMS 不支援此參數，則會忽略此參數。
回傳	yii\db\ColumnSchemaBuilder	可以進一步自訂的欄位實例。

原始碼

                public function string($length = null)
{
    return $this->getDb()->getSchema()->createColumnSchemaBuilder(Schema::TYPE_STRING, $length);
}

建立一個 text 欄位。

public
回傳	yii\db\ColumnSchemaBuilder	可以進一步自訂的欄位實例。

原始碼

                public function text()
{
    return $this->getDb()->getSchema()->createColumnSchemaBuilder(Schema::TYPE_TEXT);
}

建立一個 time 欄位。

public
$precision	integer\|null	欄位值精確度。傳遞給欄位類型的第一個參數，例如 TIME(precision)。如果 DBMS 不支援此參數，則會忽略此參數。
回傳	yii\db\ColumnSchemaBuilder	可以進一步自訂的欄位實例。

原始碼

                public function time($precision = null)
{
    return $this->getDb()->getSchema()->createColumnSchemaBuilder(Schema::TYPE_TIME, $precision);
}

建立一個 timestamp 欄位。

public
$precision	integer\|null	欄位值精確度。傳遞給欄位類型的第一個參數，例如 TIMESTAMP(precision)。如果 DBMS 不支援此參數，則會忽略此參數。
回傳	yii\db\ColumnSchemaBuilder	可以進一步自訂的欄位實例。

原始碼

                public function timestamp($precision = null)
{
    return $this->getDb()->getSchema()->createColumnSchemaBuilder(Schema::TYPE_TIMESTAMP, $precision);
}

建立一個 tinyint 欄位。如果 DBMS 不支援 tinyint，將會使用 smallint。

public
$length	integer\|null	欄位大小或精確度定義。如果 DBMS 不支援此參數，將會被忽略。
回傳	yii\db\ColumnSchemaBuilder	可以進一步自訂的欄位實例。

原始碼

                public function tinyInteger($length = null)
{
    return $this->getDb()->getSchema()->createColumnSchemaBuilder(Schema::TYPE_TINYINT, $length);
}